openapi

package
v1.13.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 4, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

Package openapi provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.8.0 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetSpec

func GetSpec() (swagger *openapi3.T, err error)

GetSpec returns the OpenAPI specification corresponding to the generated code in this file. External references in the spec are resolved through PathToRawSpec; externally-referenced files must be embedded in their corresponding Go packages (via the import-mapping feature). URL-based external refs are not supported.

func GetSpecJSON

func GetSpecJSON() ([]byte, error)

GetSpecJSON returns the raw JSON bytes of the embedded OpenAPI specification: decompressed but not unmarshaled. External references are not resolved here; the bytes are the spec exactly as embedded by codegen. The result is cached at package init time, so repeated calls are cheap.

func GetSwagger deprecated

func GetSwagger() (*openapi3.T, error)

GetSwagger returns the OpenAPI specification corresponding to the generated code in this file.

Deprecated: GetSwagger predates kin-openapi renaming openapi3.Swagger to openapi3.T. Use GetSpec instead. This wrapper is retained for backwards compatibility.

func Handler

func Handler(si ServerInterface) http.Handler

Handler creates http.Handler with routing matching OpenAPI spec.

func HandlerFromMux

func HandlerFromMux(si ServerInterface, m ServeMux) http.Handler

HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.

func HandlerFromMuxWithBaseURL

func HandlerFromMuxWithBaseURL(si ServerInterface, m ServeMux, baseURL string) http.Handler

func HandlerWithOptions

func HandlerWithOptions(si ServerInterface, options StdHTTPServerOptions) http.Handler

HandlerWithOptions creates http.Handler with additional options

func PathToRawSpec

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

Types

type BadRequest

type BadRequest = Error

BadRequest defines model for BadRequest.

type BadRequestJSONResponse

type BadRequestJSONResponse Error

type BranchHead

type BranchHead struct {
	// Head The content-addressed head claim id.
	Head string `json:"head"`
}

BranchHead defines model for BranchHead.

type BranchName

type BranchName = string

BranchName defines model for BranchName.

type CancelVerification200JSONResponse

type CancelVerification200JSONResponse VerificationReport

func (CancelVerification200JSONResponse) VisitCancelVerificationResponse

func (response CancelVerification200JSONResponse) VisitCancelVerificationResponse(w http.ResponseWriter) error

type CancelVerification401JSONResponse

type CancelVerification401JSONResponse struct{ UnauthorizedJSONResponse }

func (CancelVerification401JSONResponse) VisitCancelVerificationResponse

func (response CancelVerification401JSONResponse) VisitCancelVerificationResponse(w http.ResponseWriter) error

type CancelVerification403JSONResponse

type CancelVerification403JSONResponse struct{ ForbiddenJSONResponse }

func (CancelVerification403JSONResponse) VisitCancelVerificationResponse

func (response CancelVerification403JSONResponse) VisitCancelVerificationResponse(w http.ResponseWriter) error

type CancelVerification404JSONResponse

type CancelVerification404JSONResponse struct{ NotFoundJSONResponse }

func (CancelVerification404JSONResponse) VisitCancelVerificationResponse

func (response CancelVerification404JSONResponse) VisitCancelVerificationResponse(w http.ResponseWriter) error

type CancelVerificationRequestObject

type CancelVerificationRequestObject struct {
	ReportId string `json:"reportId"`
}

type CancelVerificationResponseObject

type CancelVerificationResponseObject interface {
	VisitCancelVerificationResponse(w http.ResponseWriter) error
}

type ClaimId

type ClaimId = string

ClaimId defines model for ClaimId.

type Comparison

type Comparison struct {
	Eq   interface{}    `json:"eq,omitempty"`
	Ge   interface{}    `json:"ge,omitempty"`
	Glob *string        `json:"glob,omitempty"`
	Gt   interface{}    `json:"gt,omitempty"`
	In   *[]interface{} `json:"in,omitempty"`
	Le   interface{}    `json:"le,omitempty"`
	Lt   interface{}    `json:"lt,omitempty"`
	Ne   interface{}    `json:"ne,omitempty"`
}

Comparison A test on one field. Exactly one operator is expected. `in` takes a set; `glob` a shell-style wildcard; the rest a scalar.

type Conflict

type Conflict = Error

Conflict defines model for Conflict.

type ConflictJSONResponse

type ConflictJSONResponse Error

type Contribute201JSONResponse

type Contribute201JSONResponse ContributionResult

func (Contribute201JSONResponse) VisitContributeResponse

func (response Contribute201JSONResponse) VisitContributeResponse(w http.ResponseWriter) error

type Contribute400JSONResponse

type Contribute400JSONResponse struct{ BadRequestJSONResponse }

func (Contribute400JSONResponse) VisitContributeResponse

func (response Contribute400JSONResponse) VisitContributeResponse(w http.ResponseWriter) error

type Contribute401JSONResponse

type Contribute401JSONResponse struct{ UnauthorizedJSONResponse }

func (Contribute401JSONResponse) VisitContributeResponse

func (response Contribute401JSONResponse) VisitContributeResponse(w http.ResponseWriter) error

type Contribute403JSONResponse

type Contribute403JSONResponse struct{ ForbiddenJSONResponse }

func (Contribute403JSONResponse) VisitContributeResponse

func (response Contribute403JSONResponse) VisitContributeResponse(w http.ResponseWriter) error

type Contribute404JSONResponse

type Contribute404JSONResponse struct{ NotFoundJSONResponse }

func (Contribute404JSONResponse) VisitContributeResponse

func (response Contribute404JSONResponse) VisitContributeResponse(w http.ResponseWriter) error

type Contribute409JSONResponse

type Contribute409JSONResponse struct{ ConflictJSONResponse }

func (Contribute409JSONResponse) VisitContributeResponse

func (response Contribute409JSONResponse) VisitContributeResponse(w http.ResponseWriter) error

type ContributeRequestObject

type ContributeRequestObject struct {
	Body io.Reader
}

type ContributeResponseObject

type ContributeResponseObject interface {
	VisitContributeResponse(w http.ResponseWriter) error
}

type ContributionResult

type ContributionResult struct {
	// Head The new branch-table head id after the merge.
	Head string `json:"head"`

	// Ids Content-addressed ids of the contributed claims, in order.
	Ids []string `json:"ids"`
}

ContributionResult The outcome of a contribution — the new branch-table head and the appended claim ids.

type DeleteVerification204Response

type DeleteVerification204Response struct {
}

func (DeleteVerification204Response) VisitDeleteVerificationResponse

func (response DeleteVerification204Response) VisitDeleteVerificationResponse(w http.ResponseWriter) error

type DeleteVerification401JSONResponse

type DeleteVerification401JSONResponse struct{ UnauthorizedJSONResponse }

func (DeleteVerification401JSONResponse) VisitDeleteVerificationResponse

func (response DeleteVerification401JSONResponse) VisitDeleteVerificationResponse(w http.ResponseWriter) error

type DeleteVerification403JSONResponse

type DeleteVerification403JSONResponse struct{ ForbiddenJSONResponse }

func (DeleteVerification403JSONResponse) VisitDeleteVerificationResponse

func (response DeleteVerification403JSONResponse) VisitDeleteVerificationResponse(w http.ResponseWriter) error

type DeleteVerification404JSONResponse

type DeleteVerification404JSONResponse struct{ NotFoundJSONResponse }

func (DeleteVerification404JSONResponse) VisitDeleteVerificationResponse

