Expand description
The v0 HTTP protocol shapes.
Every request/response body served by the v0 HTTP API lives under this
module, re-exported flat so loonfs_api::v0::X is the canonical path for
any v0 shape. The submodules group the surface by plane:
operations— namespace lifecycle, path-oriented filesystem operations, file revisions, maintenance, and theApiErrorbody.reads— authoritative read results (stat/list entries, file bytes).commits— commit results and the change feed.search— content search and grep-index administration.uploads— upload sessions and direct-put access.downloads— direct-get download grants.
The crate root re-exports the common surface for convenience; see the crate docs for the rule.
Structs§
- Abort
Upload Response - Response after aborting an upload session.
- Advance
Retention Response - Result of advancing the retention floor.
- ApiError
- HTTP error body used by LoonFS APIs.
- Authoritative
File Bytes - File bytes plus the metadata entry they came from.
- Authoritative
Path Entry - Authoritative metadata for one visible path.
- Begin
Download Request - What a client names when it asks to read a file directly.
- Begin
Download Response - A short-lived capability to read one file’s content object, plus everything the reader needs to check what arrives.
- Begin
Upload Response - Response for starting an upload session.
- Changes
Response - Change-feed response after a cursor.
- Checkpoint
Summary - One active checkpoint record, reported from what the record carries.
- Commit
Request - One commit: an idempotency key, an optional annotation, and an ordered list of path operations that commit together (API spec, section 5.1).
- Commit
Response - Result of one commit.
- Committed
Change - One committed change in namespace order.
- Complete
Upload Response - Response after an upload session is completed.
- Completed
Upload Part - One uploaded part, as the client observed the provider accept it.
- Create
Checkpoint Request - Request to create a durable checkpoint pin.
- Create
Checkpoint Response - Result of creating a checkpoint.
- Create
Namespace Request - Request to create a namespace.
- Delete
Namespace Response - Result of deleting a namespace.
- Direct
Multipart Content Claim - What a
direct_multipartclient says about the object it finished writing, supplied at completion rather than at begin. - Direct
Multipart Upload - Direct multipart upload details: the geometry a client cuts its payload into parts with, and nothing else.
- Direct
Multipart Upload Options - What a
direct_multipartclient asks for when it opens a session. - Direct
PutContent Claim - What a
direct_putclient promises about bytes it has not written yet. - Direct
PutUpload - Presigned direct_put upload details. The raw object key is intentionally not public.
- Disable
Grep Index Response - Result of disabling the grep index on a namespace (admin plane).
- Enable
Grep Index Response - Result of enabling the grep index on a namespace (admin plane).
- Error
Details - Structured, machine-readable context accompanying an
ApiError. - File
Revision - One immutable file revision.
- Flush
WalResponse - Result of one WAL flush: how the metadata root covers the head.
- Fork
Namespace Request - Request to fork a namespace.
- GcRequest
- Optional overrides for one garbage-collection pass. Absent fields use the server’s conservative defaults.
- GcResponse
- Result of one mark-and-sweep garbage-collection pass.
- Grep
GcRequest - One explicit grep-index garbage-collection pass (admin plane).
- Grep
GcResponse - Result of one explicit grep-index garbage-collection pass (admin plane).
- Grep
Index Status Response - The namespace’s grep-index lifecycle and its cheap bookkeeping (admin plane).
- Grep
Match - One line-oriented match.
- Grep
Request - One content-search request.
- Grep
Response - One content-search page.
- List
Checkpoints Response - Every active checkpoint record a namespace currently carries.
- List
File Revisions Response - Response for listing file revisions.
- List
Path Entries Response - One directory listing and the namespace head it was answered at.
- List
Trash Response - One trash listing page: the namespace’s recoverable deletions.
- Maintenance
Step Request - Options for one explicit maintenance step. Absent fields use the
server’s defaults; retention advance runs only when
retentionis true and garbage collection only whengcis present. - Maintenance
Step Response - Result of one explicit maintenance step.
- Namespace
Status Response - Status summary for one namespace.
- Namespace
Summary - Short namespace identifier returned by namespace create/fork operations.
- Release
Checkpoint Response - Result of releasing a checkpoint pin.
- Retained
Candidates - Why a pass kept what it kept:
retained_candidatessplit by the decision that spared each candidate. - Sign
Upload Parts Request - Request for part-upload capabilities on an open multipart session.
- Sign
Upload Parts Response - Response carrying one capability per requested part.
- Signed
Upload Part - One authorized part upload.
- Store
Probe Check Result - One named contract check and what the store did with it.
- Store
Probe Request - Options for one store contract probe. Empty today; a body is still sent so later options do not change the shape of the request.
- Store
Probe Response - What one store contract probe observed, check by check.
- Trash
Entry - One recoverable deletion: an active subtree tombstone plus the identity
of the binding it deleted, when the delete recorded one. Entries with no
recorded name predate the enriched tombstone rows; their inode and
sequence still form a complete
undeletehandle. - Upload
Content Response - Response after uploading bytes into a session.
- Upload
Part Checksum Claim - One part’s checksum, supplied by the client so the server can sign it into that part’s upload URL.
- Upload
Status Response - Response for reading one upload session.
- Validated
Content Token - Stateless proof that a LoonFS server already validated a content ref.
Enums§
- Begin
Upload Request - Request for starting an upload session, tagged by the transport it asks for.
- Checkpoint
Owner Summary - Who a checkpoint record answers to, as the record durably records it.
- Complete
Upload Request - Request to complete an upload, tagged by which of its two shapes it is.
- Delete
Directory Behavior - Directory delete behavior for path-oriented deletes.
- Destination
Behavior - Destination-conflict behavior for path-oriented puts, moves, and copies.
- Filesystem
Change - One semantic filesystem change inside a commit.
- Filesystem
Operation - One path-oriented filesystem operation.
- Flush
WalOutcome - How one WAL flush satisfied its goal.
- Grep
Index Lifecycle - Where a namespace’s grep index is in its lifecycle.
- Maintenance
Step Kind - One sub-step of a maintenance step, for callers that want to run exactly one of them.
- Object
Transfer Access - Client-facing direct transfer capability.
- Reorganize
Step Outcome - What the metadata-reorganization part of a maintenance step did.
- Retained
Reason - The reason one candidate was retained, as the sweep site knows it. Each
variant is the field of
RetainedCandidatesit counts into, where the reason itself is described. - Store
Probe Check Outcome - What one contract check concluded about the store.
- Upload
Mode - Upload transport mode.
- Upload
Session Status - Observed state of an upload session.
- WalFlush
Step Outcome - What the WAL-flush part of a maintenance step did.