Module v0 

Request and response shapes for the v0 HTTP API.

Structs

AdvanceRetentionRequest

An option-free request that selects retention-floor advancement.

AdvanceRetentionResponse

Result of advancing the retention floor.

ApiError

HTTP error body used by LoonFS APIs.

AttributesProjection

The optional attributes returned for one inode.

Checkpoint

One checkpoint resource described by its durable record.

Commit

One committed logical commit: its identity and the events it applied.

CommitRequest

A request to commit one or more filesystem operations atomically in order.

CompleteMultipartUploadRequest

Information required to complete a direct_multipart upload.

CompletedUploadPart

One uploaded part accepted by the object-store provider.

ContentToken

Proof that a specific content_ref may be used in a later commit.

CreateCheckpointRequest

Request to create a durable checkpoint pin.

CreateDownloadByInodeResponse

A short-lived capability to read one inode revision.

CreateDownloadRequest

The path to download and, optionally, the revision to download.

CreateDownloadResponse

A presigned URL for one content object.

CreateNamespaceRequest

Request to create a namespace.

CreateSnapshotRequest

Request to create a snapshot.

DeleteCheckpointResponse

Identifies the checkpoint record that was deleted.

DeleteNamespaceResponse

Result of deleting a namespace.

DeleteSnapshotResponse

Identifies the snapshot record that was deleted.

DeletedCheckpointsByOwner

Checkpoint record counts deleted by one garbage-collection pass, grouped by owner.

DeletedObjectCounts

Object counts deleted by one garbage-collection pass, grouped by family.

DestinationPrecondition

Requirements for replacing a move or copy destination.

DirectoryBinding

A directory entry’s parent and name.

ErrorDetails

Optional machine-readable identifiers and state for an ApiError.

ExpectedFileState

Validated file state required before replacement.

ExtendSnapshotRequest

Request to extend a read snapshot.

FileBytes

File bytes plus the metadata entry they came from.

FileRevision

One immutable file revision.

FlushWalResponse

The current manifest state after one WAL flush.

ForkNamespaceRequest

Request to fork a namespace.

GcRequest

Optional overrides for one garbage-collection pass.

GcResponse

The result of one stateless garbage-collection call.

GrepGcRequest

One explicit grep index garbage-collection pass (maintenance API group).

GrepGcResponse

Result of one explicit grep index garbage-collection pass (maintenance API group).

GrepIndex

The maintenance status of a namespace’s grep index.

GrepMatch

One line-oriented match.

GrepRequest

One content-search request.

GrepResponse

One content-search page.

ListChangesResponse

Change-feed response after a cursor.

ListCheckpointsResponse

One page of active checkpoint records.

ListFileRevisionsResponse

Response for listing file revisions.

ListInodeChildrenResponse

One directory listing addressed by parent inode and the namespace head used to read it.

ListPathEntriesResponse

One directory listing and the namespace head used to read it.

ListSnapshotsResponse

One page of live read snapshots.

ListTrashResponse

One trash listing page: the namespace’s recoverable deletions.

MetadataCompactionRequest

An option-free request that selects one full metadata compaction.

MetadataCompactionResponse

What one metadata compaction run did.

MetadataMaintenanceRequest

Overrides for the metadata-upkeep action.

MetadataMaintenanceResponse

What one metadata-upkeep action did, part by part.

Namespace

Current state for one namespace.

NamespaceDiagnostics

Namespace state and storage details used by maintenance.

NamespaceForkBasis

The source a forked namespace started from.

PathEntry

Metadata for one path returned by stat and directory listings.

RecoverAdministratorRequest

Grants admin on the root row to one principal, keeping every other root grant, through a commit that checks no subject.

RecoverAdministratorResponse

The committed administrator recovery.

RetainedCandidates

The candidates inspected but not deleted by one garbage-collection pass.

SignUploadPartsRequest

Request for part-upload capabilities on an open multipart session.

SignUploadPartsResponse

Response carrying one capability per requested part.

SignedUploadPart

One authorized part upload.

SnapshotSummary

A live snapshot.

StoreProbeCheckResult

One named contract check and what the store did with it.

StoreProbeRequest

An empty request for one store contract probe.

StoreProbeResponse

The ordered results from one store contract probe.

TrashEntry

One recoverable deletion and its removed directory binding.

UploadContentClaim

The size and checksum reported for a complete direct-upload payload.

UploadPartChecksumClaim

One upload part number and its checksum.

UploadSession

Current view of one upload session.

Enums

CheckpointOwnerSummary

The owner of a checkpoint record.

CommitPrecondition

Admission conditions checked against the candidate’s pre-state before its operations. The pre-state head sequence is the last admitted commit’s sequence in the batch, or the batch’s base head sequence when no earlier candidate was admitted.

CompleteUploadBody

Completes an upload using the mode that started it.

CreateUploadBody

Selects the transport for a new upload session.

DeleteDirectoryBehavior

Directory delete behavior for path-oriented deletes.

DestinationBehavior

Destination-conflict behavior for path-oriented puts, moves, and copies.

DestinationPreconditionError

Why a destination precondition is not a valid request.

FilesystemChange

One filesystem change within a commit.

FilesystemOperation

One filesystem operation.

FlushWalOutcome

How one WAL flush satisfied its goal.

GrepIndexLifecycle

The grep index lifecycle for a namespace.

MetadataCompactionOutcome

The outcome of one metadata compaction run.

NamespaceAccessMode

A namespace’s access mode as reported, without its genesis grants.

ObjectTransferAccess

Client-facing direct transfer capability.

PathEntryKind

Kind-specific metadata for a path entry.

PreconditionFields

Field-name family used when validating replacement preconditions.

ReorganizeStepOutcome

The outcome of the metadata-reorganization part of a maintenance pass.

RetainedReason

The reason one candidate was retained and the corresponding RetainedCandidates field.

RunMaintenanceRequest

One maintenance job for one namespace.

RunMaintenanceResponse

The result of one maintenance job. The kind matches the request.

StoreProbeCheckOutcome

What one contract check concluded about the store.

UploadMode

Upload transport mode.

UploadSessionStatus

The current state of an upload session.

WalFlushStepOutcome

What the WAL-flush part of a maintenance pass did.

Functions

validate_access_precondition

Rejects an access revision precondition without an inode precondition.

validate_attributes_precondition

Rejects an attribute revision precondition without an inode precondition.