func (response DeleteVerification404JSONResponse) VisitDeleteVerificationResponse(w http.ResponseWriter) error

type DeleteVerificationRequestObject

type DeleteVerificationRequestObject struct {
	ReportId string `json:"reportId"`
}

type DeleteVerificationResponseObject

type DeleteVerificationResponseObject interface {
	VisitDeleteVerificationResponse(w http.ResponseWriter) error
}

type Error

type Error struct {
	// Code Machine-readable failure category, stable across releases — one of
	// unauthenticated, forbidden, not_found, conflict, busy, invalid,
	// unimplemented, internal. Clients branch on this, not on the message.
	Code string `json:"code"`

	// Error Human-readable message. Carries no subject id, even on 403.
	Error string `json:"error"`
}

Error defines model for Error.

type Execution

type Execution struct {
	// Layer Pin execution to a named storage layer — any layer the stack composes —
	// instead of letting the planner choose which layer answers. The engine then
	// follows from that layer's capability (its native walk, or a Cypher/GQL
	// engine if it has one).
	Layer *string `json:"layer,omitempty"`

	// Report Execution-report verbosity: info (high-level stages), debug (routing and
	// lowering), or trace (per-claim detail). Absent, no report is produced; set,
	// the sequence's **final item** is a QueryReport.
	Report *ExecutionReport `json:"report,omitempty"`
}

Execution Where the query runs and how it reports on itself (paper 02 §Filtered Reads). Queries are declarative; the planner lowers each to the most capable engine the storage stack offers, so these controls affect execution and diagnostics only, never the result set.

type ExecutionReport

type ExecutionReport string

ExecutionReport Execution-report verbosity: info (high-level stages), debug (routing and lowering), or trace (per-claim detail). Absent, no report is produced; set, the sequence's **final item** is a QueryReport.

const (
	Debug ExecutionReport = "debug"
	Info  ExecutionReport = "info"
	Trace ExecutionReport = "trace"
)

Defines values for ExecutionReport.

func (ExecutionReport) Valid

func (e ExecutionReport) Valid() bool

Valid indicates whether the value is a known member of the ExecutionReport enum.

type Forbidden

type Forbidden = Error

Forbidden defines model for Forbidden.

type ForbiddenJSONResponse

type ForbiddenJSONResponse Error

type GetBranchClaim200ApplicationcborResponse

type GetBranchClaim200ApplicationcborResponse struct {
	Body          io.Reader
	Headers       GetBranchClaim200ResponseHeaders
	ContentLength int64
}

func (GetBranchClaim200ApplicationcborResponse) VisitGetBranchClaimResponse

func (response GetBranchClaim200ApplicationcborResponse) VisitGetBranchClaimResponse(w http.ResponseWriter) error

type GetBranchClaim200ResponseHeaders

type GetBranchClaim200ResponseHeaders struct {
	ETag *string
}

type GetBranchClaim401JSONResponse

type GetBranchClaim401JSONResponse struct{ UnauthorizedJSONResponse }

func (GetBranchClaim401JSONResponse) VisitGetBranchClaimResponse

func (response GetBranchClaim401JSONResponse) VisitGetBranchClaimResponse(w http.ResponseWriter) error

type GetBranchClaim403JSONResponse

type GetBranchClaim403JSONResponse struct{ ForbiddenJSONResponse }

func (GetBranchClaim403JSONResponse) VisitGetBranchClaimResponse

func (response GetBranchClaim403JSONResponse) VisitGetBranchClaimResponse(w http.ResponseWriter) error

type GetBranchClaim404JSONResponse

type GetBranchClaim404JSONResponse struct{ NotFoundJSONResponse }

func (GetBranchClaim404JSONResponse) VisitGetBranchClaimResponse

func (response GetBranchClaim404JSONResponse) VisitGetBranchClaimResponse(w http.ResponseWriter) error

type GetBranchClaimContent200ApplicationoctetStreamResponse

type GetBranchClaimContent200ApplicationoctetStreamResponse struct {
	Body          io.Reader
	Headers       GetBranchClaimContent200ResponseHeaders
	ContentLength int64
}

func (GetBranchClaimContent200ApplicationoctetStreamResponse) VisitGetBranchClaimContentResponse

func (response GetBranchClaimContent200ApplicationoctetStreamResponse) VisitGetBranchClaimContentResponse(w http.ResponseWriter) error

type GetBranchClaimContent200ResponseHeaders

type GetBranchClaimContent200ResponseHeaders struct {
	ETag *string
}

type GetBranchClaimContent401JSONResponse

type GetBranchClaimContent401JSONResponse struct{ UnauthorizedJSONResponse }

func (GetBranchClaimContent401JSONResponse) VisitGetBranchClaimContentResponse

func (response GetBranchClaimContent401JSONResponse) VisitGetBranchClaimContentResponse(w http.ResponseWriter) error

type GetBranchClaimContent403JSONResponse

type GetBranchClaimContent403JSONResponse struct{ ForbiddenJSONResponse }

func (GetBranchClaimContent403JSONResponse) VisitGetBranchClaimContentResponse

func (response GetBranchClaimContent403JSONResponse) VisitGetBranchClaimContentResponse(w http.ResponseWriter) error

type GetBranchClaimContent404JSONResponse

type GetBranchClaimContent404JSONResponse struct{ NotFoundJSONResponse }

func (GetBranchClaimContent404JSONResponse) VisitGetBranchClaimContentResponse

func (response GetBranchClaimContent404JSONResponse) VisitGetBranchClaimContentResponse(w http.ResponseWriter) error

type GetBranchClaimContentRequestObject

type GetBranchClaimContentRequestObject struct {
	Branch BranchName `json:"branch"`
	Id     ClaimId    `json:"id"`
}

type GetBranchClaimContentResponseObject

type GetBranchClaimContentResponseObject interface {
	VisitGetBranchClaimContentResponse(w http.ResponseWriter) error
}

type GetBranchClaimRequestObject

type GetBranchClaimRequestObject struct {
	Branch BranchName `json:"branch"`
	Id     ClaimId    `json:"id"`
}

type GetBranchClaimResponseObject

type GetBranchClaimResponseObject interface {
	VisitGetBranchClaimResponse(w http.ResponseWriter) error
}

type GetBranchHead200JSONResponse

type GetBranchHead200JSONResponse struct {
	Body    BranchHead
	Headers GetBranchHead200ResponseHeaders
}

func (GetBranchHead200JSONResponse) VisitGetBranchHeadResponse

func (response GetBranchHead200JSONResponse) VisitGetBranchHeadResponse(w http.ResponseWriter) error

type GetBranchHead200ResponseHeaders

type GetBranchHead200ResponseHeaders struct {
	ETag *string
}

type GetBranchHead401JSONResponse

type GetBranchHead401JSONResponse struct{ UnauthorizedJSONResponse }

func (GetBranchHead401JSONResponse) VisitGetBranchHeadResponse

func (response GetBranchHead401JSONResponse) VisitGetBranchHeadResponse(w http.ResponseWriter) error

type GetBranchHead403JSONResponse

type GetBranchHead403JSONResponse struct{ ForbiddenJSONResponse }

func (GetBranchHead403JSONResponse) VisitGetBranchHeadResponse

func (response GetBranchHead403JSONResponse) VisitGetBranchHeadResponse(w http.ResponseWriter) error

type GetBranchHead404JSONResponse

type GetBranchHead404JSONResponse struct{ NotFoundJSONResponse }

