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 ¶
- func GetSpec() (swagger *openapi3.T, err error)
- func GetSpecJSON() ([]byte, error)
- func GetSwagger() (*openapi3.T, error)deprecated
- func Handler(si ServerInterface) http.Handler
- func HandlerFromMux(si ServerInterface, m ServeMux) http.Handler
- func HandlerFromMuxWithBaseURL(si ServerInterface, m ServeMux, baseURL string) http.Handler
- func HandlerWithOptions(si ServerInterface, options StdHTTPServerOptions) http.Handler
- func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
- type AdvanceDevClock200JSONResponse
- type AdvanceDevClock400JSONResponse
- type AdvanceDevClock401JSONResponse
- type AdvanceDevClock403JSONResponse
- type AdvanceDevClock501JSONResponse
- type AdvanceDevClockJSONRequestBody
- type AdvanceDevClockRequestObject
- type AdvanceDevClockResponseObject
- type ArchiveInfo
- type BadRequest
- type BadRequestJSONResponse
- type BranchEntry
- type BranchHead
- type BranchInfo
- type BranchList
- type BranchName
- type CancelVerification200JSONResponse
- type CancelVerification401JSONResponse
- type CancelVerification403JSONResponse
- type CancelVerification404JSONResponse
- type CancelVerificationRequestObject
- type CancelVerificationResponseObject
- type ClaimId
- type Comparison
- type Conflict
- type ConflictJSONResponse
- type Contribute201JSONResponse
- type Contribute400JSONResponse
- type Contribute401JSONResponse
- type Contribute403JSONResponse
- type Contribute404JSONResponse
- type Contribute409JSONResponse
- type ContributeRequestObject
- type ContributeResponseObject
- type ContributionResult
- type DeleteVerification204Response
- type DeleteVerification401JSONResponse
- type DeleteVerification403JSONResponse
- type DeleteVerification404JSONResponse
- type DeleteVerificationRequestObject
- type DeleteVerificationResponseObject
- type DevClock
- type DevClockAdvance
- type Duration
- type Error
- type Execution
- type ExecutionReport
- type Forbidden
- type ForbiddenJSONResponse
- type GetArchiveClaim200ApplicationcborResponse
- type GetArchiveClaim200ResponseHeaders
- type GetArchiveClaim401JSONResponse
- type GetArchiveClaim403JSONResponse
- type GetArchiveClaim404JSONResponse
- type GetArchiveClaimContent200ApplicationoctetStreamResponse
- type GetArchiveClaimContent200ResponseHeaders
- type GetArchiveClaimContent401JSONResponse
- type GetArchiveClaimContent403JSONResponse
- type GetArchiveClaimContent404JSONResponse
- type GetArchiveClaimContentRequestObject
- type GetArchiveClaimContentResponseObject
- type GetArchiveClaimRequestObject
- type GetArchiveClaimResponseObject
- type GetArchiveInfo200JSONResponse
- type GetArchiveInfo200ResponseHeaders
- type GetArchiveInfo401JSONResponse
- type GetArchiveInfo403JSONResponse
- type GetArchiveInfoRequestObject
- type GetArchiveInfoResponseObject
- type GetBranchClaim200ApplicationcborResponse
- type GetBranchClaim200ResponseHeaders
- type GetBranchClaim401JSONResponse
- type GetBranchClaim403JSONResponse
- type GetBranchClaim404JSONResponse
- type GetBranchClaimContent200ApplicationoctetStreamResponse
- type GetBranchClaimContent200ResponseHeaders
- type GetBranchClaimContent401JSONResponse
- type GetBranchClaimContent403JSONResponse
- type GetBranchClaimContent404JSONResponse
- type GetBranchClaimContentRequestObject
- type GetBranchClaimContentResponseObject
- type GetBranchClaimRequestObject
- type GetBranchClaimResponseObject
- type GetBranchHead200JSONResponse
- type GetBranchHead200ResponseHeaders
- type GetBranchHead401JSONResponse
- type GetBranchHead403JSONResponse
- type GetBranchHead404JSONResponse
- type GetBranchHeadRequestObject
- type GetBranchHeadResponseObject
- type GetBranchInfo200JSONResponse
- type GetBranchInfo200ResponseHeaders
- type GetBranchInfo401JSONResponse
- type GetBranchInfo403JSONResponse
- type GetBranchInfo404JSONResponse
- type GetBranchInfoRequestObject
- type GetBranchInfoResponseObject
- type GetClaim200ApplicationcborResponse
- type GetClaim200ResponseHeaders
- type GetClaim401JSONResponse
- type GetClaim403JSONResponse
- type GetClaim404JSONResponse
- type GetClaimContent200ApplicationoctetStreamResponse
- type GetClaimContent200ResponseHeaders
- type GetClaimContent401JSONResponse
- type GetClaimContent403JSONResponse
- type GetClaimContent404JSONResponse
- type GetClaimContentRequestObject
- type GetClaimContentResponseObject
- type GetClaimRequestObject
- type GetClaimResponseObject
- type GetVerification200JSONResponse
- type GetVerification200ResponseHeaders
- type GetVerification401JSONResponse
- type GetVerification403JSONResponse
- type GetVerification404JSONResponse
- type GetVerificationRequestObject
- type GetVerificationResponseObject
- type Health
- type Health200JSONResponse
- type HealthRequestObject
- type HealthResponseObject
- type Id
- type InvalidParamFormatError
- type Limit
- type ListBranches200JSONResponse
- type ListBranches200ResponseHeaders
- type ListBranches401JSONResponse
- type ListBranches403JSONResponse
- type ListBranchesRequestObject
- type ListBranchesResponseObject
- type ListStorageLayers200JSONResponse
- type ListStorageLayers401JSONResponse
- type ListStorageLayers403JSONResponse
- type ListStorageLayersRequestObject
- type ListStorageLayersResponseObject
- type ListVerifications200JSONResponse
- type ListVerifications401JSONResponse
- type ListVerifications403JSONResponse
- type ListVerificationsRequestObject
- type ListVerificationsResponseObject
- type MiddlewareFunc
- type NotFound
- type NotFoundJSONResponse
- type NotImplemented
- type NotImplementedJSONResponse
- type Order
- type OrderKey
- type OrderKeyCompare
- type OrderKeyDir
- type Output
- type OutputContent
- type OutputContentOverflow
- type OutputDetail
- type OutputEncoding
- type OutputForm
- type OutputShape
- type PathStep
- type PathStepDir
- type Query
- type Query200ApplicationcborSeqResponse
- type Query200ApplicationjsonSeqResponse
- type Query400JSONResponse
- type Query401JSONResponse
- type Query403JSONResponse
- type Query404JSONResponse
- type QueryJSONRequestBody
- type QueryRequestObject
- type QueryResponseObject
- type RequiredHeaderError
- type RequiredParamError
- type Select
- type ServeMux
- type ServerInterface
- type ServerInterfaceWrapper
- func (siw *ServerInterfaceWrapper) AdvanceDevClock(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) CancelVerification(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) Contribute(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) DeleteVerification(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetArchiveClaim(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetArchiveClaimContent(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetArchiveInfo(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetBranchClaim(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetBranchClaimContent(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetBranchHead(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetBranchInfo(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetClaim(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetClaimContent(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetVerification(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) Health(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListBranches(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListStorageLayers(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListVerifications(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) Query(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) StartVerification(w http.ResponseWriter, r *http.Request)
- type StartVerification202JSONResponse
- type StartVerification202ResponseHeaders
- type StartVerification400JSONResponse
- type StartVerification401JSONResponse
- type StartVerification403JSONResponse
- type StartVerification429JSONResponse
- type StartVerification429ResponseHeaders
- type StartVerificationJSONRequestBody
- type StartVerificationRequestObject
- type StartVerificationResponseObject
- type StdHTTPServerOptions
- type StorageLayer
- type StorageLayerList
- type StrictHTTPServerOptions
- type StrictHandlerFunc
- type StrictMiddlewareFunc
- type StrictServerInterface
- type TooManyValuesForParamError
- type TypeGlob
- type Unauthorized
- type UnauthorizedJSONResponse
- type UnescapedCookieParamError
- type UnmarshalingParamError
- type Value
- type VerificationConfig
- type VerificationConfigDepth
- type VerificationFailure
- type VerificationFailureMode
- type VerificationReport
- type VerificationReportList
- type VerificationReportStatus
- type Where
- func (t Where) AsWhere0() (Where0, error)
- func (t Where) AsWhere1() (Where1, error)
- func (t Where) AsWhere2() (Where2, error)
- func (t Where) AsWhere3() (Where3, error)
- func (t *Where) FromWhere0(v Where0) error
- func (t *Where) FromWhere1(v Where1) error
- func (t *Where) FromWhere2(v Where2) error
- func (t *Where) FromWhere3(v Where3) error
- func (t Where) MarshalJSON() ([]byte, error)
- func (t *Where) MergeWhere0(v Where0) error
- func (t *Where) MergeWhere1(v Where1) error
- func (t *Where) MergeWhere2(v Where2) error
- func (t *Where) MergeWhere3(v Where3) error
- func (t *Where) UnmarshalJSON(b []byte) error
- type Where0
- type Where1
- type Where2
- type Where3
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetSpec ¶
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 ¶
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 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
Types ¶
type AdvanceDevClock200JSONResponse ¶ added in v1.15.0
type AdvanceDevClock200JSONResponse DevClock
func (AdvanceDevClock200JSONResponse) VisitAdvanceDevClockResponse ¶ added in v1.15.0
func (response AdvanceDevClock200JSONResponse) VisitAdvanceDevClockResponse(w http.ResponseWriter) error
type AdvanceDevClock400JSONResponse ¶ added in v1.15.0
type AdvanceDevClock400JSONResponse struct{ BadRequestJSONResponse }
func (AdvanceDevClock400JSONResponse) VisitAdvanceDevClockResponse ¶ added in v1.15.0
func (response AdvanceDevClock400JSONResponse) VisitAdvanceDevClockResponse(w http.ResponseWriter) error
type AdvanceDevClock401JSONResponse ¶ added in v1.15.0
func (AdvanceDevClock401JSONResponse) VisitAdvanceDevClockResponse ¶ added in v1.15.0
func (response AdvanceDevClock401JSONResponse) VisitAdvanceDevClockResponse(w http.ResponseWriter) error
type AdvanceDevClock403JSONResponse ¶ added in v1.15.0
type AdvanceDevClock403JSONResponse struct{ ForbiddenJSONResponse }
func (AdvanceDevClock403JSONResponse) VisitAdvanceDevClockResponse ¶ added in v1.15.0
func (response AdvanceDevClock403JSONResponse) VisitAdvanceDevClockResponse(w http.ResponseWriter) error
type AdvanceDevClock501JSONResponse ¶ added in v1.15.0
type AdvanceDevClock501JSONResponse struct{ NotImplementedJSONResponse }
func (AdvanceDevClock501JSONResponse) VisitAdvanceDevClockResponse ¶ added in v1.15.0
func (response AdvanceDevClock501JSONResponse) VisitAdvanceDevClockResponse(w http.ResponseWriter) error
type AdvanceDevClockJSONRequestBody ¶ added in v1.15.0
type AdvanceDevClockJSONRequestBody = DevClockAdvance
AdvanceDevClockJSONRequestBody defines body for AdvanceDevClock for application/json ContentType.
type AdvanceDevClockRequestObject ¶ added in v1.15.0
type AdvanceDevClockRequestObject struct {
Body *AdvanceDevClockJSONRequestBody
}
type AdvanceDevClockResponseObject ¶ added in v1.15.0
type AdvanceDevClockResponseObject interface {
VisitAdvanceDevClockResponse(w http.ResponseWriter) error
}
type ArchiveInfo ¶ added in v1.14.0
type ArchiveInfo struct {
// Branches How many branches the table holds.
Branches int `json:"branches"`
// Head The branch-table head id — the root of every `$archive`-scoped read, and the
// only place this contract reports it.
Head string `json:"head"`
// Height The branch-table head claim's generation number.
Height int64 `json:"height"`
// UpdatedAt The branch-table head's `created_at` — when the archive last moved.
UpdatedAt time.Time `json:"updatedAt"`
}
ArchiveInfo defines model for ArchiveInfo.
type BadRequestJSONResponse ¶
type BadRequestJSONResponse Error
type BranchEntry ¶ added in v1.14.0
type BranchEntry struct {
// Head That branch's current head claim id.
Head string `json:"head"`
// Name The branch name, as the branch table holds it.
Name string `json:"name"`
}
BranchEntry defines model for BranchEntry.
type BranchHead ¶
type BranchHead struct {
// Head The content-addressed head claim id.
Head string `json:"head"`
}
BranchHead defines model for BranchHead.
type BranchInfo ¶ added in v1.14.0
type BranchInfo struct {
// Head The content-addressed head claim id.
Head string `json:"head"`
// Height The head claim's generation number (§4.1) — 0 on an initial node, else
// 1 + max over what it references. The depth of what the branch points at.
Height int64 `json:"height"`
// Name The branch name, as the branch table holds it.
Name string `json:"name"`
// UpdatedAt The head claim's `created_at` — when the branch last moved. Soft: a
// contributor writes it, so it is not the witnessed merge time.
UpdatedAt time.Time `json:"updatedAt"`
}
BranchInfo defines model for BranchInfo.
type BranchList ¶ added in v1.14.0
type BranchList struct {
// Branches Every branch the branch table holds, from one archive snapshot — so the
// heads are consistent with each other. Empty on an archive with no branches.
Branches []BranchEntry `json:"branches"`
}
BranchList defines model for BranchList.
type CancelVerification200JSONResponse ¶
type CancelVerification200JSONResponse VerificationReport
func (CancelVerification200JSONResponse) VisitCancelVerificationResponse ¶
func (response CancelVerification200JSONResponse) VisitCancelVerificationResponse(w http.ResponseWriter) error
type CancelVerification401JSONResponse ¶
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 Comparison ¶
type Comparison struct {
// Eq A value a comparison tests against. How two values compare is the engine's, so the shape is unconstrained here.
Eq *Value `json:"eq,omitempty"`
// Ge A value a comparison tests against. How two values compare is the engine's, so the shape is unconstrained here.
Ge *Value `json:"ge,omitempty"`
// Glob Shell-style wildcard.
Glob *string `json:"glob,omitempty"`
// Gt A value a comparison tests against. How two values compare is the engine's, so the shape is unconstrained here.
Gt *Value `json:"gt,omitempty"`
// In Set membership.
In *[]Value `json:"in,omitempty"`
// Le A value a comparison tests against. How two values compare is the engine's, so the shape is unconstrained here.
Le *Value `json:"le,omitempty"`
// Lt A value a comparison tests against. How two values compare is the engine's, so the shape is unconstrained here.
Lt *Value `json:"lt,omitempty"`
// Ne A value a comparison tests against. How two values compare is the engine's, so the shape is unconstrained here.
Ne *Value `json:"ne,omitempty"`
}
Comparison One operator applied to one field. eq, ne, lt, le, gt and ge take a value, in a set, glob a shell-style wildcard. Exactly one is present.
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 ¶
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 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 ¶
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 DevClock ¶ added in v1.15.0
DevClock The dev sequencer's clock after the request — the later of what was asked and what it already held.
type DevClockAdvance ¶ added in v1.15.0
DevClockAdvance Requests the dev sequencer's clock advance to (at least) this instant. A request older than the clock's current position is accepted as a no-op — the clock only ever moves forward, since a merge's witnessed time regressing would break every guarantee built on it.
type Duration ¶ added in v1.15.0
type Duration = string
Duration A duration as a decimal sequence with unit suffixes — ns, us, ms, s, m, h — e.g. 5s or 1m30s. The bare 0 means unbounded.
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 Pins the query to one named storage or execution layer; absent, the backend chooses by capability.
Layer *string `json:"layer,omitempty"`
// Report Report verbosity: info gives high-level stages, debug routing and translation, trace per-claim detail. Set, and only then, the stream carries one final report record after the last element, typed distinctly from result claims (R-QREPORT).
Report *ExecutionReport `json:"report,omitempty"`
}
Execution Where the query runs and how it reports on itself. These controls reach execution and diagnostics, and never the result set.
type ExecutionReport ¶
type ExecutionReport string
ExecutionReport Report verbosity: info gives high-level stages, debug routing and translation, trace per-claim detail. Set, and only then, the stream carries one final report record after the last element, typed distinctly from result claims (R-QREPORT).
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 ForbiddenJSONResponse ¶
type ForbiddenJSONResponse Error
type GetArchiveClaim200ApplicationcborResponse ¶ added in v1.14.0
type GetArchiveClaim200ApplicationcborResponse struct {
Body io.Reader
Headers GetArchiveClaim200ResponseHeaders
ContentLength int64
}
func (GetArchiveClaim200ApplicationcborResponse) VisitGetArchiveClaimResponse ¶ added in v1.14.0
func (response GetArchiveClaim200ApplicationcborResponse) VisitGetArchiveClaimResponse(w http.ResponseWriter) error
type GetArchiveClaim200ResponseHeaders ¶ added in v1.14.0
type GetArchiveClaim200ResponseHeaders struct {
ETag *string
}
type GetArchiveClaim401JSONResponse ¶ added in v1.14.0
func (GetArchiveClaim401JSONResponse) VisitGetArchiveClaimResponse ¶ added in v1.14.0
func (response GetArchiveClaim401JSONResponse) VisitGetArchiveClaimResponse(w http.ResponseWriter) error
type GetArchiveClaim403JSONResponse ¶ added in v1.14.0
type GetArchiveClaim403JSONResponse struct{ ForbiddenJSONResponse }
func (GetArchiveClaim403JSONResponse) VisitGetArchiveClaimResponse ¶ added in v1.14.0
func (response GetArchiveClaim403JSONResponse) VisitGetArchiveClaimResponse(w http.ResponseWriter) error
type GetArchiveClaim404JSONResponse ¶ added in v1.14.0
type GetArchiveClaim404JSONResponse struct{ NotFoundJSONResponse }
func (GetArchiveClaim404JSONResponse) VisitGetArchiveClaimResponse ¶ added in v1.14.0
func (response GetArchiveClaim404JSONResponse) VisitGetArchiveClaimResponse(w http.ResponseWriter) error
type GetArchiveClaimContent200ApplicationoctetStreamResponse ¶ added in v1.14.0
type GetArchiveClaimContent200ApplicationoctetStreamResponse struct {
Body io.Reader
Headers GetArchiveClaimContent200ResponseHeaders
ContentLength int64
}
func (GetArchiveClaimContent200ApplicationoctetStreamResponse) VisitGetArchiveClaimContentResponse ¶ added in v1.14.0
func (response GetArchiveClaimContent200ApplicationoctetStreamResponse) VisitGetArchiveClaimContentResponse(w http.ResponseWriter) error
type GetArchiveClaimContent200ResponseHeaders ¶ added in v1.14.0
type GetArchiveClaimContent200ResponseHeaders struct {
ETag *string
}
type GetArchiveClaimContent401JSONResponse ¶ added in v1.14.0
func (GetArchiveClaimContent401JSONResponse) VisitGetArchiveClaimContentResponse ¶ added in v1.14.0
func (response GetArchiveClaimContent401JSONResponse) VisitGetArchiveClaimContentResponse(w http.ResponseWriter) error
type GetArchiveClaimContent403JSONResponse ¶ added in v1.14.0
type GetArchiveClaimContent403JSONResponse struct{ ForbiddenJSONResponse }
func (GetArchiveClaimContent403JSONResponse) VisitGetArchiveClaimContentResponse ¶ added in v1.14.0
func (response GetArchiveClaimContent403JSONResponse) VisitGetArchiveClaimContentResponse(w http.ResponseWriter) error
type GetArchiveClaimContent404JSONResponse ¶ added in v1.14.0
type GetArchiveClaimContent404JSONResponse struct{ NotFoundJSONResponse }
func (GetArchiveClaimContent404JSONResponse) VisitGetArchiveClaimContentResponse ¶ added in v1.14.0
func (response GetArchiveClaimContent404JSONResponse) VisitGetArchiveClaimContentResponse(w http.ResponseWriter) error
type GetArchiveClaimContentRequestObject ¶ added in v1.14.0
type GetArchiveClaimContentRequestObject struct {
Id ClaimId `json:"id"`
}
type GetArchiveClaimContentResponseObject ¶ added in v1.14.0
type GetArchiveClaimContentResponseObject interface {
VisitGetArchiveClaimContentResponse(w http.ResponseWriter) error
}
type GetArchiveClaimRequestObject ¶ added in v1.14.0
type GetArchiveClaimRequestObject struct {
Id ClaimId `json:"id"`
}
type GetArchiveClaimResponseObject ¶ added in v1.14.0
type GetArchiveClaimResponseObject interface {
VisitGetArchiveClaimResponse(w http.ResponseWriter) error
}
type GetArchiveInfo200JSONResponse ¶ added in v1.14.0
type GetArchiveInfo200JSONResponse struct {
Body ArchiveInfo
Headers GetArchiveInfo200ResponseHeaders
}
func (GetArchiveInfo200JSONResponse) VisitGetArchiveInfoResponse ¶ added in v1.14.0
func (response GetArchiveInfo200JSONResponse) VisitGetArchiveInfoResponse(w http.ResponseWriter) error
type GetArchiveInfo200ResponseHeaders ¶ added in v1.14.0
type GetArchiveInfo200ResponseHeaders struct {
ETag *string
}
type GetArchiveInfo401JSONResponse ¶ added in v1.14.0
func (GetArchiveInfo401JSONResponse) VisitGetArchiveInfoResponse ¶ added in v1.14.0
func (response GetArchiveInfo401JSONResponse) VisitGetArchiveInfoResponse(w http.ResponseWriter) error
type GetArchiveInfo403JSONResponse ¶ added in v1.14.0
type GetArchiveInfo403JSONResponse struct{ ForbiddenJSONResponse }
func (GetArchiveInfo403JSONResponse) VisitGetArchiveInfoResponse ¶ added in v1.14.0
func (response GetArchiveInfo403JSONResponse) VisitGetArchiveInfoResponse(w http.ResponseWriter) error
type GetArchiveInfoRequestObject ¶ added in v1.14.0
type GetArchiveInfoRequestObject struct {
}
type GetArchiveInfoResponseObject ¶ added in v1.14.0
type GetArchiveInfoResponseObject interface {
VisitGetArchiveInfoResponse(w http.ResponseWriter) 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 ¶
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 ¶
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 ¶
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 GetBranchInfo200JSONResponse ¶ added in v1.14.0
type GetBranchInfo200JSONResponse struct {
Body BranchInfo
Headers GetBranchInfo200ResponseHeaders
}
func (GetBranchInfo200JSONResponse) VisitGetBranchInfoResponse ¶ added in v1.14.0
func (response GetBranchInfo200JSONResponse) VisitGetBranchInfoResponse(w http.ResponseWriter) error
type GetBranchInfo200ResponseHeaders ¶ added in v1.14.0
type GetBranchInfo200ResponseHeaders struct {
ETag *string
}
type GetBranchInfo401JSONResponse ¶ added in v1.14.0
func (GetBranchInfo401JSONResponse) VisitGetBranchInfoResponse ¶ added in v1.14.0
func (response GetBranchInfo401JSONResponse) VisitGetBranchInfoResponse(w http.ResponseWriter) error
type GetBranchInfo403JSONResponse ¶ added in v1.14.0
type GetBranchInfo403JSONResponse struct{ ForbiddenJSONResponse }
func (GetBranchInfo403JSONResponse) VisitGetBranchInfoResponse ¶ added in v1.14.0
func (response GetBranchInfo403JSONResponse) VisitGetBranchInfoResponse(w http.ResponseWriter) error
type GetBranchInfo404JSONResponse ¶ added in v1.14.0
type GetBranchInfo404JSONResponse struct{ NotFoundJSONResponse }
func (GetBranchInfo404JSONResponse) VisitGetBranchInfoResponse ¶ added in v1.14.0
func (response GetBranchInfo404JSONResponse) VisitGetBranchInfoResponse(w http.ResponseWriter) error
type GetBranchInfoRequestObject ¶ added in v1.14.0
type GetBranchInfoRequestObject struct {
Branch BranchName `json:"branch"`
}
type GetBranchInfoResponseObject ¶ added in v1.14.0
type GetBranchInfoResponseObject interface {
VisitGetBranchInfoResponse(w http.ResponseWriter) error
}
type GetClaim200ApplicationcborResponse ¶ added in v1.14.0
type GetClaim200ApplicationcborResponse struct {
Body io.Reader
Headers GetClaim200ResponseHeaders
ContentLength int64
}
func (GetClaim200ApplicationcborResponse) VisitGetClaimResponse ¶ added in v1.14.0
func (response GetClaim200ApplicationcborResponse) VisitGetClaimResponse(w http.ResponseWriter) error
type GetClaim200ResponseHeaders ¶ added in v1.14.0
type GetClaim200ResponseHeaders struct {
ETag *string
}
type GetClaim401JSONResponse ¶ added in v1.14.0
func (GetClaim401JSONResponse) VisitGetClaimResponse ¶ added in v1.14.0
func (response GetClaim401JSONResponse) VisitGetClaimResponse(w http.ResponseWriter) error
type GetClaim403JSONResponse ¶ added in v1.14.0
type GetClaim403JSONResponse struct{ ForbiddenJSONResponse }
func (GetClaim403JSONResponse) VisitGetClaimResponse ¶ added in v1.14.0
func (response GetClaim403JSONResponse) VisitGetClaimResponse(w http.ResponseWriter) error
type GetClaim404JSONResponse ¶ added in v1.14.0
type GetClaim404JSONResponse struct{ NotFoundJSONResponse }
func (GetClaim404JSONResponse) VisitGetClaimResponse ¶ added in v1.14.0
func (response GetClaim404JSONResponse) VisitGetClaimResponse(w http.ResponseWriter) error
type GetClaimContent200ApplicationoctetStreamResponse ¶ added in v1.14.0
type GetClaimContent200ApplicationoctetStreamResponse struct {
Body io.Reader
Headers GetClaimContent200ResponseHeaders
ContentLength int64
}
func (GetClaimContent200ApplicationoctetStreamResponse) VisitGetClaimContentResponse ¶ added in v1.14.0
func (response GetClaimContent200ApplicationoctetStreamResponse) VisitGetClaimContentResponse(w http.ResponseWriter) error
type GetClaimContent200ResponseHeaders ¶ added in v1.14.0
type GetClaimContent200ResponseHeaders struct {
ETag *string
}
type GetClaimContent401JSONResponse ¶ added in v1.14.0
func (GetClaimContent401JSONResponse) VisitGetClaimContentResponse ¶ added in v1.14.0
func (response GetClaimContent401JSONResponse) VisitGetClaimContentResponse(w http.ResponseWriter) error
type GetClaimContent403JSONResponse ¶ added in v1.14.0
type GetClaimContent403JSONResponse struct{ ForbiddenJSONResponse }
func (GetClaimContent403JSONResponse) VisitGetClaimContentResponse ¶ added in v1.14.0
func (response GetClaimContent403JSONResponse) VisitGetClaimContentResponse(w http.ResponseWriter) error
type GetClaimContent404JSONResponse ¶ added in v1.14.0
type GetClaimContent404JSONResponse struct{ NotFoundJSONResponse }
func (GetClaimContent404JSONResponse) VisitGetClaimContentResponse ¶ added in v1.14.0
func (response GetClaimContent404JSONResponse) VisitGetClaimContentResponse(w http.ResponseWriter) error
type GetClaimContentRequestObject ¶ added in v1.14.0
type GetClaimContentRequestObject struct {
Id ClaimId `json:"id"`
}
type GetClaimContentResponseObject ¶ added in v1.14.0
type GetClaimContentResponseObject interface {
VisitGetClaimContentResponse(w http.ResponseWriter) error
}
type GetClaimRequestObject ¶ added in v1.14.0
type GetClaimRequestObject struct {
Id ClaimId `json:"id"`
}
type GetClaimResponseObject ¶ added in v1.14.0
type GetClaimResponseObject interface {
VisitGetClaimResponse(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 ¶
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 Id ¶
type Id = string
Id A claim id: id(v) = Sign(H(S(v))) for a node, id(e) = H(S(e)) for an edge, carried as multibase base32 of the self-describing payload. The pattern fixes the multibase framing; whether the payload's multihash or multikey framing parses is the implementation's check.
type InvalidParamFormatError ¶
func (*InvalidParamFormatError) Error ¶
func (e *InvalidParamFormatError) Error() string
func (*InvalidParamFormatError) Unwrap ¶
func (e *InvalidParamFormatError) Unwrap() error
type Limit ¶
type Limit struct {
// Results Caps the claim count; 0 is unbounded.
Results *int `json:"results,omitempty"`
// Time A duration as a decimal sequence with unit suffixes — ns, us, ms, s, m, h — e.g. 5s or 1m30s. The bare 0 means unbounded.
Time *Duration `json:"time,omitempty"`
}
Limit Bounds the read. A read cut short by either bound is a complete answer to the query as bounded, not an error (R-QLIMIT).
type ListBranches200JSONResponse ¶ added in v1.14.0
type ListBranches200JSONResponse struct {
Body BranchList
Headers ListBranches200ResponseHeaders
}
func (ListBranches200JSONResponse) VisitListBranchesResponse ¶ added in v1.14.0
func (response ListBranches200JSONResponse) VisitListBranchesResponse(w http.ResponseWriter) error
type ListBranches200ResponseHeaders ¶ added in v1.14.0
type ListBranches200ResponseHeaders struct {
ETag *string
}
type ListBranches401JSONResponse ¶ added in v1.14.0
func (ListBranches401JSONResponse) VisitListBranchesResponse ¶ added in v1.14.0
func (response ListBranches401JSONResponse) VisitListBranchesResponse(w http.ResponseWriter) error
type ListBranches403JSONResponse ¶ added in v1.14.0
type ListBranches403JSONResponse struct{ ForbiddenJSONResponse }
func (ListBranches403JSONResponse) VisitListBranchesResponse ¶ added in v1.14.0
func (response ListBranches403JSONResponse) VisitListBranchesResponse(w http.ResponseWriter) error
type ListBranchesRequestObject ¶ added in v1.14.0
type ListBranchesRequestObject struct {
}
type ListBranchesResponseObject ¶ added in v1.14.0
type ListBranchesResponseObject interface {
VisitListBranchesResponse(w http.ResponseWriter) error
}
type ListStorageLayers200JSONResponse ¶
type ListStorageLayers200JSONResponse StorageLayerList
func (ListStorageLayers200JSONResponse) VisitListStorageLayersResponse ¶
func (response ListStorageLayers200JSONResponse) VisitListStorageLayersResponse(w http.ResponseWriter) error
type ListStorageLayers401JSONResponse ¶
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 ¶
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 NotFoundJSONResponse ¶
type NotFoundJSONResponse Error
type NotImplemented ¶ added in v1.15.0
type NotImplemented = Error
NotImplemented defines model for NotImplemented.
type NotImplementedJSONResponse ¶ added in v1.15.0
type NotImplementedJSONResponse Error
type Order ¶ added in v1.15.0
type Order = []OrderKey
Order Sort keys applied in priority order. Claims lacking a key's field sort last, and the archive's natural (created_at, id) order breaks any remaining ties, so the sort always resolves to a total order (R-QSORT).
type OrderKey ¶
type OrderKey struct {
// Compare How the values compare (R-QSORT).
Compare *OrderKeyCompare `json:"compare,omitempty"`
// Dir Sort direction (R-QSORT).
Dir *OrderKeyDir `json:"dir,omitempty"`
// Field The field sorted on — any field a claim carries, height included.
Field string `json:"field"`
}
OrderKey defines model for OrderKey.
type OrderKeyCompare ¶
type OrderKeyCompare string
OrderKeyCompare How the values compare (R-QSORT).
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 (R-QSORT).
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 (R-QCONTENT).
Content *OutputContent `json:"content,omitempty"`
// Detail What each element carries: id (the id alone) or claims (the claim in full). Under shape: path it applies to every claim in the route (R-QDETAIL).
Detail *OutputDetail `json:"detail,omitempty"`
// Encoding json is text with content base64-encoded, cbor is binary; the same information either way (R-QENCODING).
Encoding *OutputEncoding `json:"encoding,omitempty"`
// Form Which field values a claim carries: original as written, a diff-overlaid claim's delta; materialized with any contribution/diff chain resolved over the predecessor it references, recursively to a base claim. A property of the values, hence orthogonal to detail and encoding (R-QFORM).
Form *OutputForm `json:"form,omitempty"`
// Shape single yields the reached endpoints, one element each; path yields routes, each running outward from the frontier claim its walk began at (R-QSHAPE).
Shape *OutputShape `json:"shape,omitempty"`
}
Output Shapes each result along orthogonal axes. detail: claims with form: original and encoding: cbor reproduces the canonical serialization S(v) a claim's id is computed over, and is the only output form directly verifiable against that id (R-QCANON).
type OutputContent ¶
type OutputContent struct {
// Max Cap in bytes on the content inlined per claim; 0 inlines every claim's content in full.
Max int `json:"max"`
// Overflow What becomes of content past the cap: cutoff inlines the bytes up to it, omit inlines whole values only. Absent, omit. A claim keeps every field it carries either way (R-QCONTENT).
Overflow *OutputContentOverflow `json:"overflow,omitempty"`
}
OutputContent Inline content per claim. Absent, no content is inlined (R-QCONTENT).
type OutputContentOverflow ¶
type OutputContentOverflow string
OutputContentOverflow What becomes of content past the cap: cutoff inlines the bytes up to it, omit inlines whole values only. Absent, omit. A claim keeps every field it carries either way (R-QCONTENT).
const ( Cutoff OutputContentOverflow = "cutoff" Omit OutputContentOverflow = "omit" )
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 What each element carries: id (the id alone) or claims (the claim in full). Under shape: path it applies to every claim in the route (R-QDETAIL).
const ( OutputDetailClaims OutputDetail = "claims" OutputDetailId 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 json is text with content base64-encoded, cbor is binary; the same information either way (R-QENCODING).
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 a claim carries: original as written, a diff-overlaid claim's delta; materialized with any contribution/diff chain resolved over the predecessor it references, recursively to a base claim. A property of the values, hence orthogonal to detail and encoding (R-QFORM).
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 yields the reached endpoints, one element each; path yields routes, each running outward from the frontier claim its walk began at (R-QSHAPE).
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 follows references outward, uses runs to the claims that cite this one, connections either way. Absent, provenance.
Dir *PathStepDir `json:"dir,omitempty"`
// Edges Edge types every hop must match.
Edges *[]TypeGlob `json:"edges,omitempty"`
// Max Most hops. 0, or absent, leaves the step unbounded: a step of at most zero hops would move nothing, so that reading has no use.
Max *int `json:"max,omitempty"`
// Min Fewest hops. Absent, 1 — a step moves at least one hop. 0 also yields the starting set, carrying the frontier through alongside what lies beyond it.
Min *int `json:"min,omitempty"`
// Nodes Node types the step may yield.
Nodes *[]TypeGlob `json:"nodes,omitempty"`
}
PathStep One section of a path. edges bounds the walk: every hop must follow an edge whose type is listed. nodes bounds the answer: a step yields a claim only when its node's type is listed, whatever the nodes it crossed to reach it. min and max bound the hops. A min above a bounded max is refused by the implementation — a JSON Schema cannot compare two sibling values (R-QSTEPS).
type PathStepDir ¶
type PathStepDir string
PathStepDir provenance follows references outward, uses runs to the claims that cite this one, connections either way. Absent, provenance.
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. These controls reach execution and diagnostics, and never the result set.
Execution *Execution `json:"execution,omitempty"`
// Limit Bounds the read. A read cut short by either bound is a complete answer to the query as bounded, not an error (R-QLIMIT).
Limit *Limit `json:"limit,omitempty"`
// Order Sort keys applied in priority order. Claims lacking a key's field sort last, and the archive's natural (created_at, id) order breaks any remaining ties, so the sort always resolves to a total order (R-QSORT).
Order *Order `json:"order,omitempty"`
// Output Shapes each result along orthogonal axes. detail: claims with form: original and encoding: cbor reproduces the canonical serialization S(v) a claim's id is computed over, and is the only output form directly verifiable against that id (R-QCANON).
Output *Output `json:"output,omitempty"`
// Select A generator in four independent parts: branch is the scope, head the closure read, claim where the walk starts, 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 the closure 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, height included (V-HEIGHT).
Where *Where `json:"where,omitempty"`
}
Query A read, evaluated in a fixed logical order: select generates the result set, where filters it, order sorts it, limit truncates it, output shapes and encodes each surviving claim (R-QEVAL).
type Query200ApplicationcborSeqResponse ¶
func (Query200ApplicationcborSeqResponse) VisitQueryResponse ¶
func (response Query200ApplicationcborSeqResponse) VisitQueryResponse(w http.ResponseWriter) error
type Query200ApplicationjsonSeqResponse ¶
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 ¶
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 ¶
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, and every scope names a graph: a branch name confines to that branch, $archive to the whole Ranke-Archive, $universe applies no confinement and is privileged. An empty value is refused (R-QSCOPE).
Branch string `json:"branch"`
// Claim A claim id: id(v) = Sign(H(S(v))) for a node, id(e) = H(S(e)) for an edge, carried as multibase base32 of the self-describing payload. The pattern fixes the multibase framing; whether the payload's multihash or multikey framing parses is the implementation's check.
Claim *Id `json:"claim,omitempty"`
// Head A claim id: id(v) = Sign(H(S(v))) for a node, id(e) = H(S(e)) for an edge, carried as multibase base32 of the self-describing payload. The pattern fixes the multibase framing; whether the payload's multihash or multikey framing parses is the implementation's check.
Head *Id `json:"head,omitempty"`
// Path The traversal: a sequence of steps over frontiers, each frontier a set of claims. Each step's yield is the frontier the next starts from, and the no-repeat rule holds within a step and resets at each boundary, so membership is all a frontier carries (R-QFRONTIER). Absent, the generator returns the full outward closure of the frontier (R-QSTEPS).
Path *[]PathStep `json:"path,omitempty"`
}
Select A generator in four independent parts: branch is the scope, head the closure read, claim where the walk starts, 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 the closure 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 {
// GetArchiveClaim Fetch a claim within the archive head's closure
// (GET /archive/claims/{id})
GetArchiveClaim(w http.ResponseWriter, r *http.Request, id ClaimId)
// GetArchiveClaimContent Fetch the content of a claim within the archive head's closure
// (GET /archive/claims/{id}/content)
GetArchiveClaimContent(w http.ResponseWriter, r *http.Request, id ClaimId)
// GetArchiveInfo What is known about the archive
// (GET /archive/info)
GetArchiveInfo(w http.ResponseWriter, r *http.Request)
// ListBranches List the branch table's branches
// (GET /branches)
ListBranches(w http.ResponseWriter, r *http.Request)
// GetBranchClaim Fetch a claim within a branch's closure
// (GET /branches/{branch}/claims/{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 /branches/{branch}/claims/{id}/content)
GetBranchClaimContent(w http.ResponseWriter, r *http.Request, branch BranchName, id ClaimId)
// GetBranchHead Current head id of a branch
// (GET /branches/{branch}/head)
GetBranchHead(w http.ResponseWriter, r *http.Request, branch BranchName)
// GetBranchInfo What is known about a branch
// (GET /branches/{branch}/info)
GetBranchInfo(w http.ResponseWriter, r *http.Request, branch BranchName)
// Contribute Contribute signed claims (atomic)
// (POST /contribute)
Contribute(w http.ResponseWriter, r *http.Request)
// AdvanceDevClock Advance the dev sequencer's clock
// (POST /dev/clock)
AdvanceDevClock(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/verifications)
ListVerifications(w http.ResponseWriter, r *http.Request)
// StartVerification Start a verification run
// (POST /system/verifications)
StartVerification(w http.ResponseWriter, r *http.Request)
// DeleteVerification Delete a verification run
// (DELETE /system/verifications/{reportId})
DeleteVerification(w http.ResponseWriter, r *http.Request, reportId string)
// GetVerification Show a verification run
// (GET /system/verifications/{reportId})
GetVerification(w http.ResponseWriter, r *http.Request, reportId string)
// CancelVerification Cancel a running verification run
// (POST /system/verifications/{reportId}/cancel)
CancelVerification(w http.ResponseWriter, r *http.Request, reportId string)
// GetClaim Fetch a claim by id from the Universe (privileged)
// (GET /universe/claims/{id})
GetClaim(w http.ResponseWriter, r *http.Request, id ClaimId)
// GetClaimContent Fetch the content of a claim by id from the Universe (privileged)
// (GET /universe/claims/{id}/content)
GetClaimContent(w http.ResponseWriter, r *http.Request, id ClaimId)
}
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) AdvanceDevClock ¶ added in v1.15.0
func (siw *ServerInterfaceWrapper) AdvanceDevClock(w http.ResponseWriter, r *http.Request)
AdvanceDevClock operation middleware
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) GetArchiveClaim ¶ added in v1.14.0
func (siw *ServerInterfaceWrapper) GetArchiveClaim(w http.ResponseWriter, r *http.Request)
GetArchiveClaim operation middleware
func (*ServerInterfaceWrapper) GetArchiveClaimContent ¶ added in v1.14.0
func (siw *ServerInterfaceWrapper) GetArchiveClaimContent(w http.ResponseWriter, r *http.Request)
GetArchiveClaimContent operation middleware
func (*ServerInterfaceWrapper) GetArchiveInfo ¶ added in v1.14.0
func (siw *ServerInterfaceWrapper) GetArchiveInfo(w http.ResponseWriter, r *http.Request)
GetArchiveInfo 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) GetBranchInfo ¶ added in v1.14.0
func (siw *ServerInterfaceWrapper) GetBranchInfo(w http.ResponseWriter, r *http.Request)
GetBranchInfo operation middleware
func (*ServerInterfaceWrapper) GetClaim ¶ added in v1.14.0
func (siw *ServerInterfaceWrapper) GetClaim(w http.ResponseWriter, r *http.Request)
GetClaim operation middleware
func (*ServerInterfaceWrapper) GetClaimContent ¶ added in v1.14.0
func (siw *ServerInterfaceWrapper) GetClaimContent(w http.ResponseWriter, r *http.Request)
GetClaimContent operation middleware
func (*ServerInterfaceWrapper) GetVerification ¶
func (siw *ServerInterfaceWrapper) GetVerification(w http.ResponseWriter, r *http.Request)
GetVerification operation middleware
func (*ServerInterfaceWrapper) Health ¶
func (siw *ServerInterfaceWrapper) Health(w http.ResponseWriter, r *http.Request)
Health operation middleware
func (*ServerInterfaceWrapper) ListBranches ¶ added in v1.14.0
func (siw *ServerInterfaceWrapper) ListBranches(w http.ResponseWriter, r *http.Request)
ListBranches 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 ¶
func (siw *ServerInterfaceWrapper) Query(w http.ResponseWriter, r *http.Request)
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 StartVerification400JSONResponse ¶
type StartVerification400JSONResponse struct{ BadRequestJSONResponse }
func (StartVerification400JSONResponse) VisitStartVerificationResponse ¶
func (response StartVerification400JSONResponse) VisitStartVerificationResponse(w http.ResponseWriter) error
type StartVerification401JSONResponse ¶
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 StrictMiddlewareFunc ¶
type StrictMiddlewareFunc func(f StrictHandlerFunc, operationID string) StrictHandlerFunc
type StrictServerInterface ¶
type StrictServerInterface interface {
// GetArchiveClaim Fetch a claim within the archive head's closure
// (GET /archive/claims/{id})
GetArchiveClaim(ctx context.Context, request GetArchiveClaimRequestObject) (GetArchiveClaimResponseObject, error)
// GetArchiveClaimContent Fetch the content of a claim within the archive head's closure
// (GET /archive/claims/{id}/content)
GetArchiveClaimContent(ctx context.Context, request GetArchiveClaimContentRequestObject) (GetArchiveClaimContentResponseObject, error)
// GetArchiveInfo What is known about the archive
// (GET /archive/info)
GetArchiveInfo(ctx context.Context, request GetArchiveInfoRequestObject) (GetArchiveInfoResponseObject, error)
// ListBranches List the branch table's branches
// (GET /branches)
ListBranches(ctx context.Context, request ListBranchesRequestObject) (ListBranchesResponseObject, error)
// GetBranchClaim Fetch a claim within a branch's closure
// (GET /branches/{branch}/claims/{id})
GetBranchClaim(ctx context.Context, request GetBranchClaimRequestObject) (GetBranchClaimResponseObject, error)
// GetBranchClaimContent Fetch the content of a claim within a branch's closure
// (GET /branches/{branch}/claims/{id}/content)
GetBranchClaimContent(ctx context.Context, request GetBranchClaimContentRequestObject) (GetBranchClaimContentResponseObject, error)
// GetBranchHead Current head id of a branch
// (GET /branches/{branch}/head)
GetBranchHead(ctx context.Context, request GetBranchHeadRequestObject) (GetBranchHeadResponseObject, error)
// GetBranchInfo What is known about a branch
// (GET /branches/{branch}/info)
GetBranchInfo(ctx context.Context, request GetBranchInfoRequestObject) (GetBranchInfoResponseObject, error)
// Contribute Contribute signed claims (atomic)
// (POST /contribute)
Contribute(ctx context.Context, request ContributeRequestObject) (ContributeResponseObject, error)
// AdvanceDevClock Advance the dev sequencer's clock
// (POST /dev/clock)
AdvanceDevClock(ctx context.Context, request AdvanceDevClockRequestObject) (AdvanceDevClockResponseObject, 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/verifications)
ListVerifications(ctx context.Context, request ListVerificationsRequestObject) (ListVerificationsResponseObject, error)
// StartVerification Start a verification run
// (POST /system/verifications)
StartVerification(ctx context.Context, request StartVerificationRequestObject) (StartVerificationResponseObject, error)
// DeleteVerification Delete a verification run
// (DELETE /system/verifications/{reportId})
DeleteVerification(ctx context.Context, request DeleteVerificationRequestObject) (DeleteVerificationResponseObject, error)
// GetVerification Show a verification run
// (GET /system/verifications/{reportId})
GetVerification(ctx context.Context, request GetVerificationRequestObject) (GetVerificationResponseObject, error)
// CancelVerification Cancel a running verification run
// (POST /system/verifications/{reportId}/cancel)
CancelVerification(ctx context.Context, request CancelVerificationRequestObject) (CancelVerificationResponseObject, error)
// GetClaim Fetch a claim by id from the Universe (privileged)
// (GET /universe/claims/{id})
GetClaim(ctx context.Context, request GetClaimRequestObject) (GetClaimResponseObject, error)
// GetClaimContent Fetch the content of a claim by id from the Universe (privileged)
// (GET /universe/claims/{id}/content)
GetClaimContent(ctx context.Context, request GetClaimContentRequestObject) (GetClaimContentResponseObject, error)
}
StrictServerInterface represents all server handlers.
type TooManyValuesForParamError ¶
func (*TooManyValuesForParamError) Error ¶
func (e *TooManyValuesForParamError) Error() string
type TypeGlob ¶ added in v1.15.0
type TypeGlob = string
TypeGlob A glob over class/sub, e.g. derivation/* or entity/person. A leading - excludes. Exclusion decides: a type matching an excluded pattern is refused whatever the included patterns say, and a list of exclusions alone admits every other type (R-QSTEPS).
type UnauthorizedJSONResponse ¶
type UnauthorizedJSONResponse Error
type UnescapedCookieParamError ¶
func (*UnescapedCookieParamError) Error ¶
func (e *UnescapedCookieParamError) Error() string
func (*UnescapedCookieParamError) Unwrap ¶
func (e *UnescapedCookieParamError) Unwrap() error
type UnmarshalingParamError ¶
func (*UnmarshalingParamError) Error ¶
func (e *UnmarshalingParamError) Error() string
func (*UnmarshalingParamError) Unwrap ¶
func (e *UnmarshalingParamError) Unwrap() error
type Value ¶ added in v1.15.0
type Value = interface{}
Value A value a comparison tests against. How two values compare is the engine's, so the shape is unconstrained here.
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, height included (V-HEIGHT).
func (*Where) FromWhere0 ¶
FromWhere0 overwrites any union data inside the Where as the provided Where0
func (*Where) FromWhere1 ¶
FromWhere1 overwrites any union data inside the Where as the provided Where1
func (*Where) FromWhere2 ¶
FromWhere2 overwrites any union data inside the Where as the provided Where2
func (*Where) FromWhere3 ¶
FromWhere3 overwrites any union data inside the Where as the provided Where3
func (Where) MarshalJSON ¶
func (*Where) MergeWhere0 ¶
MergeWhere0 performs a merge with any union data inside the Where, using the provided Where0
func (*Where) MergeWhere1 ¶
MergeWhere1 performs a merge with any union data inside the Where, using the provided Where1
func (*Where) MergeWhere2 ¶
MergeWhere2 performs a merge with any union data inside the Where, using the provided Where2
func (*Where) MergeWhere3 ¶
MergeWhere3 performs a merge with any union data inside the Where, using the provided Where3
func (*Where) UnmarshalJSON ¶
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, height included (V-HEIGHT).
Not Where `json:"not"`
}
Where2 defines model for Where.2.
type Where3 ¶
type Where3 struct {
// Field The field tested — any field a claim carries, height included.
Field string `json:"field"`
// Test One operator applied to one field. eq, ne, lt, le, gt and ge take a value, in a set, glob a shell-style wildcard. Exactly one is present.
Test Comparison `json:"test"`
}
Where3 A leaf: one field, one comparison.