Documentation
¶
Index ¶
- Constants
- func LoadTokenFile(tokenPath string) (string, error)
- func ReadinessLayerNames() []string
- type Action
- type Client
- func (c *Client) CallMutationRPC(ctx context.Context, request RPCRequest, identity MutationIdentity) (Projection, error)
- func (c *Client) CallRPC(ctx context.Context, request RPCRequest) (Projection, error)
- func (c *Client) Capabilities(ctx context.Context) (Projection, error)
- func (c *Client) Manifest(ctx context.Context) (Manifest, error)
- func (c *Client) Operation(ctx context.Context, operationID string) (Operation, error)
- func (c *Client) Ping(ctx context.Context) (Projection, error)
- func (c *Client) ReaderAsset(ctx context.Context, assetRef, noteID, noteRevision string) (ReaderAssetContent, error)
- func (c *Client) ReaderAssetRange(ctx context.Context, assetRef, noteID, noteRevision string, ...) (ReaderAssetContent, error)
- func (c *Client) ReaderDocument(ctx context.Context, request ReaderDocumentRequest) (ReaderDocumentPage, error)
- func (c *Client) ReaderLinks(ctx context.Context, objectID, revision, direction string, ...) (ReaderLinkPage, error)
- func (c *Client) ReaderNotes(ctx context.Context, query ReaderPageQuery) (ReaderNoteList, error)
- func (c *Client) ReaderSearch(ctx context.Context, queryText string, query ReaderPageQuery) (ReaderSearchResults, error)
- func (c *Client) ReaderSource(ctx context.Context) (ReaderSourceDescriptor, error)
- func (c *Client) ReaderSourceExport(ctx context.Context, objectID, revision string) (ReaderSourceExportDescriptor, []byte, error)
- func (c *Client) ReaderSourceExportRange(ctx context.Context, objectID, revision string, rng ReaderByteRange) (ReaderSourceExportDescriptor, []byte, error)
- func (c *Client) Readiness(ctx context.Context) (ConnectionReadiness, error)
- func (c *Client) ReconcileOperation(ctx context.Context, operationID string) (Operation, error)
- func (c *Client) WriterApply(ctx context.Context, request WriterApplyRequest) (WriterApplyReceipt, error)
- func (c *Client) WriterAwaitApply(ctx context.Context, request WriterApplyRequest, attempts int, ...) (WriterApplyReceipt, error)
- func (c *Client) WriterCapture(ctx context.Context, request WriterCaptureRequest, ...) (WriterCaptureReceipt, error)
- func (c *Client) WriterOrganizeApply(ctx context.Context, request WriterOrganizeApplyRequest) (WriterOrganizeApplyReceipt, error)
- func (c *Client) WriterOrganizePlan(ctx context.Context, noteRefs []string) (WriterOrganizePlan, error)
- func (c *Client) WriterPropose(ctx context.Context, change WriterChange) (WriterProposalPreview, error)
- type CommandError
- type Config
- type ConnectionReadiness
- type Error
- type Manifest
- type ManifestCapability
- type MutationIdentity
- type Operation
- type Projection
- type RPCRequest
- type ReaderAssetContent
- type ReaderAssetRef
- type ReaderByteRange
- type ReaderDocumentNode
- type ReaderDocumentPage
- type ReaderDocumentRequest
- type ReaderDocumentWarning
- type ReaderIndexState
- type ReaderLimits
- type ReaderLinkItem
- type ReaderLinkPage
- type ReaderNoteCard
- type ReaderNoteList
- type ReaderOutlineEntry
- type ReaderPageQuery
- type ReaderSearchResults
- type ReaderSearchSnippet
- type ReaderSourceDescriptor
- type ReaderSourceExportDescriptor
- type Readiness
- type TransportBinding
- type Warning
- type WriterApplyReceipt
- type WriterApplyRequest
- type WriterCaptureReceipt
- type WriterCaptureRequest
- type WriterChange
- type WriterOperationIdentity
- type WriterOrganizeApplyReceipt
- type WriterOrganizeApplyRequest
- type WriterOrganizeOperation
- type WriterOrganizePlan
- type WriterProposalPreview
- type WriterReceiptError
Constants ¶
const ( CodeInvalidConfig = "invalid_config" CodeRequestInvalid = "request_invalid" CodeRequestFailed = "request_failed" CodeRedirectRejected = "redirect_rejected" CodeResponseTooLarge = "response_too_large" CodeTokenFileInvalid = "token_file_invalid" CodeTokenFileTooLarge = "token_file_too_large" CodeTokenFileUnsafe = "token_file_unsafe" CodeTokenFileUnreadable = "token_file_unreadable" CodeUpstreamInvalidResponse = "upstream_invalid_response" CodeMutationOutcomeUnknown = "mutation_outcome_unknown" CodeReconcileRequired = "reconcile_required" )
const ( ReaderSourceSchemaV1Alpha1 = catalogschema.ReaderSourceV1Alpha1 ReaderDocumentSchemaV1Alpha1 = catalogschema.ReaderDocumentV1Alpha1 ReaderNoteListSchemaV1Alpha1 = catalogschema.ReaderNoteListV1Alpha1 ReaderSearchResultsSchemaV1Alpha1 = catalogschema.ReaderSearchResultsV1Alpha1 ReaderLinkPageSchemaV1Alpha1 = catalogschema.ReaderLinkPageV1Alpha1 ReaderAssetRefSchemaV1Alpha1 = catalogschema.ReaderAssetRefV1Alpha1 ReaderSourceExportSchemaV1Alpha1 = catalogschema.ReaderSourceExportV1Alpha1 )
const ( ProjectionSpecVersion = "1.0" TransportManifestSchemaV1 = "pinax.transport_manifest.v1" ConnectionReadinessSchemaV1 = "pinax.connection_readiness.v1" OperationSchemaV1 = "pinax.operation.v1" ReadinessLayerContract = "contract" ReadinessLayerTransport = "transport" ReadinessLayerAuth = "auth" ReadinessLayerOwner = "owner" ReadinessLayerMutationRecovery = "mutation_recovery" ReadinessLayerProduction = "production" )
const ( WriterProposalPreviewSchemaV1Alpha1 = catalogschema.WriterProposalPreviewV1Alpha1 WriterApplyReceiptSchemaV1Alpha1 = catalogschema.WriterApplyReceiptV1Alpha1 WriterCaptureReceiptSchemaV1Alpha1 = catalogschema.WriterCaptureReceiptV1Alpha1 WriterOrganizePlanSchemaV1Alpha1 = catalogschema.WriterOrganizePlanV1Alpha1 WriterOrganizeApplyReceiptSchemaV1Alpha1 = catalogschema.WriterOrganizeApplyReceiptV1Alpha1 )
Variables ¶
This section is empty.
Functions ¶
func LoadTokenFile ¶
LoadTokenFile reads one plaintext bearer token from an owner-only file. The path must be absolute, every path component must be non-symlink, and the platform-specific owner/access policy must pass before any bytes are returned. Errors intentionally omit both the path and file contents.
func ReadinessLayerNames ¶
func ReadinessLayerNames() []string
ReadinessLayerNames returns the required v1 layer names without exposing mutable package state.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func (*Client) CallMutationRPC ¶
func (c *Client) CallMutationRPC(ctx context.Context, request RPCRequest, identity MutationIdentity) (Projection, error)
CallMutationRPC executes one recovery-enabled RPC mutation. Ambiguous transport outcomes are resolved through the durable operation first; the original request is retried at most once and only when the owner reports a terminal failed operation that is both retryable and replay-safe.
func (*Client) CallRPC ¶
func (c *Client) CallRPC(ctx context.Context, request RPCRequest) (Projection, error)
func (*Client) Capabilities ¶
func (c *Client) Capabilities(ctx context.Context) (Projection, error)
Capabilities reads the legacy capabilities projection. The authoritative transport inventory remains Manifest; this method is retained for clients that still consume the additive legacy capability fields.
func (*Client) Ping ¶
func (c *Client) Ping(ctx context.Context) (Projection, error)
Ping reads the owner root projection.
func (*Client) ReaderAsset ¶
func (c *Client) ReaderAsset(ctx context.Context, assetRef, noteID, noteRevision string) (ReaderAssetContent, error)
ReaderAsset reads one bounded asset body bound to a note revision. Use ReaderAssetRange for content above the per-request byte window.
func (*Client) ReaderAssetRange ¶
func (c *Client) ReaderAssetRange(ctx context.Context, assetRef, noteID, noteRevision string, rng ReaderByteRange) (ReaderAssetContent, error)
ReaderAssetRange reads one explicit byte window of an asset (206) or, with an empty range, the whole body when it fits the window budget (200).
func (*Client) ReaderDocument ¶
func (c *Client) ReaderDocument(ctx context.Context, request ReaderDocumentRequest) (ReaderDocumentPage, error)
ReaderDocument reads one bounded document page.
func (*Client) ReaderLinks ¶
func (c *Client) ReaderLinks(ctx context.Context, objectID, revision, direction string, query ReaderPageQuery) (ReaderLinkPage, error)
ReaderLinks lists authorized relation edges for one pinned revision.
func (*Client) ReaderNotes ¶
func (c *Client) ReaderNotes(ctx context.Context, query ReaderPageQuery) (ReaderNoteList, error)
ReaderNotes lists note cards for the authorized session.
func (*Client) ReaderSearch ¶
func (c *Client) ReaderSearch(ctx context.Context, queryText string, query ReaderPageQuery) (ReaderSearchResults, error)
ReaderSearch runs keyword search; the query never leaves this call.
func (*Client) ReaderSource ¶
func (c *Client) ReaderSource(ctx context.Context) (ReaderSourceDescriptor, error)
ReaderSource reads the authorized source descriptor.
func (*Client) ReaderSourceExport ¶
func (c *Client) ReaderSourceExport(ctx context.Context, objectID, revision string) (ReaderSourceExportDescriptor, []byte, error)
ReaderSourceExport downloads the markdown source of a pinned revision. Content above the per-request window must be fetched via ReaderSourceExportRange windows; unknown total sizes can be discovered from the first range reply's Content-Range total.
func (*Client) ReaderSourceExportRange ¶
func (c *Client) ReaderSourceExportRange(ctx context.Context, objectID, revision string, rng ReaderByteRange) (ReaderSourceExportDescriptor, []byte, error)
ReaderSourceExportRange downloads one explicit byte window of the source (206) or, with an empty range, the whole body when it fits (200).
func (*Client) Readiness ¶
func (c *Client) Readiness(ctx context.Context) (ConnectionReadiness, error)
func (*Client) ReconcileOperation ¶
func (*Client) WriterApply ¶
func (c *Client) WriterApply(ctx context.Context, request WriterApplyRequest) (WriterApplyReceipt, error)
WriterApply saves an unchanged preview. The operation identity is the change's operation id: an ambiguous failure is recovered by re-issuing the SAME apply (the ledger replays), never a fresh identity.
func (*Client) WriterAwaitApply ¶
func (c *Client) WriterAwaitApply(ctx context.Context, request WriterApplyRequest, attempts int, interval time.Duration) (WriterApplyReceipt, error)
WriterAwaitApply polls the SAME apply identity until a terminal receipt, the attempt budget is exhausted, or the context is cancelled. Polling never fabricates a fresh identity. A non-terminal receipt (accepted / applying) keeps polling under the SAME identity until it reaches a terminal status, the budget is exhausted, or the context is cancelled.
func (*Client) WriterCapture ¶
func (c *Client) WriterCapture(ctx context.Context, request WriterCaptureRequest, identity WriterOperationIdentity) (WriterCaptureReceipt, error)
WriterCapture captures a note under a durable identity. On an ambiguous transport failure the SAME identity is re-issued once — the operation ledger replays the original receipt instead of writing twice.
func (*Client) WriterOrganizeApply ¶
func (c *Client) WriterOrganizeApply(ctx context.Context, request WriterOrganizeApplyRequest) (WriterOrganizeApplyReceipt, error)
WriterOrganizeApply applies a saved plan id as-is. Organize plans are consumed by apply, so an ambiguous outcome is NOT auto-retried: the receipt/error tells the host to inspect the plan id instead.
func (*Client) WriterOrganizePlan ¶
func (c *Client) WriterOrganizePlan(ctx context.Context, noteRefs []string) (WriterOrganizePlan, error)
WriterOrganizePlan generates a saved organize plan; noteRefs scopes the plan to exactly those objects, empty means the whole vault.
func (*Client) WriterPropose ¶
func (c *Client) WriterPropose(ctx context.Context, change WriterChange) (WriterProposalPreview, error)
WriterPropose prepares an edit proposal without writing.
type CommandError ¶
type ConnectionReadiness ¶
type Error ¶
type Error struct {
Code string `json:"code"`
Message string `json:"message"`
HTTPStatus int `json:"http_status,omitempty"`
Retryable bool `json:"retryable"`
RequiredAction string `json:"required_action,omitempty"`
RequestID string `json:"request_id,omitempty"`
OperationRef string `json:"operation_ref,omitempty"`
ReconcileRequired bool `json:"reconcile_required"`
// Facts and Actions carry the machine-recoverable recovery contract
// (e.g. the fixed revision, source size and source-export action of a
// 413 document budget error) so consumers can follow it programmatically.
Facts map[string]string `json:"facts,omitempty"`
Actions []Action `json:"actions,omitempty"`
// contains filtered or unexported fields
}
type Manifest ¶
type Manifest struct {
SchemaVersion string `json:"schema_version"`
Digest string `json:"digest"`
Capabilities []ManifestCapability `json:"capabilities"`
}
type ManifestCapability ¶
type ManifestCapability struct {
ID string `json:"id"`
Command string `json:"command"`
ReleaseCore bool `json:"release_core"`
Readonly bool `json:"readonly"`
BodyAllowed bool `json:"body_allowed"`
ApprovalRequired bool `json:"approval_required"`
SnapshotRequired bool `json:"snapshot_required"`
UIGroup string `json:"ui_group,omitempty"`
BodyExposureDefault string `json:"body_exposure_default,omitempty"`
WriteGate string `json:"write_gate,omitempty"`
CopyCommand string `json:"copy_command,omitempty"`
LocalOnlyReason string `json:"local_only_reason,omitempty"`
RequestSchema string `json:"request_schema"`
ResponseSchema string `json:"response_schema"`
Errors []string `json:"errors,omitempty"`
Stability string `json:"stability"`
DeclaredSurfaces []string `json:"declared_surfaces,omitempty"`
AvailableSurfaces []string `json:"available_surfaces,omitempty"`
Bindings []TransportBinding `json:"bindings,omitempty"`
}
type MutationIdentity ¶
type MutationIdentity struct {
OperationID string `json:"operation_id"`
IdempotencyKey string `json:"idempotency_key"`
}
func NewMutationIdentity ¶
func NewMutationIdentity() (MutationIdentity, error)
NewMutationIdentity creates the stable pair a client must retain across retries of one logical mutation. The owner binds both values to the request digest and authenticated owner scope.
type Operation ¶
type Operation struct {
SchemaVersion string `json:"schema_version"`
OperationID string `json:"operation_id"`
CapabilityID string `json:"capability_id"`
BindingID string `json:"binding_id"`
IdempotencyKey string `json:"idempotency_key,omitempty"`
RequestDigest string `json:"request_digest,omitempty"`
Status string `json:"status"`
Retryable bool `json:"retryable"`
ReplaySafe bool `json:"replay_safe"`
ReconcileRequired bool `json:"reconcile_required"`
RequiredAction string `json:"required_action,omitempty"`
Result json.RawMessage `json:"result,omitempty"`
Receipt json.RawMessage `json:"receipt,omitempty"`
ReceiptRef string `json:"receipt_ref,omitempty"`
ResourceRef string `json:"resource_ref,omitempty"`
RevisionBefore string `json:"revision_before,omitempty"`
RevisionAfter string `json:"revision_after,omitempty"`
Error *CommandError `json:"error,omitempty"`
CreatedAt string `json:"created_at"`
UpdatedAt string `json:"updated_at"`
AcceptedAt string `json:"accepted_at"`
ApplyingAt string `json:"applying_at,omitempty"`
CompletedAt string `json:"completed_at,omitempty"`
}
type Projection ¶
type Projection struct {
SpecVersion string `json:"spec_version"`
Mode string `json:"mode,omitempty"`
Command string `json:"command"`
Status string `json:"status"`
Summary string `json:"summary,omitempty"`
Facts map[string]string `json:"facts,omitempty"`
Actions []Action `json:"actions,omitempty"`
Evidence []string `json:"evidence,omitempty"`
Data json.RawMessage `json:"data,omitempty"`
Warnings []Warning `json:"warnings,omitempty"`
Error *CommandError `json:"error,omitempty"`
}
type RPCRequest ¶
type ReaderAssetContent ¶
type ReaderAssetContent struct {
Descriptor ReaderAssetRef
Body []byte
ContentRange string
}
ReaderAssetContent is the resolved asset bytes plus its descriptor. For ranged reads ContentRange carries the server's bytes a-b/total reply.
type ReaderAssetRef ¶
type ReaderByteRange ¶
ReaderByteRange selects one inclusive byte window for ranged reads. The zero value (Set=false) means "no Range header": the whole body is requested and must fit the per-request window. Set=true sends the explicit window as-is — including the legal one-byte window {0, 0} (bytes=0-0) — and an out-of-order or negative window fails the call safely instead of silently degrading to a full-body download.
type ReaderDocumentNode ¶
type ReaderDocumentNode struct {
Type string `json:"type"`
Anchor string `json:"anchor"`
Text string `json:"text,omitempty"`
Children []ReaderDocumentNode `json:"children,omitempty"`
Ref string `json:"ref,omitempty"`
Language string `json:"language,omitempty"`
Alt string `json:"alt,omitempty"`
BlockAnchor string `json:"block_anchor,omitempty"`
FragmentIndex int `json:"fragment_index,omitempty"`
LastFragment bool `json:"last_fragment,omitempty"`
OriginalType string `json:"original_type,omitempty"`
Header []string `json:"header,omitempty"`
// Fence semantics (owner-registered read-only handlers): the fence
// name, its bounded payload, and explicit failure diagnostics.
Fence string `json:"fence,omitempty"`
Payload json.RawMessage `json:"payload,omitempty"`
ErrorCode string `json:"error_code,omitempty"`
NextAction string `json:"next_action,omitempty"`
}
type ReaderDocumentPage ¶
type ReaderDocumentPage struct {
SchemaVersion string `json:"schema_version"`
ObjectID string `json:"object_id"`
Revision string `json:"revision"`
CurrentRevision string `json:"current_revision"`
URI string `json:"uri"`
Nodes []ReaderDocumentNode `json:"nodes"`
Outline []ReaderOutlineEntry `json:"outline"`
OutlineCursor string `json:"outline_cursor,omitempty"`
NextCursor string `json:"next_cursor,omitempty"`
Complete bool `json:"complete"`
ContentBytes int `json:"content_bytes"`
ObservedAt string `json:"observed_at"`
Warnings []ReaderDocumentWarning `json:"warnings,omitempty"`
}
type ReaderDocumentRequest ¶
type ReaderDocumentRequest struct {
ObjectID string
Revision string
Cursor string
Anchor string
OutlineCursor string
}
ReaderDocumentRequest selects one page of the human reading projection.
type ReaderDocumentWarning ¶
type ReaderIndexState ¶
type ReaderLimits ¶
type ReaderLimits struct {
ListDefaultLimit int `json:"list_default_limit"`
ListMaxLimit int `json:"list_max_limit"`
SnippetMaxChars int `json:"snippet_max_chars"`
OutlinePageMaxEntries int `json:"outline_page_max_entries"`
DocumentPageMaxTextBytes int `json:"document_page_max_text_bytes"`
DocumentPageMaxNodes int `json:"document_page_max_nodes"`
DocumentResponseMaxBytes int `json:"document_response_max_bytes"`
DocumentSourceMaxBytes int `json:"document_source_max_bytes"`
DocumentTotalMaxNodes int `json:"document_total_max_nodes"`
AssetRangeMaxBytes int `json:"asset_range_max_bytes"`
SourceExportRangeMaxBytes int `json:"source_export_range_max_bytes"`
}
ReaderLimits mirrors the frozen budget block of the source descriptor.
type ReaderLinkItem ¶
type ReaderLinkPage ¶
type ReaderLinkPage struct {
ObjectID string `json:"object_id"`
Revision string `json:"revision"`
Direction string `json:"direction"`
Items []ReaderLinkItem `json:"items"`
NextCursor string `json:"next_cursor,omitempty"`
RelationsWatermark string `json:"relations_watermark"`
ObservedAt string `json:"observed_at"`
}
type ReaderNoteCard ¶
type ReaderNoteCard struct {
ObjectID string `json:"object_id"`
Title string `json:"title"`
TitleState string `json:"title_state,omitempty"`
Revision string `json:"revision"`
URI string `json:"uri"`
Status string `json:"status"`
ProjectID *string `json:"project_id"`
Tags []string `json:"tags"`
UpdatedAt string `json:"updated_at"`
}
type ReaderNoteList ¶
type ReaderNoteList struct {
Items []ReaderNoteCard `json:"items"`
NextCursor string `json:"next_cursor,omitempty"`
ObservedAt string `json:"observed_at"`
IndexWatermark string `json:"index_watermark"`
IndexState ReaderIndexState `json:"index_state"`
}
type ReaderOutlineEntry ¶
type ReaderPageQuery ¶
type ReaderPageQuery struct {
ProjectID string
Tags []string
Status string
Sort string
Limit int
Cursor string
}
ReaderPageQuery carries shared pagination controls for typed calls.
type ReaderSearchResults ¶
type ReaderSearchResults struct {
Items []ReaderNoteCard `json:"items"`
Snippets []ReaderSearchSnippet `json:"snippets"`
NextCursor string `json:"next_cursor,omitempty"`
ObservedAt string `json:"observed_at"`
IndexWatermark string `json:"index_watermark"`
IndexState ReaderIndexState `json:"index_state"`
}
type ReaderSearchSnippet ¶
type ReaderSourceDescriptor ¶
type ReaderSourceDescriptor struct {
SchemaVersion string `json:"schema_version"`
SessionID string `json:"session_id"`
BindingID string `json:"binding_id"`
DisplayName string `json:"display_name"`
Capabilities []string `json:"capabilities"`
Limits ReaderLimits `json:"limits"`
IndexState ReaderIndexState `json:"index_state"`
ObservedAt string `json:"observed_at"`
}
type Readiness ¶
type Readiness struct {
Status string `json:"status"`
Maturity string `json:"maturity"`
Blockers []string `json:"blockers,omitempty"`
NextActions []string `json:"next_actions,omitempty"`
EvidenceRefs []string `json:"evidence_refs,omitempty"`
}
func (Readiness) IsReady ¶
IsReady returns true only for the stable ready status. Unknown future status values remain available in Status but are deliberately treated as non-ready.
func (Readiness) StatusKnown ¶
type TransportBinding ¶
type TransportBinding struct {
ID string `json:"id"`
CapabilityID string `json:"capability_id"`
Transport string `json:"transport"`
Availability string `json:"availability"`
BackingRef string `json:"backing_ref,omitempty"`
Method string `json:"method,omitempty"`
Path string `json:"path,omitempty"`
ProtocolName string `json:"protocol_name,omitempty"`
Readonly bool `json:"readonly"`
WriteGate string `json:"write_gate,omitempty"`
RequestSchema string `json:"request_schema"`
ResponseSchema string `json:"response_schema"`
Blockers []string `json:"blockers,omitempty"`
Readiness *Readiness `json:"readiness,omitempty"`
}
type WriterApplyReceipt ¶
type WriterApplyReceipt struct {
SchemaVersion string `json:"schema_version"`
OperationID string `json:"operation_id"`
CapabilityID string `json:"capability_id"`
BindingID string `json:"binding_id"`
RequestDigest string `json:"request_digest,omitempty"`
Status string `json:"status"`
Retryable bool `json:"retryable"`
ReplaySafe bool `json:"replay_safe"`
ReconcileRequired bool `json:"reconcile_required"`
RequiredAction string `json:"required_action,omitempty"`
Result json.RawMessage `json:"result,omitempty"`
Receipt json.RawMessage `json:"receipt,omitempty"`
ReceiptRef string `json:"receipt_ref,omitempty"`
ResourceRef string `json:"resource_ref,omitempty"`
RevisionBefore string `json:"revision_before,omitempty"`
RevisionAfter string `json:"revision_after,omitempty"`
Error *WriterReceiptError `json:"error,omitempty"`
CreatedAt string `json:"created_at"`
UpdatedAt string `json:"updated_at"`
AcceptedAt string `json:"accepted_at"`
ApplyingAt string `json:"applying_at,omitempty"`
CompletedAt string `json:"completed_at,omitempty"`
}
WriterApplyReceipt is the frozen apply receipt (operation view shape).
func (WriterApplyReceipt) Terminal ¶
func (r WriterApplyReceipt) Terminal() bool
Terminal reports whether the receipt reached a terminal status.
type WriterApplyRequest ¶
type WriterApplyRequest struct {
Change WriterChange
PreviewDigest string
Authorization string
}
WriterApplyRequest is the apply payload: the resolved change, its unchanged preview digest, and the caller-asserted authorization.
type WriterCaptureReceipt ¶
type WriterCaptureReceipt struct {
SchemaVersion string `json:"schema_version"`
OperationID string `json:"operation_id"`
CapabilityID string `json:"capability_id"`
BindingID string `json:"binding_id"`
Status string `json:"status"`
Retryable bool `json:"retryable"`
ReplaySafe bool `json:"replay_safe"`
ReconcileRequired bool `json:"reconcile_required"`
NoteID string `json:"note_id,omitempty"`
Path string `json:"path,omitempty"`
RecordEventID string `json:"record_event_id,omitempty"`
RevisionAfter string `json:"revision_after,omitempty"`
ResourceRef string `json:"resource_ref,omitempty"`
Error *WriterReceiptError `json:"error,omitempty"`
CreatedAt string `json:"created_at"`
UpdatedAt string `json:"updated_at"`
AcceptedAt string `json:"accepted_at"`
}
WriterCaptureReceipt is the frozen capture receipt.
type WriterCaptureRequest ¶
WriterCaptureRequest is the bounded capture payload.
type WriterChange ¶
type WriterChange struct {
OperationID string `json:"operation_id,omitempty"`
Action string `json:"action"`
NoteRef string `json:"note_ref,omitempty"`
ExpectedRevision string `json:"expected_revision,omitempty"`
Title string `json:"title,omitempty"`
Body string `json:"body,omitempty"`
Dir string `json:"dir,omitempty"`
TargetPath string `json:"target_path,omitempty"`
Tags []string `json:"tags,omitempty"`
TagOperation string `json:"tag_operation,omitempty"`
Status string `json:"status,omitempty"`
}
WriterChange mirrors the frozen writer change object exactly.
type WriterOperationIdentity ¶
WriterOperationIdentity is the durable capture identity: re-issuing the same identity replays the original receipt instead of writing twice.
func NewWriterOperationIdentity ¶
func NewWriterOperationIdentity(operationID, idempotencyKey string) (WriterOperationIdentity, error)
NewWriterOperationIdentity validates the identity shape before any HTTP traffic: an invalid identity fails locally, never half-way through a write.
type WriterOrganizeApplyReceipt ¶
type WriterOrganizeApplyReceipt struct {
SchemaVersion string `json:"schema_version"`
OperationID string `json:"operation_id"`
PlanID string `json:"plan_id"`
CapabilityID string `json:"capability_id"`
BindingID string `json:"binding_id"`
Status string `json:"status"`
Retryable bool `json:"retryable"`
ReplaySafe bool `json:"replay_safe"`
ReconcileRequired bool `json:"reconcile_required"`
SnapshotID string `json:"snapshot_id,omitempty"`
CreatedAt string `json:"created_at"`
UpdatedAt string `json:"updated_at"`
AcceptedAt string `json:"accepted_at"`
}
WriterOrganizeApplyReceipt is the frozen organize apply receipt; the plan id doubles as the recovery identity.
type WriterOrganizeApplyRequest ¶
WriterOrganizeApplyRequest applies a saved plan id as-is.
type WriterOrganizeOperation ¶
type WriterOrganizeOperation struct {
OperationID string `json:"operation_id"`
ObjectID string `json:"object_id,omitempty"`
Kind string `json:"kind"`
Mode string `json:"mode"`
Risk string `json:"risk"`
Path string `json:"path,omitempty"`
}
WriterOrganizeOperation is one planned organize operation.
type WriterOrganizePlan ¶
type WriterOrganizePlan struct {
SchemaVersion string `json:"schema_version"`
PlanID string `json:"plan_id"`
Status string `json:"status"`
CreatedAt string `json:"created_at"`
ExpiresAt string `json:"expires_at"`
OperationCount int `json:"operation_count"`
Operations []WriterOrganizeOperation `json:"operations"`
}
WriterOrganizePlan is the frozen saved-plan summary.
type WriterProposalPreview ¶
type WriterProposalPreview struct {
SchemaVersion string `json:"schema_version"`
Change WriterChange `json:"change"`
PreviewDigest string `json:"preview_digest"`
Path string `json:"path"`
Before string `json:"before"`
After string `json:"after"`
State string `json:"state"`
}
WriterProposalPreview is the exact before/after preview plus the digest apply must echo unchanged.
type WriterReceiptError ¶
type WriterReceiptError struct {
Code string `json:"code"`
Message string `json:"message"`
Hint string `json:"hint,omitempty"`
}
WriterReceiptError mirrors the bounded receipt error block.