func (GetBranchHead404JSONResponse) VisitGetBranchHeadResponse

func (response GetBranchHead404JSONResponse) VisitGetBranchHeadResponse(w http.ResponseWriter) error

type GetBranchHeadRequestObject

type GetBranchHeadRequestObject struct {
	Branch BranchName `json:"branch"`
}

type GetBranchHeadResponseObject

type GetBranchHeadResponseObject interface {
	VisitGetBranchHeadResponse(w http.ResponseWriter) error
}

type GetUniverseClaim200ApplicationcborResponse

type GetUniverseClaim200ApplicationcborResponse struct {
	Body          io.Reader
	Headers       GetUniverseClaim200ResponseHeaders
	ContentLength int64
}

func (GetUniverseClaim200ApplicationcborResponse) VisitGetUniverseClaimResponse

func (response GetUniverseClaim200ApplicationcborResponse) VisitGetUniverseClaimResponse(w http.ResponseWriter) error

type GetUniverseClaim200ResponseHeaders

type GetUniverseClaim200ResponseHeaders struct {
	ETag *string
}

type GetUniverseClaim401JSONResponse

type GetUniverseClaim401JSONResponse struct{ UnauthorizedJSONResponse }

func (GetUniverseClaim401JSONResponse) VisitGetUniverseClaimResponse

func (response GetUniverseClaim401JSONResponse) VisitGetUniverseClaimResponse(w http.ResponseWriter) error

type GetUniverseClaim403JSONResponse

type GetUniverseClaim403JSONResponse struct{ ForbiddenJSONResponse }

func (GetUniverseClaim403JSONResponse) VisitGetUniverseClaimResponse

func (response GetUniverseClaim403JSONResponse) VisitGetUniverseClaimResponse(w http.ResponseWriter) error

type GetUniverseClaim404JSONResponse

type GetUniverseClaim404JSONResponse struct{ NotFoundJSONResponse }

func (GetUniverseClaim404JSONResponse) VisitGetUniverseClaimResponse

func (response GetUniverseClaim404JSONResponse) VisitGetUniverseClaimResponse(w http.ResponseWriter) error

type GetUniverseClaimContent200ApplicationoctetStreamResponse

type GetUniverseClaimContent200ApplicationoctetStreamResponse struct {
	Body          io.Reader
	Headers       GetUniverseClaimContent200ResponseHeaders
	ContentLength int64
}

func (GetUniverseClaimContent200ApplicationoctetStreamResponse) VisitGetUniverseClaimContentResponse

func (response GetUniverseClaimContent200ApplicationoctetStreamResponse) VisitGetUniverseClaimContentResponse(w http.ResponseWriter) error

type GetUniverseClaimContent200ResponseHeaders

type GetUniverseClaimContent200ResponseHeaders struct {
	ETag *string
}

type GetUniverseClaimContent401JSONResponse

type GetUniverseClaimContent401JSONResponse struct{ UnauthorizedJSONResponse }

func (GetUniverseClaimContent401JSONResponse) VisitGetUniverseClaimContentResponse

func (response GetUniverseClaimContent401JSONResponse) VisitGetUniverseClaimContentResponse(w http.ResponseWriter) error

type GetUniverseClaimContent403JSONResponse

type GetUniverseClaimContent403JSONResponse struct{ ForbiddenJSONResponse }

func (GetUniverseClaimContent403JSONResponse) VisitGetUniverseClaimContentResponse

func (response GetUniverseClaimContent403JSONResponse) VisitGetUniverseClaimContentResponse(w http.ResponseWriter) error

type GetUniverseClaimContent404JSONResponse

type GetUniverseClaimContent404JSONResponse struct{ NotFoundJSONResponse }

func (GetUniverseClaimContent404JSONResponse) VisitGetUniverseClaimContentResponse

func (response GetUniverseClaimContent404JSONResponse) VisitGetUniverseClaimContentResponse(w http.ResponseWriter) error

type GetUniverseClaimContentRequestObject

type GetUniverseClaimContentRequestObject struct {
	Id ClaimId `json:"id"`
}

type GetUniverseClaimContentResponseObject

type GetUniverseClaimContentResponseObject interface {
	VisitGetUniverseClaimContentResponse(w http.ResponseWriter) error
}

type GetUniverseClaimRequestObject

type GetUniverseClaimRequestObject struct {
	Id ClaimId `json:"id"`
}

type GetUniverseClaimResponseObject

type GetUniverseClaimResponseObject interface {
	VisitGetUniverseClaimResponse(w http.ResponseWriter) error
}

type GetVerification200JSONResponse

type GetVerification200JSONResponse struct {
	Body    VerificationReport
	Headers GetVerification200ResponseHeaders
}

func (GetVerification200JSONResponse) VisitGetVerificationResponse

func (response GetVerification200JSONResponse) VisitGetVerificationResponse(w http.ResponseWriter) error

type GetVerification200ResponseHeaders

type GetVerification200ResponseHeaders struct {
	RetryAfter *int
}

type GetVerification401JSONResponse

type GetVerification401JSONResponse struct{ UnauthorizedJSONResponse }

func (GetVerification401JSONResponse) VisitGetVerificationResponse

func (response GetVerification401JSONResponse) VisitGetVerificationResponse(w http.ResponseWriter) error

type GetVerification403JSONResponse

type GetVerification403JSONResponse struct{ ForbiddenJSONResponse }

func (GetVerification403JSONResponse) VisitGetVerificationResponse

func (response GetVerification403JSONResponse) VisitGetVerificationResponse(w http.ResponseWriter) error

type GetVerification404JSONResponse

type GetVerification404JSONResponse struct{ NotFoundJSONResponse }

func (GetVerification404JSONResponse) VisitGetVerificationResponse

func (response GetVerification404JSONResponse) VisitGetVerificationResponse(w http.ResponseWriter) error

type GetVerificationRequestObject

type GetVerificationRequestObject struct {
	ReportId string `json:"reportId"`
}

type GetVerificationResponseObject

type GetVerificationResponseObject interface {
	VisitGetVerificationResponse(w http.ResponseWriter) error
}

type Health

type Health struct {
	// Signer The contributor identity this stack signs merges with.
	//
	// Example: did:key:z6Mk...
	Signer *string `json:"signer,omitempty"`

	// Status Example: ok
	Status string `json:"status"`
}

Health defines model for Health.

type Health200JSONResponse

type Health200JSONResponse Health

func (Health200JSONResponse) VisitHealthResponse

func (response Health200JSONResponse) VisitHealthResponse(w http.ResponseWriter) error

type HealthRequestObject

type HealthRequestObject struct {
}

type HealthResponseObject

type HealthResponseObject interface {
	VisitHealthResponse(w http.ResponseWriter) error
}

type InvalidParamFormatError

type InvalidParamFormatError struct {
	ParamName string
	Err       error
}

func (*InvalidParamFormatError) Error

func (e *InvalidParamFormatError) Error() string

func (*InvalidParamFormatError) Unwrap

func (e *InvalidParamFormatError) Unwrap() error

type Limit

type Limit struct {
	// Results Maximum number of claims returned; `0` = unbounded.
	Results *int `json:"results,omitempty"`

	// Time Execution budget as a duration (e.g. `"5s"`); the query is cancelled when
	// exceeded. Absent or `"0"` = no budget.
	Time *string `json:"time,omitempty"`
}

Limit Bounds the read; each field's `0` means unbounded.

type ListStorageLayers200JSONResponse

type ListStorageLayers200JSONResponse StorageLayerList

func (ListStorageLayers200JSONResponse) VisitListStorageLayersResponse

func (response ListStorageLayers200JSONResponse) VisitListStorageLayersResponse(w http.ResponseWriter) error

type ListStorageLayers401JSONResponse

type ListStorageLayers401JSONResponse struct{ UnauthorizedJSONResponse }

func (ListStorageLayers401JSONResponse) VisitListStorageLayersResponse

func (response ListStorageLayers401JSONResponse) VisitListStorageLayersResponse(w http.ResponseWriter) error

type ListStorageLayers403JSONResponse

type ListStorageLayers403JSONResponse struct{ ForbiddenJSONResponse }

func (ListStorageLayers403JSONResponse) VisitListStorageLayersResponse

func (response ListStorageLayers403JSONResponse) VisitListStorageLayersResponse(w http.ResponseWriter) error

type ListStorageLayersRequestObject

type ListStorageLayersRequestObject struct {
}

type ListStorageLayersResponseObject

type ListStorageLayersResponseObject interface {
	VisitListStorageLayersResponse(w http.ResponseWriter) error
}

type ListVerifications200JSONResponse

type ListVerifications200JSONResponse VerificationReportList

func (ListVerifications200JSONResponse) VisitListVerificationsResponse

func (response ListVerifications200JSONResponse) VisitListVerificationsResponse(w http.ResponseWriter) error

type ListVerifications401JSONResponse

type ListVerifications401JSONResponse struct{ UnauthorizedJSONResponse }

func (ListVerifications401JSONResponse) VisitListVerificationsResponse

func (response ListVerifications401JSONResponse) VisitListVerificationsResponse(w http.ResponseWriter) error

type ListVerifications403JSONResponse

type ListVerifications403JSONResponse struct{ ForbiddenJSONResponse }

func (ListVerifications403JSONResponse) VisitListVerificationsResponse

func (response ListVerifications403JSONResponse) VisitListVerificationsResponse(w http.ResponseWriter) error

type ListVerificationsRequestObject

type ListVerificationsRequestObject struct {
}

type ListVerificationsResponseObject

type ListVerificationsResponseObject interface {
	VisitListVerificationsResponse(w http.ResponseWriter) error
}

type MiddlewareFunc

type MiddlewareFunc func(http.Handler) http.Handler

type NotFound

type NotFound = Error

NotFound defines model for NotFound.

type NotFoundJSONResponse

type NotFoundJSONResponse Error

type OrderKey

type OrderKey struct {
	// Compare How the values compare; absent = lexical.
	Compare *OrderKeyCompare `json:"compare,omitempty"`

	// Dir Sort direction; absent = asc.
	Dir *OrderKeyDir `json:"dir,omitempty"`

	// Field The field sorted on — any field a claim carries, or the derived `height`.
	Field string `json:"field"`
}

OrderKey One sort key. Keys apply in priority order, claims lacking a key's field sort last, and the natural `(created_at, id)` order breaks any remaining ties — so the sort always resolves to a total order and paging stays stable.

type OrderKeyCompare

type OrderKeyCompare string

OrderKeyCompare How the values compare; absent = lexical.

const (
	Lexical OrderKeyCompare = "lexical"
	Numeric OrderKeyCompare = "numeric"
)

Defines values for OrderKeyCompare.

func (OrderKeyCompare) Valid

func (e OrderKeyCompare) Valid() bool

Valid indicates whether the value is a known member of the OrderKeyCompare enum.

type OrderKeyDir

type OrderKeyDir string

OrderKeyDir Sort direction; absent = asc.

const (
	Asc  OrderKeyDir = "asc"
	Desc OrderKeyDir = "desc"
)

Defines values for OrderKeyDir.

func (OrderKeyDir) Valid

func (e OrderKeyDir) Valid() bool

Valid indicates whether the value is a known member of the OrderKeyDir enum.

type Output

type Output struct {
	// Content Inline content per claim. Absent, no content is inlined and a claim carries
	// only its `content_hash`.
	Content *OutputContent `json:"content,omitempty"`

	// Detail How each element is carried: id (identities only), graph (nodes joined by
	// the edges between them), or claims (each node with **all** its outgoing
	// edges — the default, and richer than graph).
	Detail *OutputDetail `json:"detail,omitempty"`

	// Encoding How each claim is serialised — json (text; content base64-encoded) or cbor
	// (binary). The same information either way, and orthogonal to the other
	// output fields; the response media type frames the sequence to match
	// (`application/json-seq` / `application/cbor-seq`).
	Encoding *OutputEncoding `json:"encoding,omitempty"`

	// Form Which field values each claim carries: original (as written — a
	// diff-overlaid claim's delta, and the id-defining form) or materialized
	// (with any `contribution/diff` chain resolved). A property of the values,
	// so orthogonal to `detail` and `encoding`.
	Form *OutputForm `json:"form,omitempty"`

	// Shape single (each item is one reached endpoint — the default) or path (each item
	// is the route to it, start-first).
	Shape *OutputShape `json:"shape,omitempty"`
}

Output Shapes each result along orthogonal axes and fixes the per-claim serialization. `detail: claims` + `form: original` + `encoding: cbor` reproduces the canonical bytes a claim's id is computed over — the only combination directly verifiable against that id.

type OutputContent

type OutputContent struct {
	// Max Cap in bytes on the content inlined per claim.
	Max int `json:"max"`

	// Overflow What happens to content past the cap: cutoff (truncate), omit (drop it),
	// or reference (a `content_hash` stub in its place — the bytes are then
	// fetched from the claim's content route).
	Overflow *OutputContentOverflow `json:"overflow,omitempty"`
}

OutputContent Inline content per claim. Absent, no content is inlined and a claim carries only its `content_hash`.

type OutputContentOverflow

type OutputContentOverflow string

OutputContentOverflow What happens to content past the cap: cutoff (truncate), omit (drop it), or reference (a `content_hash` stub in its place — the bytes are then fetched from the claim's content route).

const (
	Cutoff    OutputContentOverflow = "cutoff"
	Omit      OutputContentOverflow = "omit"
	Reference OutputContentOverflow = "reference"
)

Defines values for OutputContentOverflow.

func (OutputContentOverflow) Valid

func (e OutputContentOverflow) Valid() bool

Valid indicates whether the value is a known member of the OutputContentOverflow enum.

type OutputDetail

type OutputDetail string

OutputDetail How each element is carried: id (identities only), graph (nodes joined by the edges between them), or claims (each node with **all** its outgoing edges — the default, and richer than graph).

const (
	Claims OutputDetail = "claims"
	Graph  OutputDetail = "graph"
	Id     OutputDetail = "id"
)

Defines values for OutputDetail.

func (OutputDetail) Valid

func (e OutputDetail) Valid() bool

Valid indicates whether the value is a known member of the OutputDetail enum.

type OutputEncoding

type OutputEncoding string

OutputEncoding How each claim is serialised — json (text; content base64-encoded) or cbor (binary). The same information either way, and orthogonal to the other output fields; the response media type frames the sequence to match (`application/json-seq` / `application/cbor-seq`).

const (
	Cbor OutputEncoding = "cbor"
	Json OutputEncoding = "json"
)

Defines values for OutputEncoding.

func (OutputEncoding) Valid

func (e OutputEncoding) Valid() bool

Valid indicates whether the value is a known member of the OutputEncoding enum.

type OutputForm

type OutputForm string

OutputForm Which field values each claim carries: original (as written — a diff-overlaid claim's delta, and the id-defining form) or materialized (with any `contribution/diff` chain resolved). A property of the values, so orthogonal to `detail` and `encoding`.

const (
	Materialized OutputForm = "materialized"
	Original     OutputForm = "original"
)

Defines values for OutputForm.

func (OutputForm) Valid

func (e OutputForm) Valid() bool

Valid indicates whether the value is a known member of the OutputForm enum.

type OutputShape

type OutputShape string

OutputShape single (each item is one reached endpoint — the default) or path (each item is the route to it, start-first).

const (
	Path   OutputShape = "path"
	Single OutputShape = "single"
)

Defines values for OutputShape.

func (OutputShape) Valid

func (e OutputShape) Valid() bool

Valid indicates whether the value is a known member of the OutputShape enum.

type PathStep

type PathStep struct {
	// Dir provenance (outgoing, toward references — the default), uses (incoming,
	// the claims that cite this one), or connections (either).
	Dir *PathStepDir `json:"dir,omitempty"`

	// Edges Edge-class globs over `class/sub`; a leading `-` on an entry excludes that class.
	Edges *[]string `json:"edges,omitempty"`

	// Max Most hops; `0` means unbounded for this step (a step of at most zero hops
	// would move nothing). A `min` above a bounded `max` is rejected.
	Max *int `json:"max,omitempty"`

	// Min Fewest hops; absent means 1, so a step moves at least one hop. `0` also
	// yields the step's own starting set, carrying the frontier through
	// alongside what lies beyond it.
	Min *int `json:"min,omitempty"`

	// Nodes Node-class globs the step may yield; a leading `-` excludes a class.
	Nodes *[]string `json:"nodes,omitempty"`
}

PathStep One bounded walk: follow `edges` in direction `dir` for between `min` and `max` hops, optionally constraining what it yields to `nodes` types. `edges` gates every hop; `nodes` gates only the claims the step yields, never those it passes through. Each step starts from the **set** of endpoints the previous step produced — a frontier pipeline — and the no-repeat rule applies within a step and resets at each step boundary.

type PathStepDir

type PathStepDir string

PathStepDir provenance (outgoing, toward references — the default), uses (incoming, the claims that cite this one), or connections (either).

const (
	Connections PathStepDir = "connections"
	Provenance  PathStepDir = "provenance"
	Uses        PathStepDir = "uses"
)

Defines values for PathStepDir.

func (PathStepDir) Valid

func (e PathStepDir) Valid() bool

Valid indicates whether the value is a known member of the PathStepDir enum.

type Query

type Query struct {
	// Execution Where the query runs and how it reports on itself (paper 02 §Filtered Reads).
	// Queries are declarative; the planner lowers each to the most capable engine the
	// storage stack offers, so these controls affect execution and diagnostics only,
	// never the result set.
	Execution *Execution `json:"execution,omitempty"`

	// Limit Bounds the read; each field's `0` means unbounded.
	Limit *Limit `json:"limit,omitempty"`

	// Order Sort keys in priority order; absent or empty leaves the natural
	// `(created_at, id)` order.
	Order *[]OrderKey `json:"order,omitempty"`

	// Output Shapes each result along orthogonal axes and fixes the per-claim
	// serialization. `detail: claims` + `form: original` + `encoding: cbor`
	// reproduces the canonical bytes a claim's id is computed over — the only
	// combination directly verifiable against that id.
	Output *Output `json:"output,omitempty"`

	// Select A generator in four orthogonal parts: `branch` is the **scope**, `head` the
	// **closure** read, `claim` where the walk **starts**, and `path` the
	// **traversal**. Scope and start are independent because a walk runs both ways:
	// a `uses` step reaches the claims that *cite* the current one, which lie above
	// it, so it is the closure — not the start — that decides a reverse step's
	// answer.
	Select Select `json:"select"`

	// Where A boolean tree. Each node is exactly one of the `and`/`or`/`not` combinators
	// over sub-trees, or a **leaf** naming a `field` and its `test`. Within a
	// `where`, `or` is boolean; across generators it unions whole result sets. A leaf
	// may name any field a claim carries, including the derived `height` (the level a
	// claim sits at above its sources, compared numerically).
	Where *Where `json:"where,omitempty"`
}

Query A RankeQL read (§RankeQL), evaluated in a fixed logical order: `select` generates the result set, `where` filters it, `order` sorts it, `limit` truncates it, and `output` shapes and encodes each surviving claim. An engine may reorder or lower those steps as long as the delivered result set is identical.

type Query200ApplicationcborSeqResponse

type Query200ApplicationcborSeqResponse struct {
	Body          io.Reader
	ContentLength int64
}

func (Query200ApplicationcborSeqResponse) VisitQueryResponse

func (response Query200ApplicationcborSeqResponse) VisitQueryResponse(w http.ResponseWriter) error

type Query200ApplicationjsonSeqResponse

type Query200ApplicationjsonSeqResponse struct {
	Body          io.Reader
	ContentLength int64
}

func (Query200ApplicationjsonSeqResponse) VisitQueryResponse

func (response Query200ApplicationjsonSeqResponse) VisitQueryResponse(w http.ResponseWriter) error

type Query400JSONResponse

type Query400JSONResponse struct{ BadRequestJSONResponse }

func (Query400JSONResponse) VisitQueryResponse

func (response Query400JSONResponse) VisitQueryResponse(w http.ResponseWriter) error

type Query401JSONResponse

type Query401JSONResponse struct{ UnauthorizedJSONResponse }

func (Query401JSONResponse) VisitQueryResponse

func (response Query401JSONResponse) VisitQueryResponse(w http.ResponseWriter) error

type Query403JSONResponse

type Query403JSONResponse struct{ ForbiddenJSONResponse }

func (Query403JSONResponse) VisitQueryResponse

func (response Query403JSONResponse) VisitQueryResponse(w http.ResponseWriter) error

type Query404JSONResponse

type Query404JSONResponse struct{ NotFoundJSONResponse }

func (Query404JSONResponse) VisitQueryResponse

func (response Query404JSONResponse) VisitQueryResponse(w http.ResponseWriter) error

type QueryJSONRequestBody

type QueryJSONRequestBody = Query

QueryJSONRequestBody defines body for Query for application/json ContentType.

type QueryRequestObject

type QueryRequestObject struct {
	Body *QueryJSONRequestBody
}

type QueryResponseObject

type QueryResponseObject interface {
	VisitQueryResponse(w http.ResponseWriter) error
}

type RequiredHeaderError

type RequiredHeaderError struct {
	ParamName string
	Err       error
}

func (*RequiredHeaderError) Error

func (e *RequiredHeaderError) Error() string

func (*RequiredHeaderError) Unwrap

func (e *RequiredHeaderError) Unwrap() error

type RequiredParamError

type RequiredParamError struct {
	ParamName string
}

func (*RequiredParamError) Error

func (e *RequiredParamError) Error() string

type Select

type Select struct {
	// Branch The mandatory scope: a branch name (confines the query to that branch),
	// `$archive` (the whole Ranke-Archive), or `$universe` (no confinement —
	// privileged). An empty value is not allowed.
	Branch string `json:"branch"`

	// Claim Where the walk starts, which must lie inside the closure; absent, the walk
	// starts at the closure's head. It moves where reading begins, never what is
	// visible.
	Claim *string `json:"claim,omitempty"`

	// Head The closure read: the query sees the closure of this claim and nothing
	// else. **Required** under `$universe`, which confines nothing and so offers
	// no head to fall back on; optional under every other scope, where the
	// scope's own head serves. Given explicitly it must resolve to a claim
	// within the scope's closure, so it narrows the read and can never widen it
	// past the grant.
	Head *string `json:"head,omitempty"`

	// Path The traversal: steps applied in order. A step-less `path` returns the full
	// outward closure of the start claim.
	Path *[]PathStep `json:"path,omitempty"`
}

Select A generator in four orthogonal parts: `branch` is the **scope**, `head` the **closure** read, `claim` where the walk **starts**, and `path` the **traversal**. Scope and start are independent because a walk runs both ways: a `uses` step reaches the claims that *cite* the current one, which lie above it, so it is the closure — not the start — that decides a reverse step's answer.

type ServeMux

type ServeMux interface {
	HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request))
	http.Handler
}

ServeMux is an abstraction of http.ServeMux.

type ServerInterface

type ServerInterface interface {
	// GetUniverseClaim Fetch a claim by id from the Universe (privileged)
	// (GET /$universe/claim/{id})
	GetUniverseClaim(w http.ResponseWriter, r *http.Request, id ClaimId)
	// GetUniverseClaimContent Fetch the content of a claim by id from the Universe (privileged)
	// (GET /$universe/claim/{id}/content)
	GetUniverseClaimContent(w http.ResponseWriter, r *http.Request, id ClaimId)
	// Contribute Contribute signed claims (atomic)
	// (POST /contribute)
	Contribute(w http.ResponseWriter, r *http.Request)
	// Health Liveness and signer identity
	// (GET /health)
	Health(w http.ResponseWriter, r *http.Request)
	// Query Read the graph with a declarative query
	// (POST /query)
	Query(w http.ResponseWriter, r *http.Request)
	// ListStorageLayers List storage layers
	// (GET /system/layers)
	ListStorageLayers(w http.ResponseWriter, r *http.Request)
	// ListVerifications List verification runs
	// (GET /system/verification)
	ListVerifications(w http.ResponseWriter, r *http.Request)
	// StartVerification Start a verification run
	// (POST /system/verification)
	StartVerification(w http.ResponseWriter, r *http.Request)
	// DeleteVerification Delete a verification run
	// (DELETE /system/verification/{reportId})
	DeleteVerification(w http.ResponseWriter, r *http.Request, reportId string)
	// GetVerification Show a verification run
	// (GET /system/verification/{reportId})
	GetVerification(w http.ResponseWriter, r *http.Request, reportId string)
	// CancelVerification Cancel a running verification run
	// (POST /system/verification/{reportId}/cancel)
	CancelVerification(w http.ResponseWriter, r *http.Request, reportId string)
	// GetBranchClaim Fetch a claim within a branch's closure
	// (GET /{branch}/claim/{id})
	GetBranchClaim(w http.ResponseWriter, r *http.Request, branch BranchName, id ClaimId)
	// GetBranchClaimContent Fetch the content of a claim within a branch's closure
	// (GET /{branch}/claim/{id}/content)
	GetBranchClaimContent(w http.ResponseWriter, r *http.Request, branch BranchName, id ClaimId)
	// GetBranchHead Current head id of a branch
	// (GET /{branch}/head)
	GetBranchHead(w http.ResponseWriter, r *http.Request, branch BranchName)
}

ServerInterface represents all server handlers.

func NewStrictHandler

func NewStrictHandler(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc) ServerInterface

func NewStrictHandlerWithOptions

func NewStrictHandlerWithOptions(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc, options StrictHTTPServerOptions) ServerInterface

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandlerFunc   func(w http.ResponseWriter, r *http.Request, err error)
}

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) CancelVerification

func (siw *ServerInterfaceWrapper) CancelVerification(w http.ResponseWriter, r *http.Request)

CancelVerification operation middleware

func (*ServerInterfaceWrapper) Contribute

func (siw *ServerInterfaceWrapper) Contribute(w http.ResponseWriter, r *http.Request)

Contribute operation middleware

func (*ServerInterfaceWrapper) DeleteVerification

func (siw *ServerInterfaceWrapper) DeleteVerification(w http.ResponseWriter, r *http.Request)

DeleteVerification operation middleware

func (*ServerInterfaceWrapper) GetBranchClaim

func (siw *ServerInterfaceWrapper) GetBranchClaim(w http.ResponseWriter, r *http.Request)

GetBranchClaim operation middleware

func (*ServerInterfaceWrapper) GetBranchClaimContent

func (siw *ServerInterfaceWrapper) GetBranchClaimContent(w http.ResponseWriter, r *http.Request)

GetBranchClaimContent operation middleware

func (*ServerInterfaceWrapper) GetBranchHead

func (siw *ServerInterfaceWrapper) GetBranchHead(w http.ResponseWriter, r *http.Request)

GetBranchHead operation middleware

func (*ServerInterfaceWrapper) GetUniverseClaim

func (siw *ServerInterfaceWrapper) GetUniverseClaim(w http.ResponseWriter, r *http.Request)

GetUniverseClaim operation middleware

func (*ServerInterfaceWrapper) GetUniverseClaimContent

func (siw *ServerInterfaceWrapper) GetUniverseClaimContent(w http.ResponseWriter, r *http.Request)

GetUniverseClaimContent operation middleware

func (*ServerInterfaceWrapper) GetVerification

func (siw *ServerInterfaceWrapper) GetVerification(w http.ResponseWriter, r *http.Request)

GetVerification operation middleware

func (*ServerInterfaceWrapper) Health

Health operation middleware

func (*ServerInterfaceWrapper) ListStorageLayers

func (siw *ServerInterfaceWrapper) ListStorageLayers(w http.ResponseWriter, r *http.Request)

ListStorageLayers operation middleware

func (*ServerInterfaceWrapper) ListVerifications

func (siw *ServerInterfaceWrapper) ListVerifications(w http.ResponseWriter, r *http.Request)

ListVerifications operation middleware

func (*ServerInterfaceWrapper) Query

Query operation middleware

func (*ServerInterfaceWrapper) StartVerification

func (siw *ServerInterfaceWrapper) StartVerification(w http.ResponseWriter, r *http.Request)

StartVerification operation middleware

type StartVerification202JSONResponse

type StartVerification202JSONResponse struct {
	Body    VerificationReport
	Headers StartVerification202ResponseHeaders
}

func (StartVerification202JSONResponse) VisitStartVerificationResponse

func (response StartVerification202JSONResponse) VisitStartVerificationResponse(w http.ResponseWriter) error

type StartVerification202ResponseHeaders

type StartVerification202ResponseHeaders struct {
	Location   *string
	RetryAfter *int
}

type StartVerification400JSONResponse

type StartVerification400JSONResponse struct{ BadRequestJSONResponse }

func (StartVerification400JSONResponse) VisitStartVerificationResponse

func (response StartVerification400JSONResponse) VisitStartVerificationResponse(w http.ResponseWriter) error

type StartVerification401JSONResponse

type StartVerification401JSONResponse struct{ UnauthorizedJSONResponse }

func (StartVerification401JSONResponse) VisitStartVerificationResponse

func (response StartVerification401JSONResponse) VisitStartVerificationResponse(w http.ResponseWriter) error

type StartVerification403JSONResponse

type StartVerification403JSONResponse struct{ ForbiddenJSONResponse }

func (StartVerification403JSONResponse) VisitStartVerificationResponse

func (response StartVerification403JSONResponse) VisitStartVerificationResponse(w http.ResponseWriter) error

type StartVerification429JSONResponse

type StartVerification429JSONResponse struct {
	Body    Error
	Headers StartVerification429ResponseHeaders
}

func (StartVerification429JSONResponse) VisitStartVerificationResponse

func (response StartVerification429JSONResponse) VisitStartVerificationResponse(w http.ResponseWriter) error

type StartVerification429ResponseHeaders

type StartVerification429ResponseHeaders struct {
	RetryAfter *int
}

type StartVerificationJSONRequestBody

type StartVerificationJSONRequestBody = VerificationConfig

StartVerificationJSONRequestBody defines body for StartVerification for application/json ContentType.

type StartVerificationRequestObject

type StartVerificationRequestObject struct {
	Body *StartVerificationJSONRequestBody
}

type StartVerificationResponseObject

type StartVerificationResponseObject interface {
	VisitStartVerificationResponse(w http.ResponseWriter) error
}

type StdHTTPServerOptions

type StdHTTPServerOptions struct {
	BaseURL          string
	BaseRouter       ServeMux
	Middlewares      []MiddlewareFunc
	ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type StorageLayer

type StorageLayer struct {
	Name string `json:"name"`

	// Type Adapter type (e.g. memory, filesystem, s3, postgres, neo4j).
	Type string `json:"type"`
}

StorageLayer defines model for StorageLayer.

type StorageLayerList

type StorageLayerList struct {
	// Layers Read-through tiers, top (cache) to bottom (authoritative).
	Layers []StorageLayer `json:"layers"`
}

StorageLayerList defines model for StorageLayerList.

type StrictHTTPServerOptions

type StrictHTTPServerOptions struct {
	RequestErrorHandlerFunc  func(w http.ResponseWriter, r *http.Request, err error)
	ResponseErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type StrictHandlerFunc

type StrictHandlerFunc func(ctx context.Context, w http.ResponseWriter, r *http.Request, request any) (any, error)

type StrictMiddlewareFunc

type StrictMiddlewareFunc func(f StrictHandlerFunc, operationID string) StrictHandlerFunc

type StrictServerInterface

type StrictServerInterface interface {
	// GetUniverseClaim Fetch a claim by id from the Universe (privileged)
	// (GET /$universe/claim/{id})
	GetUniverseClaim(ctx context.Context, request GetUniverseClaimRequestObject) (GetUniverseClaimResponseObject, error)
	// GetUniverseClaimContent Fetch the content of a claim by id from the Universe (privileged)
	// (GET /$universe/claim/{id}/content)
	GetUniverseClaimContent(ctx context.Context, request GetUniverseClaimContentRequestObject) (GetUniverseClaimContentResponseObject, error)
	// Contribute Contribute signed claims (atomic)
	// (POST /contribute)
	Contribute(ctx context.Context, request ContributeRequestObject) (ContributeResponseObject, error)
	// Health Liveness and signer identity
	// (GET /health)
	Health(ctx context.Context, request HealthRequestObject) (HealthResponseObject, error)
	// Query Read the graph with a declarative query
	// (POST /query)
	Query(ctx context.Context, request QueryRequestObject) (QueryResponseObject, error)
	// ListStorageLayers List storage layers
	// (GET /system/layers)
	ListStorageLayers(ctx context.Context, request ListStorageLayersRequestObject) (ListStorageLayersResponseObject, error)
	// ListVerifications List verification runs
	// (GET /system/verification)
	ListVerifications(ctx context.Context, request ListVerificationsRequestObject) (ListVerificationsResponseObject, error)
	// StartVerification Start a verification run
	// (POST /system/verification)
	StartVerification(ctx context.Context, request StartVerificationRequestObject) (StartVerificationResponseObject, error)
	// DeleteVerification Delete a verification run
	// (DELETE /system/verification/{reportId})
	DeleteVerification(ctx context.Context, request DeleteVerificationRequestObject) (DeleteVerificationResponseObject, error)
	// GetVerification Show a verification run
	// (GET /system/verification/{reportId})
	GetVerification(ctx context.Context, request GetVerificationRequestObject) (GetVerificationResponseObject, error)
	// CancelVerification Cancel a running verification run
	// (POST /system/verification/{reportId}/cancel)
	CancelVerification(ctx context.Context, request CancelVerificationRequestObject) (CancelVerificationResponseObject, error)
	// GetBranchClaim Fetch a claim within a branch's closure
	// (GET /{branch}/claim/{id})
	GetBranchClaim(ctx context.Context, request GetBranchClaimRequestObject) (GetBranchClaimResponseObject, error)
	// GetBranchClaimContent Fetch the content of a claim within a branch's closure
	// (GET /{branch}/claim/{id}/content)
	GetBranchClaimContent(ctx context.Context, request GetBranchClaimContentRequestObject) (GetBranchClaimContentResponseObject, error)
	// GetBranchHead Current head id of a branch
	// (GET /{branch}/head)
	GetBranchHead(ctx context.Context, request GetBranchHeadRequestObject) (GetBranchHeadResponseObject, error)
}

StrictServerInterface represents all server handlers.

type TooManyValuesForParamError

type TooManyValuesForParamError struct {
	ParamName string
	Count     int
}

func (*TooManyValuesForParamError) Error

type Unauthorized

type Unauthorized = Error

Unauthorized defines model for Unauthorized.

type UnauthorizedJSONResponse

type UnauthorizedJSONResponse Error

type UnescapedCookieParamError

type UnescapedCookieParamError struct {
	ParamName string
	Err       error
}

func (*UnescapedCookieParamError) Error

func (e *UnescapedCookieParamError) Error() string

func (*UnescapedCookieParamError) Unwrap

func (e *UnescapedCookieParamError) Unwrap() error

type UnmarshalingParamError

type UnmarshalingParamError struct {
	ParamName string
	Err       error
}

func (*UnmarshalingParamError) Error

func (e *UnmarshalingParamError) Error() string

func (*UnmarshalingParamError) Unwrap

func (e *UnmarshalingParamError) Unwrap() error

type VerificationConfig

type VerificationConfig struct {
	// Closure Root of the closure to verify — a branch name or a claim id.
	Closure string `json:"closure"`

	// ContentThreshold For full-content, the max content size in bytes to re-read and re-hash
	// per claim; larger content is skipped this run. Omit to verify all content.
	ContentThreshold *int `json:"contentThreshold,omitempty"`

	// Depth completeness (a `has` sweep), record-correctness (recanonicalise and
	// recheck the id-chain and signatures), or full-content (also re-hash blobs).
	Depth *VerificationConfigDepth `json:"depth,omitempty"`

	// Layer Storage layer (by name) to read directly. Omit to read the composed
	// read-through view — which may mask the loss of an object on a deeper
	// layer, so name a layer to verify it without blind spots.
	Layer *string `json:"layer,omitempty"`
}

VerificationConfig Parameters for a verification run — the same shape whether declared in the stack config (scheduled) or posted ad-hoc. Depths are those of core-verification.

type VerificationConfigDepth

type VerificationConfigDepth string

VerificationConfigDepth completeness (a `has` sweep), record-correctness (recanonicalise and recheck the id-chain and signatures), or full-content (also re-hash blobs).

const (
	Completeness      VerificationConfigDepth = "completeness"
	FullContent       VerificationConfigDepth = "full-content"
	RecordCorrectness VerificationConfigDepth = "record-correctness"
)

Defines values for VerificationConfigDepth.

func (VerificationConfigDepth) Valid

func (e VerificationConfigDepth) Valid() bool

Valid indicates whether the value is a known member of the VerificationConfigDepth enum.

type VerificationFailure

type VerificationFailure struct {
	Detail *string `json:"detail,omitempty"`

	// Id The claim or object id that failed.
	Id string `json:"id"`

	// Layer The layer where the failure was observed.
	Layer string `json:"layer"`

	// Mode corrupt-bytes — stored bytes don't match their hash (storage rot/loss;
	// self-heals via read-through if a deeper layer is intact).
	// invalid-content — the claim itself doesn't validate (e.g. bad signature);
	// unrepairable.
	Mode VerificationFailureMode `json:"mode"`
}

VerificationFailure defines model for VerificationFailure.

type VerificationFailureMode

type VerificationFailureMode string

VerificationFailureMode corrupt-bytes — stored bytes don't match their hash (storage rot/loss; self-heals via read-through if a deeper layer is intact). invalid-content — the claim itself doesn't validate (e.g. bad signature); unrepairable.

const (
	CorruptBytes   VerificationFailureMode = "corrupt-bytes"
	InvalidContent VerificationFailureMode = "invalid-content"
)

Defines values for VerificationFailureMode.

func (VerificationFailureMode) Valid

func (e VerificationFailureMode) Valid() bool

Valid indicates whether the value is a known member of the VerificationFailureMode enum.

type VerificationReport

type VerificationReport struct {
	// BytesRead Content bytes re-read so far; advances while `status` is `running`.
	BytesRead *int `json:"bytesRead,omitempty"`

	// ClaimsChecked Claims checked so far; advances while `status` is `running`.
	ClaimsChecked *int       `json:"claimsChecked,omitempty"`
	CompletedAt   *time.Time `json:"completedAt,omitempty"`

	// Config Parameters for a verification run — the same shape whether declared in the
	// stack config (scheduled) or posted ad-hoc. Depths are those of
	// core-verification.
	Config VerificationConfig `json:"config"`

	// Failures The failures found, accumulating while `status` is `running`. Empty (with
	// `ok: true`) for an intact closure; a healthy archive verifies with none.
	Failures *[]VerificationFailure `json:"failures,omitempty"`

	// Head The head id the run verified — the closure it pinned at start. When
	// `config.closure` names a branch, this is the branch's head at start time;
	// the report stays fixed to it even as the branch head moves on.
	Head string `json:"head"`
	Id   string `json:"id"`

	// Ok True when no failures were found in this run.
	Ok        bool      `json:"ok"`
	StartedAt time.Time `json:"startedAt"`

	// Status running (in progress), complete (finished on its own), stopped (cancelled
	// by an operator via the cancel action — partial findings kept), or error
	// (the run itself failed).
	Status VerificationReportStatus `json:"status"`
}

VerificationReport A point-in-time record of a verification run; embeds the config that produced it.

type VerificationReportList

type VerificationReportList struct {
	Reports []VerificationReport `json:"reports"`
}

VerificationReportList defines model for VerificationReportList.

type VerificationReportStatus

type VerificationReportStatus string

VerificationReportStatus running (in progress), complete (finished on its own), stopped (cancelled by an operator via the cancel action — partial findings kept), or error (the run itself failed).

const (
	VerificationReportStatusComplete VerificationReportStatus = "complete"
	VerificationReportStatusError    VerificationReportStatus = "error"
	VerificationReportStatusRunning  VerificationReportStatus = "running"
	VerificationReportStatusStopped  VerificationReportStatus = "stopped"
)

Defines values for VerificationReportStatus.

func (VerificationReportStatus) Valid

func (e VerificationReportStatus) Valid() bool

Valid indicates whether the value is a known member of the VerificationReportStatus enum.

type Where

type Where struct {
	// contains filtered or unexported fields
}

Where A boolean tree. Each node is exactly one of the `and`/`or`/`not` combinators over sub-trees, or a **leaf** naming a `field` and its `test`. Within a `where`, `or` is boolean; across generators it unions whole result sets. A leaf may name any field a claim carries, including the derived `height` (the level a claim sits at above its sources, compared numerically).

func (Where) AsWhere0

func (t Where) AsWhere0() (Where0, error)

AsWhere0 returns the union data inside the Where as a Where0

func (Where) AsWhere1

func (t Where) AsWhere1() (Where1, error)

AsWhere1 returns the union data inside the Where as a Where1

func (Where) AsWhere2

func (t Where) AsWhere2() (Where2, error)

AsWhere2 returns the union data inside the Where as a Where2

func (Where) AsWhere3

func (t Where) AsWhere3() (Where3, error)

AsWhere3 returns the union data inside the Where as a Where3

func (*Where) FromWhere0

func (t *Where) FromWhere0(v Where0) error

FromWhere0 overwrites any union data inside the Where as the provided Where0

func (*Where) FromWhere1

func (t *Where) FromWhere1(v Where1) error

FromWhere1 overwrites any union data inside the Where as the provided Where1

func (*Where) FromWhere2

func (t *Where) FromWhere2(v Where2) error

FromWhere2 overwrites any union data inside the Where as the provided Where2

func (*Where) FromWhere3

func (t *Where) FromWhere3(v Where3) error

FromWhere3 overwrites any union data inside the Where as the provided Where3

func (Where) MarshalJSON

func (t Where) MarshalJSON() ([]byte, error)

func (*Where) MergeWhere0

func (t *Where) MergeWhere0(v Where0) error

MergeWhere0 performs a merge with any union data inside the Where, using the provided Where0

func (*Where) MergeWhere1

func (t *Where) MergeWhere1(v Where1) error

MergeWhere1 performs a merge with any union data inside the Where, using the provided Where1

func (*Where) MergeWhere2

func (t *Where) MergeWhere2(v Where2) error

MergeWhere2 performs a merge with any union data inside the Where, using the provided Where2

func (*Where) MergeWhere3

func (t *Where) MergeWhere3(v Where3) error

MergeWhere3 performs a merge with any union data inside the Where, using the provided Where3

func (*Where) UnmarshalJSON

func (t *Where) UnmarshalJSON(b []byte) error

type Where0

type Where0 struct {
	And []Where `json:"and"`
}

Where0 defines model for Where.0.

type Where1

type Where1 struct {
	Or []Where `json:"or"`
}

Where1 defines model for Where.1.

type Where2

type Where2 struct {
	// Not A boolean tree. Each node is exactly one of the `and`/`or`/`not` combinators
	// over sub-trees, or a **leaf** naming a `field` and its `test`. Within a
	// `where`, `or` is boolean; across generators it unions whole result sets. A leaf
	// may name any field a claim carries, including the derived `height` (the level a
	// claim sits at above its sources, compared numerically).
	Not Where `json:"not"`
}

Where2 defines model for Where.2.

type Where3

type Where3 struct {
	// Field The field tested — any field a claim carries, or the derived `height`.
	Field string `json:"field"`

	// Test A test on one field. Exactly one operator is expected. `in` takes a set;
	// `glob` a shell-style wildcard; the rest a scalar.
	Test Comparison `json:"test"`
}

Where3 A leaf: one field, one comparison (e.g. {"field": "type", "test": {"glob": "source/*"}}).

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL