Documentation
¶
Overview ¶
Package apigen 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 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
- type ApplyRef200JSONResponse
- type ApplyRef401JSONResponse
- type ApplyRef403JSONResponse
- type ApplyRef404JSONResponse
- type ApplyRef422JSONResponse
- type ApplyRefJSONRequestBody
- type ApplyRefRequestObject
- type ApplyRefResponseObject
- type ApplyRequest
- type BadRequest
- type BadRequestJSONResponse
- type Change
- type ChangeOp
- type Conflict
- type ConflictJSONResponse
- type ConflictResponse
- type DeleteGoal204Response
- type DeleteGoal401JSONResponse
- type DeleteGoal403JSONResponse
- type DeleteGoal404JSONResponse
- type DeleteGoal422JSONResponse
- type DeleteGoalJSONRequestBody
- type DeleteGoalRequest
- type DeleteGoalRequestObject
- type DeleteGoalResponseObject
- type DeleteManifest204Response
- type DeleteManifest401JSONResponse
- type DeleteManifest403JSONResponse
- type DeleteManifest404JSONResponse
- type DeleteManifest422JSONResponse
- type DeleteManifestJSONRequestBody
- type DeleteManifestRequestObject
- type DeleteManifestResponseObject
- type DeleteRequest
- type DiffManifest200JSONResponse
- type DiffManifest401JSONResponse
- type DiffManifest403JSONResponse
- type DiffManifest404JSONResponse
- type DiffManifestParams
- type DiffManifestRequestObject
- type DiffManifestResponseObject
- type DiscardWorking204Response
- type DiscardWorking401JSONResponse
- type DiscardWorking403JSONResponse
- type DiscardWorking422JSONResponse
- type DiscardWorkingRequestObject
- type DiscardWorkingResponseObject
- type Exclusion
- type Forbidden
- type ForbiddenJSONResponse
- type GapClaim
- type GapCoverage
- type GapSegmentCoverage
- type GetCharterPdf200ApplicationpdfResponse
- type GetCharterPdf401JSONResponse
- type GetCharterPdf403JSONResponse
- type GetCharterPdf404JSONResponse
- type GetCharterPdf422JSONResponse
- type GetCharterPdfParams
- type GetCharterPdfRequestObject
- type GetCharterPdfResponseObject
- type GetFlow200JSONResponse
- type GetFlow401JSONResponse
- type GetFlow403JSONResponse
- type GetFlow404JSONResponse
- type GetFlowRequestObject
- type GetFlowResponseObject
- type GetGapChecks200JSONResponse
- type GetGapChecks401JSONResponse
- type GetGapChecks403JSONResponse
- type GetGapChecks404JSONResponse
- type GetGapChecksRequestObject
- type GetGapChecksResponseObject
- type GetGapCoverage200JSONResponse
- type GetGapCoverage401JSONResponse
- type GetGapCoverage403JSONResponse
- type GetGapCoverage404JSONResponse
- type GetGapCoverageRequestObject
- type GetGapCoverageResponseObject
- type GetGoalChecks200JSONResponse
- type GetGoalChecks401JSONResponse
- type GetGoalChecks403JSONResponse
- type GetGoalChecks404JSONResponse
- type GetGoalChecksRequestObject
- type GetGoalChecksResponseObject
- type GetGoalTree200JSONResponse
- type GetGoalTree401JSONResponse
- type GetGoalTree403JSONResponse
- type GetGoalTreeRequestObject
- type GetGoalTreeResponseObject
- type GetHealth200JSONResponse
- type GetHealth401JSONResponse
- type GetHealth403JSONResponse
- type GetHealthRequestObject
- type GetHealthResponseObject
- type GetManifest200JSONResponse
- type GetManifest401JSONResponse
- type GetManifest403JSONResponse
- type GetManifest404JSONResponse
- type GetManifestRequestObject
- type GetManifestResponseObject
- type GetOperationCharterHtml200TexthtmlResponse
- type GetOperationCharterHtml401JSONResponse
- type GetOperationCharterHtml403JSONResponse
- type GetOperationCharterHtml404JSONResponse
- type GetOperationCharterHtmlRequestObject
- type GetOperationCharterHtmlResponseObject
- type GetOperationChecks200JSONResponse
- type GetOperationChecks401JSONResponse
- type GetOperationChecks403JSONResponse
- type GetOperationChecks404JSONResponse
- type GetOperationChecksRequestObject
- type GetOperationChecksResponseObject
- type GetPresenceDocument200JSONResponse
- type GetPresenceDocument401JSONResponse
- type GetPresenceDocument403JSONResponse
- type GetPresenceDocumentRequestObject
- type GetPresenceDocumentResponseObject
- type GetProgrammeCharterHtml200TexthtmlResponse
- type GetProgrammeCharterHtml401JSONResponse
- type GetProgrammeCharterHtml403JSONResponse
- type GetProgrammeCharterHtml404JSONResponse
- type GetProgrammeCharterHtmlRequestObject
- type GetProgrammeCharterHtmlResponseObject
- type GetProgrammeChecks200JSONResponse
- type GetProgrammeChecks401JSONResponse
- type GetProgrammeChecks403JSONResponse
- type GetProgrammeChecks404JSONResponse
- type GetProgrammeChecksRequestObject
- type GetProgrammeChecksResponseObject
- type GetProjectCharterHtml200TexthtmlResponse
- type GetProjectCharterHtml401JSONResponse
- type GetProjectCharterHtml403JSONResponse
- type GetProjectCharterHtml404JSONResponse
- type GetProjectCharterHtmlParams
- type GetProjectCharterHtmlRequestObject
- type GetProjectCharterHtmlResponseObject
- type GetProjectChecks200JSONResponse
- type GetProjectChecks401JSONResponse
- type GetProjectChecks403JSONResponse
- type GetProjectChecks404JSONResponse
- type GetProjectChecksRequestObject
- type GetProjectChecksResponseObject
- type GetProjectState200JSONResponse
- type GetProjectState401JSONResponse
- type GetProjectState403JSONResponse
- type GetProjectState404JSONResponse
- type GetProjectStateRequestObject
- type GetProjectStateResponseObject
- type GetReferences200JSONResponse
- type GetReferences401JSONResponse
- type GetReferences403JSONResponse
- type GetReferences404JSONResponse
- type GetReferencesRequestObject
- type GetReferencesResponseObject
- type GetSchema200JSONResponse
- type GetSchema401JSONResponse
- type GetSchema403JSONResponse
- type GetSchema404JSONResponse
- type GetSchemaRequestObject
- type GetSchemaResponseObject
- type GetSession200JSONResponse
- type GetSession401JSONResponse
- type GetSessionRequestObject
- type GetSessionResponseObject
- type GetSettings200JSONResponse
- type GetSettings401JSONResponse
- type GetSettings403JSONResponse
- type GetSettingsRequestObject
- type GetSettingsResponseObject
- type GetSharedDocument200JSONResponse
- type GetSharedDocument401JSONResponse
- type GetSharedDocument403JSONResponse
- type GetSharedDocument404JSONResponse
- type GetSharedDocumentRequestObject
- type GetSharedDocumentResponseObject
- type GetVault200JSONResponse
- type GetVault400JSONResponse
- type GetVault401JSONResponse
- type GetVault403JSONResponse
- type GetVaultRequestObject
- type GetVaultResponseObject
- type GetVersion200JSONResponse
- type GetVersion401JSONResponse
- type GetVersion403JSONResponse
- type GetVersion404JSONResponse
- type GetVersionRequestObject
- type GetVersionResponseObject
- type GetWorking200JSONResponse
- type GetWorking401JSONResponse
- type GetWorking403JSONResponse
- type GetWorking404JSONResponse
- type GetWorkingRequestObject
- type GetWorkingResponseObject
- type GoalAligned
- type GoalCheck
- type GoalCheckFix
- type GoalCheckState
- type GoalNode
- type GoalTree
- type Health
- type IdParam
- type InvalidParamFormatError
- type KindCount
- type KindParam
- type ListExcluded200JSONResponse
- type ListExcluded401JSONResponse
- type ListExcluded403JSONResponse
- type ListExcludedRequestObject
- type ListExcludedResponseObject
- type ListFlows200JSONResponse
- type ListFlows401JSONResponse
- type ListFlows403JSONResponse
- type ListFlowsRequestObject
- type ListFlowsResponseObject
- type ListKinds200JSONResponse
- type ListKinds401JSONResponse
- type ListKinds403JSONResponse
- type ListKindsRequestObject
- type ListKindsResponseObject
- type ListManifests200JSONResponse
- type ListManifests200JSONResponseBody
- func (t ListManifests200JSONResponseBody) AsListManifests200JSONResponseBody0() (ListManifests200JSONResponseBody0, error)
- func (t ListManifests200JSONResponseBody) AsManifestList() (ManifestList, error)
- func (t *ListManifests200JSONResponseBody) FromListManifests200JSONResponseBody0(v ListManifests200JSONResponseBody0) error
- func (t *ListManifests200JSONResponseBody) FromManifestList(v ManifestList) error
- func (t ListManifests200JSONResponseBody) MarshalJSON() ([]byte, error)
- func (t *ListManifests200JSONResponseBody) MergeListManifests200JSONResponseBody0(v ListManifests200JSONResponseBody0) error
- func (t *ListManifests200JSONResponseBody) MergeManifestList(v ManifestList) error
- func (t *ListManifests200JSONResponseBody) UnmarshalJSON(b []byte) error
- type ListManifests200JSONResponseBody0
- type ListManifests401JSONResponse
- type ListManifests403JSONResponse
- type ListManifests404JSONResponse
- type ListManifestsParams
- type ListManifestsParamsExpand
- type ListManifestsRequestObject
- type ListManifestsResponseObject
- type ListSnapshots200JSONResponse
- type ListSnapshots400JSONResponse
- type ListSnapshots401JSONResponse
- type ListSnapshots403JSONResponse
- type ListSnapshotsParams
- type ListSnapshotsRequestObject
- type ListSnapshotsResponseObject
- type ListUnapplied200JSONResponse
- type ListUnapplied401JSONResponse
- type ListUnapplied403JSONResponse
- type ListUnappliedRequestObject
- type ListUnappliedResponseObject
- type ListVersions200JSONResponse
- type ListVersions401JSONResponse
- type ListVersions403JSONResponse
- type ListVersions404JSONResponse
- type ListVersionsRequestObject
- type ListVersionsResponseObject
- type Manifest
- type ManifestDraft
- type ManifestList
- type ManifestRef
- type ManifestView
- type MiddlewareFunc
- type NotFound
- type NotFoundJSONResponse
- type PostSnapshot200JSONResponse
- type PostSnapshot401JSONResponse
- type PostSnapshot403JSONResponse
- type PostSnapshot404JSONResponse
- type PostSnapshot422JSONResponse
- type PostSnapshotJSONBody
- type PostSnapshotJSONRequestBody
- type PostSnapshotRequestObject
- type PostSnapshotResponseObject
- type Problem
- type ProblemList
- type ProgrammeCheck
- type ProgrammeCheckState
- type ProjectCheckFix
- type ProjectCheckFixPhase
- type ProjectCheckItem
- type ProjectCheckItemPhase
- type ProjectCheckState
- type ProjectChecks
- type ProjectState
- type ProjectStateEntry
- type ProjectStateName
- type ProjectStateTransitionRequest
- type PutManifest200JSONResponse
- type PutManifest400JSONResponse
- type PutManifest401JSONResponse
- type PutManifest403JSONResponse
- type PutManifest404JSONResponse
- type PutManifest409JSONResponse
- type PutManifest422JSONResponse
- type PutManifestJSONRequestBody
- type PutManifestRequestObject
- type PutManifestResponseObject
- type PutWorking204Response
- type PutWorking400JSONResponse
- type PutWorking401JSONResponse
- type PutWorking403JSONResponse
- type PutWorking404JSONResponse
- type PutWorking409JSONResponse
- type PutWorking422JSONResponse
- type PutWorkingJSONBody
- type PutWorkingJSONRequestBody
- type PutWorkingRequestObject
- type PutWorkingResponseObject
- type RecoverRef200JSONResponse
- type RecoverRef401JSONResponse
- type RecoverRef403JSONResponse
- type RecoverRef404JSONResponse
- type RecoverRef422JSONResponse
- type RecoverRefJSONRequestBody
- type RecoverRefRequestObject
- type RecoverRefResponseObject
- type RecoverRequest
- type Ref
- type References
- type RequiredHeaderError
- type RequiredParamError
- type ServeMux
- type ServerInterface
- type ServerInterfaceWrapper
- func (siw *ServerInterfaceWrapper) ApplyRef(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) DeleteGoal(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) DeleteManifest(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) DiffManifest(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) DiscardWorking(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetCharterPdf(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetFlow(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetGapChecks(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetGapCoverage(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetGoalChecks(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetGoalTree(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetHealth(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetManifest(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetOperationCharterHtml(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetOperationChecks(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetPresenceDocument(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetProgrammeCharterHtml(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetProgrammeChecks(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetProjectCharterHtml(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetProjectChecks(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetProjectState(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetReferences(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetSchema(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetSession(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetSettings(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetSharedDocument(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetVault(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetVersion(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) GetWorking(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListExcluded(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListFlows(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListKinds(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListManifests(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListSnapshots(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListUnapplied(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ListVersions(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) PostSnapshot(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) PutManifest(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) PutWorking(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) RecoverRef(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) Sync(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) TransitionProjectState(w http.ResponseWriter, r *http.Request)
- func (siw *ServerInterfaceWrapper) ValidateManifest(w http.ResponseWriter, r *http.Request)
- type Session
- type Settings
- type SharedDocument
- type Snapshot
- type SnapshotList
- type StdHTTPServerOptions
- type StrictHTTPServerOptions
- type StrictHandlerFunc
- type StrictMiddlewareFunc
- type StrictServerInterface
- type Summary
- type Sync101Response
- type Sync401JSONResponse
- type Sync403JSONResponse
- type Sync426Response
- type SyncRequestObject
- type SyncResponseObject
- type TooManyValuesForParamError
- type TransitionProjectState200JSONResponse
- type TransitionProjectState401JSONResponse
- type TransitionProjectState403JSONResponse
- type TransitionProjectState404JSONResponse
- type TransitionProjectState422JSONResponse
- type TransitionProjectStateJSONRequestBody
- type TransitionProjectStateRequestObject
- type TransitionProjectStateResponseObject
- type Unauthenticated
- type UnauthenticatedJSONResponse
- type UnescapedCookieParamError
- type UnmarshalingParamError
- type Unprocessable
- type UnprocessableJSONResponse
- type ValidateManifest200JSONResponse
- type ValidateManifest400JSONResponse
- type ValidateManifest401JSONResponse
- type ValidateManifest403JSONResponse
- type ValidateManifest404JSONResponse
- type ValidateManifestJSONRequestBody
- type ValidateManifestRequestObject
- type ValidateManifestResponseObject
- type ValidateRequest
- type Vault
- type Version
- type WriteRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
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 ApplyRef200JSONResponse ¶
type ApplyRef200JSONResponse Vault
func (ApplyRef200JSONResponse) VisitApplyRefResponse ¶
func (response ApplyRef200JSONResponse) VisitApplyRefResponse(w http.ResponseWriter) error
type ApplyRef401JSONResponse ¶
type ApplyRef401JSONResponse struct{ UnauthenticatedJSONResponse }
func (ApplyRef401JSONResponse) VisitApplyRefResponse ¶
func (response ApplyRef401JSONResponse) VisitApplyRefResponse(w http.ResponseWriter) error
type ApplyRef403JSONResponse ¶
type ApplyRef403JSONResponse struct{ ForbiddenJSONResponse }
func (ApplyRef403JSONResponse) VisitApplyRefResponse ¶
func (response ApplyRef403JSONResponse) VisitApplyRefResponse(w http.ResponseWriter) error
type ApplyRef404JSONResponse ¶
type ApplyRef404JSONResponse struct{ NotFoundJSONResponse }
func (ApplyRef404JSONResponse) VisitApplyRefResponse ¶
func (response ApplyRef404JSONResponse) VisitApplyRefResponse(w http.ResponseWriter) error
type ApplyRef422JSONResponse ¶
type ApplyRef422JSONResponse struct{ UnprocessableJSONResponse }
func (ApplyRef422JSONResponse) VisitApplyRefResponse ¶
func (response ApplyRef422JSONResponse) VisitApplyRefResponse(w http.ResponseWriter) error
type ApplyRefJSONRequestBody ¶
type ApplyRefJSONRequestBody = ApplyRequest
ApplyRefJSONRequestBody defines body for ApplyRef for application/json ContentType.
type ApplyRefRequestObject ¶
type ApplyRefRequestObject struct {
Body *ApplyRefJSONRequestBody
}
type ApplyRefResponseObject ¶
type ApplyRefResponseObject interface {
VisitApplyRefResponse(w http.ResponseWriter) error
}
type ApplyRequest ¶
type ApplyRequest struct {
// Ref One reference to include (Kind/id).
Ref *string `json:"ref,omitempty"`
// Refs Several references in one call. Applying a hundred files one request at a time reread and rewrote vault.yaml a hundred times, which is quadratic in the number of files and is why it felt slow; one call reads and writes once. Exactly one of ref or refs.
Refs *[]string `json:"refs,omitempty"`
}
ApplyRequest defines model for ApplyRequest.
type BadRequestJSONResponse ¶
type BadRequestJSONResponse ProblemList
type Change ¶
type Change struct {
From interface{} `json:"from,omitempty"`
Op ChangeOp `json:"op"`
Path string `json:"path"`
To interface{} `json:"to,omitempty"`
}
Change defines model for Change.
type ChangeOp ¶
type ChangeOp string
ChangeOp defines model for Change.Op.
Defines values for ChangeOp.
type ConflictJSONResponse ¶
type ConflictJSONResponse ConflictResponse
type ConflictResponse ¶
type ConflictResponse struct {
// Ours The YAML text being written
Ours string `json:"ours"`
// Theirs The YAML text currently on disk (vault only)
Theirs string `json:"theirs"`
}
ConflictResponse defines model for ConflictResponse.
type DeleteGoal204Response ¶
type DeleteGoal204Response struct {
}
func (DeleteGoal204Response) VisitDeleteGoalResponse ¶
func (response DeleteGoal204Response) VisitDeleteGoalResponse(w http.ResponseWriter) error
type DeleteGoal401JSONResponse ¶
type DeleteGoal401JSONResponse struct{ UnauthenticatedJSONResponse }
func (DeleteGoal401JSONResponse) VisitDeleteGoalResponse ¶
func (response DeleteGoal401JSONResponse) VisitDeleteGoalResponse(w http.ResponseWriter) error
type DeleteGoal403JSONResponse ¶
type DeleteGoal403JSONResponse struct{ ForbiddenJSONResponse }
func (DeleteGoal403JSONResponse) VisitDeleteGoalResponse ¶
func (response DeleteGoal403JSONResponse) VisitDeleteGoalResponse(w http.ResponseWriter) error
type DeleteGoal404JSONResponse ¶
type DeleteGoal404JSONResponse struct{ NotFoundJSONResponse }
func (DeleteGoal404JSONResponse) VisitDeleteGoalResponse ¶
func (response DeleteGoal404JSONResponse) VisitDeleteGoalResponse(w http.ResponseWriter) error
type DeleteGoal422JSONResponse ¶
type DeleteGoal422JSONResponse ProblemList
func (DeleteGoal422JSONResponse) VisitDeleteGoalResponse ¶
func (response DeleteGoal422JSONResponse) VisitDeleteGoalResponse(w http.ResponseWriter) error
type DeleteGoalJSONRequestBody ¶
type DeleteGoalJSONRequestBody = DeleteGoalRequest
DeleteGoalJSONRequestBody defines body for DeleteGoal for application/json ContentType.
type DeleteGoalRequest ¶
type DeleteGoalRequest struct {
Reason string `json:"reason"`
}
DeleteGoalRequest defines model for DeleteGoalRequest.
type DeleteGoalRequestObject ¶
type DeleteGoalRequestObject struct {
Id IdParam `json:"id"`
Body *DeleteGoalJSONRequestBody
}
type DeleteGoalResponseObject ¶
type DeleteGoalResponseObject interface {
VisitDeleteGoalResponse(w http.ResponseWriter) error
}
type DeleteManifest204Response ¶
type DeleteManifest204Response struct {
}
func (DeleteManifest204Response) VisitDeleteManifestResponse ¶
func (response DeleteManifest204Response) VisitDeleteManifestResponse(w http.ResponseWriter) error
type DeleteManifest401JSONResponse ¶
type DeleteManifest401JSONResponse struct{ UnauthenticatedJSONResponse }
func (DeleteManifest401JSONResponse) VisitDeleteManifestResponse ¶
func (response DeleteManifest401JSONResponse) VisitDeleteManifestResponse(w http.ResponseWriter) error
type DeleteManifest403JSONResponse ¶
type DeleteManifest403JSONResponse struct{ ForbiddenJSONResponse }
func (DeleteManifest403JSONResponse) VisitDeleteManifestResponse ¶
func (response DeleteManifest403JSONResponse) VisitDeleteManifestResponse(w http.ResponseWriter) error
type DeleteManifest404JSONResponse ¶
type DeleteManifest404JSONResponse struct{ NotFoundJSONResponse }
func (DeleteManifest404JSONResponse) VisitDeleteManifestResponse ¶
func (response DeleteManifest404JSONResponse) VisitDeleteManifestResponse(w http.ResponseWriter) error
type DeleteManifest422JSONResponse ¶
type DeleteManifest422JSONResponse ProblemList
func (DeleteManifest422JSONResponse) VisitDeleteManifestResponse ¶
func (response DeleteManifest422JSONResponse) VisitDeleteManifestResponse(w http.ResponseWriter) error
type DeleteManifestJSONRequestBody ¶
type DeleteManifestJSONRequestBody = DeleteRequest
DeleteManifestJSONRequestBody defines body for DeleteManifest for application/json ContentType.
type DeleteManifestRequestObject ¶
type DeleteManifestRequestObject struct {
Kind KindParam `json:"kind"`
Id IdParam `json:"id"`
Body *DeleteManifestJSONRequestBody
}
type DeleteManifestResponseObject ¶
type DeleteManifestResponseObject interface {
VisitDeleteManifestResponse(w http.ResponseWriter) error
}
type DeleteRequest ¶
type DeleteRequest struct {
Reason string `json:"reason"`
}
DeleteRequest defines model for DeleteRequest.
type DiffManifest200JSONResponse ¶
type DiffManifest200JSONResponse []Change
func (DiffManifest200JSONResponse) VisitDiffManifestResponse ¶
func (response DiffManifest200JSONResponse) VisitDiffManifestResponse(w http.ResponseWriter) error
type DiffManifest401JSONResponse ¶
type DiffManifest401JSONResponse struct{ UnauthenticatedJSONResponse }
func (DiffManifest401JSONResponse) VisitDiffManifestResponse ¶
func (response DiffManifest401JSONResponse) VisitDiffManifestResponse(w http.ResponseWriter) error
type DiffManifest403JSONResponse ¶
type DiffManifest403JSONResponse struct{ ForbiddenJSONResponse }
func (DiffManifest403JSONResponse) VisitDiffManifestResponse ¶
func (response DiffManifest403JSONResponse) VisitDiffManifestResponse(w http.ResponseWriter) error
type DiffManifest404JSONResponse ¶
type DiffManifest404JSONResponse struct{ NotFoundJSONResponse }
func (DiffManifest404JSONResponse) VisitDiffManifestResponse ¶
func (response DiffManifest404JSONResponse) VisitDiffManifestResponse(w http.ResponseWriter) error
type DiffManifestParams ¶
DiffManifestParams defines parameters for DiffManifest.
type DiffManifestRequestObject ¶
type DiffManifestRequestObject struct {
Kind KindParam `json:"kind"`
Id IdParam `json:"id"`
Params DiffManifestParams
}
type DiffManifestResponseObject ¶
type DiffManifestResponseObject interface {
VisitDiffManifestResponse(w http.ResponseWriter) error
}
type DiscardWorking204Response ¶
type DiscardWorking204Response struct {
}
func (DiscardWorking204Response) VisitDiscardWorkingResponse ¶
func (response DiscardWorking204Response) VisitDiscardWorkingResponse(w http.ResponseWriter) error
type DiscardWorking401JSONResponse ¶
type DiscardWorking401JSONResponse struct{ UnauthenticatedJSONResponse }
func (DiscardWorking401JSONResponse) VisitDiscardWorkingResponse ¶
func (response DiscardWorking401JSONResponse) VisitDiscardWorkingResponse(w http.ResponseWriter) error
type DiscardWorking403JSONResponse ¶
type DiscardWorking403JSONResponse struct{ ForbiddenJSONResponse }
func (DiscardWorking403JSONResponse) VisitDiscardWorkingResponse ¶
func (response DiscardWorking403JSONResponse) VisitDiscardWorkingResponse(w http.ResponseWriter) error
type DiscardWorking422JSONResponse ¶
type DiscardWorking422JSONResponse struct{ UnprocessableJSONResponse }
func (DiscardWorking422JSONResponse) VisitDiscardWorkingResponse ¶
func (response DiscardWorking422JSONResponse) VisitDiscardWorkingResponse(w http.ResponseWriter) error
type DiscardWorkingResponseObject ¶
type DiscardWorkingResponseObject interface {
VisitDiscardWorkingResponse(w http.ResponseWriter) error
}
type Exclusion ¶
type Exclusion struct {
// Id Manifest id
Id string `json:"id"`
// Kind Manifest kind
Kind string `json:"kind"`
// Name Manifest name at time of exclusion
Name string `json:"name"`
// On When excluded
On time.Time `json:"on"`
// Reason Reason for exclusion
Reason string `json:"reason"`
}
Exclusion defines model for Exclusion.
type ForbiddenJSONResponse ¶
type ForbiddenJSONResponse ProblemList
type GapClaim ¶
type GapClaim struct {
Id string `json:"id"`
Kind string `json:"kind"`
Name string `json:"name"`
Segments *[]string `json:"segments,omitempty"`
// Whole The citation named no segments, so it claims the whole gap.
Whole bool `json:"whole"`
}
GapClaim defines model for GapClaim.
type GapCoverage ¶
type GapCoverage struct {
Gap string `json:"gap"`
Segments []GapSegmentCoverage `json:"segments"`
// Whole Citations that named no segments.
Whole *[]GapClaim `json:"whole,omitempty"`
}
GapCoverage defines model for GapCoverage.
type GapSegmentCoverage ¶
type GapSegmentCoverage struct {
AddressedBy *[]GapClaim `json:"addressedBy,omitempty"`
Name string `json:"name"`
Segment string `json:"segment"`
}
GapSegmentCoverage defines model for GapSegmentCoverage.
type GetCharterPdf200ApplicationpdfResponse ¶
func (GetCharterPdf200ApplicationpdfResponse) VisitGetCharterPdfResponse ¶
func (response GetCharterPdf200ApplicationpdfResponse) VisitGetCharterPdfResponse(w http.ResponseWriter) error
type GetCharterPdf401JSONResponse ¶
type GetCharterPdf401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetCharterPdf401JSONResponse) VisitGetCharterPdfResponse ¶
func (response GetCharterPdf401JSONResponse) VisitGetCharterPdfResponse(w http.ResponseWriter) error
type GetCharterPdf403JSONResponse ¶
type GetCharterPdf403JSONResponse struct{ ForbiddenJSONResponse }
func (GetCharterPdf403JSONResponse) VisitGetCharterPdfResponse ¶
func (response GetCharterPdf403JSONResponse) VisitGetCharterPdfResponse(w http.ResponseWriter) error
type GetCharterPdf404JSONResponse ¶
type GetCharterPdf404JSONResponse struct{ NotFoundJSONResponse }
func (GetCharterPdf404JSONResponse) VisitGetCharterPdfResponse ¶
func (response GetCharterPdf404JSONResponse) VisitGetCharterPdfResponse(w http.ResponseWriter) error
type GetCharterPdf422JSONResponse ¶
type GetCharterPdf422JSONResponse struct{ UnprocessableJSONResponse }
func (GetCharterPdf422JSONResponse) VisitGetCharterPdfResponse ¶
func (response GetCharterPdf422JSONResponse) VisitGetCharterPdfResponse(w http.ResponseWriter) error
type GetCharterPdfParams ¶
type GetCharterPdfParams struct {
// Working For a project, use the working copy instead of the latest snapshot.
Working *bool `form:"working,omitempty" json:"working,omitempty"`
}
GetCharterPdfParams defines parameters for GetCharterPdf.
type GetCharterPdfRequestObject ¶
type GetCharterPdfRequestObject struct {
Kind KindParam `json:"kind"`
Id IdParam `json:"id"`
Params GetCharterPdfParams
}
type GetCharterPdfResponseObject ¶
type GetCharterPdfResponseObject interface {
VisitGetCharterPdfResponse(w http.ResponseWriter) error
}
type GetFlow200JSONResponse ¶
type GetFlow200JSONResponse map[string]interface{}
func (GetFlow200JSONResponse) VisitGetFlowResponse ¶
func (response GetFlow200JSONResponse) VisitGetFlowResponse(w http.ResponseWriter) error
type GetFlow401JSONResponse ¶
type GetFlow401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetFlow401JSONResponse) VisitGetFlowResponse ¶
func (response GetFlow401JSONResponse) VisitGetFlowResponse(w http.ResponseWriter) error
type GetFlow403JSONResponse ¶
type GetFlow403JSONResponse struct{ ForbiddenJSONResponse }
func (GetFlow403JSONResponse) VisitGetFlowResponse ¶
func (response GetFlow403JSONResponse) VisitGetFlowResponse(w http.ResponseWriter) error
type GetFlow404JSONResponse ¶
type GetFlow404JSONResponse struct{ NotFoundJSONResponse }
func (GetFlow404JSONResponse) VisitGetFlowResponse ¶
func (response GetFlow404JSONResponse) VisitGetFlowResponse(w http.ResponseWriter) error
type GetFlowRequestObject ¶
type GetFlowRequestObject struct {
Kind KindParam `json:"kind"`
}
type GetFlowResponseObject ¶
type GetFlowResponseObject interface {
VisitGetFlowResponse(w http.ResponseWriter) error
}
type GetGapChecks200JSONResponse ¶
type GetGapChecks200JSONResponse []ProgrammeCheck
func (GetGapChecks200JSONResponse) VisitGetGapChecksResponse ¶
func (response GetGapChecks200JSONResponse) VisitGetGapChecksResponse(w http.ResponseWriter) error
type GetGapChecks401JSONResponse ¶
type GetGapChecks401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetGapChecks401JSONResponse) VisitGetGapChecksResponse ¶
func (response GetGapChecks401JSONResponse) VisitGetGapChecksResponse(w http.ResponseWriter) error
type GetGapChecks403JSONResponse ¶
type GetGapChecks403JSONResponse struct{ ForbiddenJSONResponse }
func (GetGapChecks403JSONResponse) VisitGetGapChecksResponse ¶
func (response GetGapChecks403JSONResponse) VisitGetGapChecksResponse(w http.ResponseWriter) error
type GetGapChecks404JSONResponse ¶
type GetGapChecks404JSONResponse struct{ NotFoundJSONResponse }
func (GetGapChecks404JSONResponse) VisitGetGapChecksResponse ¶
func (response GetGapChecks404JSONResponse) VisitGetGapChecksResponse(w http.ResponseWriter) error
type GetGapChecksRequestObject ¶
type GetGapChecksRequestObject struct {
Id IdParam `json:"id"`
}
type GetGapChecksResponseObject ¶
type GetGapChecksResponseObject interface {
VisitGetGapChecksResponse(w http.ResponseWriter) error
}
type GetGapCoverage200JSONResponse ¶
type GetGapCoverage200JSONResponse GapCoverage
func (GetGapCoverage200JSONResponse) VisitGetGapCoverageResponse ¶
func (response GetGapCoverage200JSONResponse) VisitGetGapCoverageResponse(w http.ResponseWriter) error
type GetGapCoverage401JSONResponse ¶
type GetGapCoverage401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetGapCoverage401JSONResponse) VisitGetGapCoverageResponse ¶
func (response GetGapCoverage401JSONResponse) VisitGetGapCoverageResponse(w http.ResponseWriter) error
type GetGapCoverage403JSONResponse ¶
type GetGapCoverage403JSONResponse struct{ ForbiddenJSONResponse }
func (GetGapCoverage403JSONResponse) VisitGetGapCoverageResponse ¶
func (response GetGapCoverage403JSONResponse) VisitGetGapCoverageResponse(w http.ResponseWriter) error
type GetGapCoverage404JSONResponse ¶
type GetGapCoverage404JSONResponse struct{ NotFoundJSONResponse }
func (GetGapCoverage404JSONResponse) VisitGetGapCoverageResponse ¶
func (response GetGapCoverage404JSONResponse) VisitGetGapCoverageResponse(w http.ResponseWriter) error
type GetGapCoverageRequestObject ¶
type GetGapCoverageRequestObject struct {
Id IdParam `json:"id"`
}
type GetGapCoverageResponseObject ¶
type GetGapCoverageResponseObject interface {
VisitGetGapCoverageResponse(w http.ResponseWriter) error
}
type GetGoalChecks200JSONResponse ¶
type GetGoalChecks200JSONResponse []GoalCheck
func (GetGoalChecks200JSONResponse) VisitGetGoalChecksResponse ¶
func (response GetGoalChecks200JSONResponse) VisitGetGoalChecksResponse(w http.ResponseWriter) error
type GetGoalChecks401JSONResponse ¶
type GetGoalChecks401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetGoalChecks401JSONResponse) VisitGetGoalChecksResponse ¶
func (response GetGoalChecks401JSONResponse) VisitGetGoalChecksResponse(w http.ResponseWriter) error
type GetGoalChecks403JSONResponse ¶
type GetGoalChecks403JSONResponse struct{ ForbiddenJSONResponse }
func (GetGoalChecks403JSONResponse) VisitGetGoalChecksResponse ¶
func (response GetGoalChecks403JSONResponse) VisitGetGoalChecksResponse(w http.ResponseWriter) error
type GetGoalChecks404JSONResponse ¶
type GetGoalChecks404JSONResponse struct{ NotFoundJSONResponse }
func (GetGoalChecks404JSONResponse) VisitGetGoalChecksResponse ¶
func (response GetGoalChecks404JSONResponse) VisitGetGoalChecksResponse(w http.ResponseWriter) error
type GetGoalChecksRequestObject ¶
type GetGoalChecksRequestObject struct {
Id IdParam `json:"id"`
}
type GetGoalChecksResponseObject ¶
type GetGoalChecksResponseObject interface {
VisitGetGoalChecksResponse(w http.ResponseWriter) error
}
type GetGoalTree200JSONResponse ¶
type GetGoalTree200JSONResponse GoalTree
func (GetGoalTree200JSONResponse) VisitGetGoalTreeResponse ¶
func (response GetGoalTree200JSONResponse) VisitGetGoalTreeResponse(w http.ResponseWriter) error
type GetGoalTree401JSONResponse ¶
type GetGoalTree401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetGoalTree401JSONResponse) VisitGetGoalTreeResponse ¶
func (response GetGoalTree401JSONResponse) VisitGetGoalTreeResponse(w http.ResponseWriter) error
type GetGoalTree403JSONResponse ¶
type GetGoalTree403JSONResponse struct{ ForbiddenJSONResponse }
func (GetGoalTree403JSONResponse) VisitGetGoalTreeResponse ¶
func (response GetGoalTree403JSONResponse) VisitGetGoalTreeResponse(w http.ResponseWriter) error
type GetGoalTreeRequestObject ¶
type GetGoalTreeRequestObject struct {
}
type GetGoalTreeResponseObject ¶
type GetGoalTreeResponseObject interface {
VisitGetGoalTreeResponse(w http.ResponseWriter) error
}
type GetHealth200JSONResponse ¶
type GetHealth200JSONResponse Health
func (GetHealth200JSONResponse) VisitGetHealthResponse ¶
func (response GetHealth200JSONResponse) VisitGetHealthResponse(w http.ResponseWriter) error
type GetHealth401JSONResponse ¶
type GetHealth401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetHealth401JSONResponse) VisitGetHealthResponse ¶
func (response GetHealth401JSONResponse) VisitGetHealthResponse(w http.ResponseWriter) error
type GetHealth403JSONResponse ¶
type GetHealth403JSONResponse struct{ ForbiddenJSONResponse }
func (GetHealth403JSONResponse) VisitGetHealthResponse ¶
func (response GetHealth403JSONResponse) VisitGetHealthResponse(w http.ResponseWriter) error
type GetHealthRequestObject ¶
type GetHealthRequestObject struct {
}
type GetHealthResponseObject ¶
type GetHealthResponseObject interface {
VisitGetHealthResponse(w http.ResponseWriter) error
}
type GetManifest200JSONResponse ¶
type GetManifest200JSONResponse ManifestView
func (GetManifest200JSONResponse) VisitGetManifestResponse ¶
func (response GetManifest200JSONResponse) VisitGetManifestResponse(w http.ResponseWriter) error
type GetManifest401JSONResponse ¶
type GetManifest401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetManifest401JSONResponse) VisitGetManifestResponse ¶
func (response GetManifest401JSONResponse) VisitGetManifestResponse(w http.ResponseWriter) error
type GetManifest403JSONResponse ¶
type GetManifest403JSONResponse struct{ ForbiddenJSONResponse }
func (GetManifest403JSONResponse) VisitGetManifestResponse ¶
func (response GetManifest403JSONResponse) VisitGetManifestResponse(w http.ResponseWriter) error
type GetManifest404JSONResponse ¶
type GetManifest404JSONResponse struct{ NotFoundJSONResponse }
func (GetManifest404JSONResponse) VisitGetManifestResponse ¶
func (response GetManifest404JSONResponse) VisitGetManifestResponse(w http.ResponseWriter) error
type GetManifestResponseObject ¶
type GetManifestResponseObject interface {
VisitGetManifestResponse(w http.ResponseWriter) error
}
type GetOperationCharterHtml200TexthtmlResponse ¶
func (GetOperationCharterHtml200TexthtmlResponse) VisitGetOperationCharterHtmlResponse ¶
func (response GetOperationCharterHtml200TexthtmlResponse) VisitGetOperationCharterHtmlResponse(w http.ResponseWriter) error
type GetOperationCharterHtml401JSONResponse ¶
type GetOperationCharterHtml401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetOperationCharterHtml401JSONResponse) VisitGetOperationCharterHtmlResponse ¶
func (response GetOperationCharterHtml401JSONResponse) VisitGetOperationCharterHtmlResponse(w http.ResponseWriter) error
type GetOperationCharterHtml403JSONResponse ¶
type GetOperationCharterHtml403JSONResponse struct{ ForbiddenJSONResponse }
func (GetOperationCharterHtml403JSONResponse) VisitGetOperationCharterHtmlResponse ¶
func (response GetOperationCharterHtml403JSONResponse) VisitGetOperationCharterHtmlResponse(w http.ResponseWriter) error
type GetOperationCharterHtml404JSONResponse ¶
type GetOperationCharterHtml404JSONResponse struct{ NotFoundJSONResponse }
func (GetOperationCharterHtml404JSONResponse) VisitGetOperationCharterHtmlResponse ¶
func (response GetOperationCharterHtml404JSONResponse) VisitGetOperationCharterHtmlResponse(w http.ResponseWriter) error
type GetOperationCharterHtmlRequestObject ¶
type GetOperationCharterHtmlRequestObject struct {
Id IdParam `json:"id"`
}
type GetOperationCharterHtmlResponseObject ¶
type GetOperationCharterHtmlResponseObject interface {
VisitGetOperationCharterHtmlResponse(w http.ResponseWriter) error
}
type GetOperationChecks200JSONResponse ¶
type GetOperationChecks200JSONResponse []ProgrammeCheck
func (GetOperationChecks200JSONResponse) VisitGetOperationChecksResponse ¶
func (response GetOperationChecks200JSONResponse) VisitGetOperationChecksResponse(w http.ResponseWriter) error
type GetOperationChecks401JSONResponse ¶
type GetOperationChecks401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetOperationChecks401JSONResponse) VisitGetOperationChecksResponse ¶
func (response GetOperationChecks401JSONResponse) VisitGetOperationChecksResponse(w http.ResponseWriter) error
type GetOperationChecks403JSONResponse ¶
type GetOperationChecks403JSONResponse struct{ ForbiddenJSONResponse }
func (GetOperationChecks403JSONResponse) VisitGetOperationChecksResponse ¶
func (response GetOperationChecks403JSONResponse) VisitGetOperationChecksResponse(w http.ResponseWriter) error
type GetOperationChecks404JSONResponse ¶
type GetOperationChecks404JSONResponse struct{ NotFoundJSONResponse }
func (GetOperationChecks404JSONResponse) VisitGetOperationChecksResponse ¶
func (response GetOperationChecks404JSONResponse) VisitGetOperationChecksResponse(w http.ResponseWriter) error
type GetOperationChecksRequestObject ¶
type GetOperationChecksRequestObject struct {
Id IdParam `json:"id"`
}
type GetOperationChecksResponseObject ¶
type GetOperationChecksResponseObject interface {
VisitGetOperationChecksResponse(w http.ResponseWriter) error
}
type GetPresenceDocument200JSONResponse ¶
type GetPresenceDocument200JSONResponse SharedDocument
func (GetPresenceDocument200JSONResponse) VisitGetPresenceDocumentResponse ¶
func (response GetPresenceDocument200JSONResponse) VisitGetPresenceDocumentResponse(w http.ResponseWriter) error
type GetPresenceDocument401JSONResponse ¶
type GetPresenceDocument401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetPresenceDocument401JSONResponse) VisitGetPresenceDocumentResponse ¶
func (response GetPresenceDocument401JSONResponse) VisitGetPresenceDocumentResponse(w http.ResponseWriter) error
type GetPresenceDocument403JSONResponse ¶
type GetPresenceDocument403JSONResponse struct{ ForbiddenJSONResponse }
func (GetPresenceDocument403JSONResponse) VisitGetPresenceDocumentResponse ¶
func (response GetPresenceDocument403JSONResponse) VisitGetPresenceDocumentResponse(w http.ResponseWriter) error
type GetPresenceDocumentRequestObject ¶
type GetPresenceDocumentRequestObject struct {
}
type GetPresenceDocumentResponseObject ¶
type GetPresenceDocumentResponseObject interface {
VisitGetPresenceDocumentResponse(w http.ResponseWriter) error
}
type GetProgrammeCharterHtml200TexthtmlResponse ¶
func (GetProgrammeCharterHtml200TexthtmlResponse) VisitGetProgrammeCharterHtmlResponse ¶
func (response GetProgrammeCharterHtml200TexthtmlResponse) VisitGetProgrammeCharterHtmlResponse(w http.ResponseWriter) error
type GetProgrammeCharterHtml401JSONResponse ¶
type GetProgrammeCharterHtml401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetProgrammeCharterHtml401JSONResponse) VisitGetProgrammeCharterHtmlResponse ¶
func (response GetProgrammeCharterHtml401JSONResponse) VisitGetProgrammeCharterHtmlResponse(w http.ResponseWriter) error
type GetProgrammeCharterHtml403JSONResponse ¶
type GetProgrammeCharterHtml403JSONResponse struct{ ForbiddenJSONResponse }
func (GetProgrammeCharterHtml403JSONResponse) VisitGetProgrammeCharterHtmlResponse ¶
func (response GetProgrammeCharterHtml403JSONResponse) VisitGetProgrammeCharterHtmlResponse(w http.ResponseWriter) error
type GetProgrammeCharterHtml404JSONResponse ¶
type GetProgrammeCharterHtml404JSONResponse struct{ NotFoundJSONResponse }
func (GetProgrammeCharterHtml404JSONResponse) VisitGetProgrammeCharterHtmlResponse ¶
func (response GetProgrammeCharterHtml404JSONResponse) VisitGetProgrammeCharterHtmlResponse(w http.ResponseWriter) error
type GetProgrammeCharterHtmlRequestObject ¶
type GetProgrammeCharterHtmlRequestObject struct {
Id IdParam `json:"id"`
}
type GetProgrammeCharterHtmlResponseObject ¶
type GetProgrammeCharterHtmlResponseObject interface {
VisitGetProgrammeCharterHtmlResponse(w http.ResponseWriter) error
}
type GetProgrammeChecks200JSONResponse ¶
type GetProgrammeChecks200JSONResponse []ProgrammeCheck
func (GetProgrammeChecks200JSONResponse) VisitGetProgrammeChecksResponse ¶
func (response GetProgrammeChecks200JSONResponse) VisitGetProgrammeChecksResponse(w http.ResponseWriter) error
type GetProgrammeChecks401JSONResponse ¶
type GetProgrammeChecks401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetProgrammeChecks401JSONResponse) VisitGetProgrammeChecksResponse ¶
func (response GetProgrammeChecks401JSONResponse) VisitGetProgrammeChecksResponse(w http.ResponseWriter) error
type GetProgrammeChecks403JSONResponse ¶
type GetProgrammeChecks403JSONResponse struct{ ForbiddenJSONResponse }
func (GetProgrammeChecks403JSONResponse) VisitGetProgrammeChecksResponse ¶
func (response GetProgrammeChecks403JSONResponse) VisitGetProgrammeChecksResponse(w http.ResponseWriter) error
type GetProgrammeChecks404JSONResponse ¶
type GetProgrammeChecks404JSONResponse struct{ NotFoundJSONResponse }
func (GetProgrammeChecks404JSONResponse) VisitGetProgrammeChecksResponse ¶
func (response GetProgrammeChecks404JSONResponse) VisitGetProgrammeChecksResponse(w http.ResponseWriter) error
type GetProgrammeChecksRequestObject ¶
type GetProgrammeChecksRequestObject struct {
Id IdParam `json:"id"`
}
type GetProgrammeChecksResponseObject ¶
type GetProgrammeChecksResponseObject interface {
VisitGetProgrammeChecksResponse(w http.ResponseWriter) error
}
type GetProjectCharterHtml200TexthtmlResponse ¶
func (GetProjectCharterHtml200TexthtmlResponse) VisitGetProjectCharterHtmlResponse ¶
func (response GetProjectCharterHtml200TexthtmlResponse) VisitGetProjectCharterHtmlResponse(w http.ResponseWriter) error
type GetProjectCharterHtml401JSONResponse ¶
type GetProjectCharterHtml401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetProjectCharterHtml401JSONResponse) VisitGetProjectCharterHtmlResponse ¶
func (response GetProjectCharterHtml401JSONResponse) VisitGetProjectCharterHtmlResponse(w http.ResponseWriter) error
type GetProjectCharterHtml403JSONResponse ¶
type GetProjectCharterHtml403JSONResponse struct{ ForbiddenJSONResponse }
func (GetProjectCharterHtml403JSONResponse) VisitGetProjectCharterHtmlResponse ¶
func (response GetProjectCharterHtml403JSONResponse) VisitGetProjectCharterHtmlResponse(w http.ResponseWriter) error
type GetProjectCharterHtml404JSONResponse ¶
type GetProjectCharterHtml404JSONResponse struct{ NotFoundJSONResponse }
func (GetProjectCharterHtml404JSONResponse) VisitGetProjectCharterHtmlResponse ¶
func (response GetProjectCharterHtml404JSONResponse) VisitGetProjectCharterHtmlResponse(w http.ResponseWriter) error
type GetProjectCharterHtmlParams ¶
type GetProjectCharterHtmlParams struct {
// Working Use working copy instead of latest snapshot
Working *bool `form:"working,omitempty" json:"working,omitempty"`
}
GetProjectCharterHtmlParams defines parameters for GetProjectCharterHtml.
type GetProjectCharterHtmlRequestObject ¶
type GetProjectCharterHtmlRequestObject struct {
Id IdParam `json:"id"`
Params GetProjectCharterHtmlParams
}
type GetProjectCharterHtmlResponseObject ¶
type GetProjectCharterHtmlResponseObject interface {
VisitGetProjectCharterHtmlResponse(w http.ResponseWriter) error
}
type GetProjectChecks200JSONResponse ¶
type GetProjectChecks200JSONResponse ProjectChecks
func (GetProjectChecks200JSONResponse) VisitGetProjectChecksResponse ¶
func (response GetProjectChecks200JSONResponse) VisitGetProjectChecksResponse(w http.ResponseWriter) error
type GetProjectChecks401JSONResponse ¶
type GetProjectChecks401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetProjectChecks401JSONResponse) VisitGetProjectChecksResponse ¶
func (response GetProjectChecks401JSONResponse) VisitGetProjectChecksResponse(w http.ResponseWriter) error
type GetProjectChecks403JSONResponse ¶
type GetProjectChecks403JSONResponse struct{ ForbiddenJSONResponse }
func (GetProjectChecks403JSONResponse) VisitGetProjectChecksResponse ¶
func (response GetProjectChecks403JSONResponse) VisitGetProjectChecksResponse(w http.ResponseWriter) error
type GetProjectChecks404JSONResponse ¶
type GetProjectChecks404JSONResponse struct{ NotFoundJSONResponse }
func (GetProjectChecks404JSONResponse) VisitGetProjectChecksResponse ¶
func (response GetProjectChecks404JSONResponse) VisitGetProjectChecksResponse(w http.ResponseWriter) error
type GetProjectChecksRequestObject ¶
type GetProjectChecksRequestObject struct {
Id IdParam `json:"id"`
}
type GetProjectChecksResponseObject ¶
type GetProjectChecksResponseObject interface {
VisitGetProjectChecksResponse(w http.ResponseWriter) error
}
type GetProjectState200JSONResponse ¶
type GetProjectState200JSONResponse ProjectState
func (GetProjectState200JSONResponse) VisitGetProjectStateResponse ¶
func (response GetProjectState200JSONResponse) VisitGetProjectStateResponse(w http.ResponseWriter) error
type GetProjectState401JSONResponse ¶
type GetProjectState401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetProjectState401JSONResponse) VisitGetProjectStateResponse ¶
func (response GetProjectState401JSONResponse) VisitGetProjectStateResponse(w http.ResponseWriter) error
type GetProjectState403JSONResponse ¶
type GetProjectState403JSONResponse struct{ ForbiddenJSONResponse }
func (GetProjectState403JSONResponse) VisitGetProjectStateResponse ¶
func (response GetProjectState403JSONResponse) VisitGetProjectStateResponse(w http.ResponseWriter) error
type GetProjectState404JSONResponse ¶
type GetProjectState404JSONResponse struct{ NotFoundJSONResponse }
func (GetProjectState404JSONResponse) VisitGetProjectStateResponse ¶
func (response GetProjectState404JSONResponse) VisitGetProjectStateResponse(w http.ResponseWriter) error
type GetProjectStateRequestObject ¶
type GetProjectStateRequestObject struct {
Id IdParam `json:"id"`
}
type GetProjectStateResponseObject ¶
type GetProjectStateResponseObject interface {
VisitGetProjectStateResponse(w http.ResponseWriter) error
}
type GetReferences200JSONResponse ¶
type GetReferences200JSONResponse References
func (GetReferences200JSONResponse) VisitGetReferencesResponse ¶
func (response GetReferences200JSONResponse) VisitGetReferencesResponse(w http.ResponseWriter) error
type GetReferences401JSONResponse ¶
type GetReferences401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetReferences401JSONResponse) VisitGetReferencesResponse ¶
func (response GetReferences401JSONResponse) VisitGetReferencesResponse(w http.ResponseWriter) error
type GetReferences403JSONResponse ¶
type GetReferences403JSONResponse struct{ ForbiddenJSONResponse }
func (GetReferences403JSONResponse) VisitGetReferencesResponse ¶
func (response GetReferences403JSONResponse) VisitGetReferencesResponse(w http.ResponseWriter) error
type GetReferences404JSONResponse ¶
type GetReferences404JSONResponse struct{ NotFoundJSONResponse }
func (GetReferences404JSONResponse) VisitGetReferencesResponse ¶
func (response GetReferences404JSONResponse) VisitGetReferencesResponse(w http.ResponseWriter) error
type GetReferencesResponseObject ¶
type GetReferencesResponseObject interface {
VisitGetReferencesResponse(w http.ResponseWriter) error
}
type GetSchema200JSONResponse ¶
type GetSchema200JSONResponse map[string]interface{}
func (GetSchema200JSONResponse) VisitGetSchemaResponse ¶
func (response GetSchema200JSONResponse) VisitGetSchemaResponse(w http.ResponseWriter) error
type GetSchema401JSONResponse ¶
type GetSchema401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetSchema401JSONResponse) VisitGetSchemaResponse ¶
func (response GetSchema401JSONResponse) VisitGetSchemaResponse(w http.ResponseWriter) error
type GetSchema403JSONResponse ¶
type GetSchema403JSONResponse struct{ ForbiddenJSONResponse }
func (GetSchema403JSONResponse) VisitGetSchemaResponse ¶
func (response GetSchema403JSONResponse) VisitGetSchemaResponse(w http.ResponseWriter) error
type GetSchema404JSONResponse ¶
type GetSchema404JSONResponse struct{ NotFoundJSONResponse }
func (GetSchema404JSONResponse) VisitGetSchemaResponse ¶
func (response GetSchema404JSONResponse) VisitGetSchemaResponse(w http.ResponseWriter) error
type GetSchemaRequestObject ¶
type GetSchemaRequestObject struct {
Kind KindParam `json:"kind"`
}
type GetSchemaResponseObject ¶
type GetSchemaResponseObject interface {
VisitGetSchemaResponse(w http.ResponseWriter) error
}
type GetSession200JSONResponse ¶
type GetSession200JSONResponse Session
func (GetSession200JSONResponse) VisitGetSessionResponse ¶
func (response GetSession200JSONResponse) VisitGetSessionResponse(w http.ResponseWriter) error
type GetSession401JSONResponse ¶
type GetSession401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetSession401JSONResponse) VisitGetSessionResponse ¶
func (response GetSession401JSONResponse) VisitGetSessionResponse(w http.ResponseWriter) error
type GetSessionRequestObject ¶
type GetSessionRequestObject struct {
}
type GetSessionResponseObject ¶
type GetSessionResponseObject interface {
VisitGetSessionResponse(w http.ResponseWriter) error
}
type GetSettings200JSONResponse ¶
type GetSettings200JSONResponse Settings
func (GetSettings200JSONResponse) VisitGetSettingsResponse ¶
func (response GetSettings200JSONResponse) VisitGetSettingsResponse(w http.ResponseWriter) error
type GetSettings401JSONResponse ¶
type GetSettings401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetSettings401JSONResponse) VisitGetSettingsResponse ¶
func (response GetSettings401JSONResponse) VisitGetSettingsResponse(w http.ResponseWriter) error
type GetSettings403JSONResponse ¶
type GetSettings403JSONResponse struct{ ForbiddenJSONResponse }
func (GetSettings403JSONResponse) VisitGetSettingsResponse ¶
func (response GetSettings403JSONResponse) VisitGetSettingsResponse(w http.ResponseWriter) error
type GetSettingsRequestObject ¶
type GetSettingsRequestObject struct {
}
type GetSettingsResponseObject ¶
type GetSettingsResponseObject interface {
VisitGetSettingsResponse(w http.ResponseWriter) error
}
type GetSharedDocument200JSONResponse ¶
type GetSharedDocument200JSONResponse SharedDocument
func (GetSharedDocument200JSONResponse) VisitGetSharedDocumentResponse ¶
func (response GetSharedDocument200JSONResponse) VisitGetSharedDocumentResponse(w http.ResponseWriter) error
type GetSharedDocument401JSONResponse ¶
func (GetSharedDocument401JSONResponse) VisitGetSharedDocumentResponse ¶
func (response GetSharedDocument401JSONResponse) VisitGetSharedDocumentResponse(w http.ResponseWriter) error
type GetSharedDocument403JSONResponse ¶
func (GetSharedDocument403JSONResponse) VisitGetSharedDocumentResponse ¶
func (response GetSharedDocument403JSONResponse) VisitGetSharedDocumentResponse(w http.ResponseWriter) error
type GetSharedDocument404JSONResponse ¶
func (GetSharedDocument404JSONResponse) VisitGetSharedDocumentResponse ¶
func (response GetSharedDocument404JSONResponse) VisitGetSharedDocumentResponse(w http.ResponseWriter) error
type GetSharedDocumentRequestObject ¶
type GetSharedDocumentRequestObject struct {
}
type GetSharedDocumentResponseObject ¶
type GetSharedDocumentResponseObject interface {
}
type GetVault200JSONResponse ¶
type GetVault200JSONResponse Vault
func (GetVault200JSONResponse) VisitGetVaultResponse ¶
func (response GetVault200JSONResponse) VisitGetVaultResponse(w http.ResponseWriter) error
type GetVault400JSONResponse ¶
type GetVault400JSONResponse struct{ BadRequestJSONResponse }
func (GetVault400JSONResponse) VisitGetVaultResponse ¶
func (response GetVault400JSONResponse) VisitGetVaultResponse(w http.ResponseWriter) error
type GetVault401JSONResponse ¶
type GetVault401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetVault401JSONResponse) VisitGetVaultResponse ¶
func (response GetVault401JSONResponse) VisitGetVaultResponse(w http.ResponseWriter) error
type GetVault403JSONResponse ¶
type GetVault403JSONResponse struct{ ForbiddenJSONResponse }
func (GetVault403JSONResponse) VisitGetVaultResponse ¶
func (response GetVault403JSONResponse) VisitGetVaultResponse(w http.ResponseWriter) error
type GetVaultRequestObject ¶
type GetVaultRequestObject struct {
}
type GetVaultResponseObject ¶
type GetVaultResponseObject interface {
VisitGetVaultResponse(w http.ResponseWriter) error
}
type GetVersion200JSONResponse ¶
type GetVersion200JSONResponse ManifestView
func (GetVersion200JSONResponse) VisitGetVersionResponse ¶
func (response GetVersion200JSONResponse) VisitGetVersionResponse(w http.ResponseWriter) error
type GetVersion401JSONResponse ¶
type GetVersion401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetVersion401JSONResponse) VisitGetVersionResponse ¶
func (response GetVersion401JSONResponse) VisitGetVersionResponse(w http.ResponseWriter) error
type GetVersion403JSONResponse ¶
type GetVersion403JSONResponse struct{ ForbiddenJSONResponse }
func (GetVersion403JSONResponse) VisitGetVersionResponse ¶
func (response GetVersion403JSONResponse) VisitGetVersionResponse(w http.ResponseWriter) error
type GetVersion404JSONResponse ¶
type GetVersion404JSONResponse struct{ NotFoundJSONResponse }
func (GetVersion404JSONResponse) VisitGetVersionResponse ¶
func (response GetVersion404JSONResponse) VisitGetVersionResponse(w http.ResponseWriter) error
type GetVersionRequestObject ¶
type GetVersionResponseObject ¶
type GetVersionResponseObject interface {
VisitGetVersionResponse(w http.ResponseWriter) error
}
type GetWorking200JSONResponse ¶
type GetWorking200JSONResponse ManifestDraft
func (GetWorking200JSONResponse) VisitGetWorkingResponse ¶
func (response GetWorking200JSONResponse) VisitGetWorkingResponse(w http.ResponseWriter) error
type GetWorking401JSONResponse ¶
type GetWorking401JSONResponse struct{ UnauthenticatedJSONResponse }
func (GetWorking401JSONResponse) VisitGetWorkingResponse ¶
func (response GetWorking401JSONResponse) VisitGetWorkingResponse(w http.ResponseWriter) error
type GetWorking403JSONResponse ¶
type GetWorking403JSONResponse struct{ ForbiddenJSONResponse }
func (GetWorking403JSONResponse) VisitGetWorkingResponse ¶
func (response GetWorking403JSONResponse) VisitGetWorkingResponse(w http.ResponseWriter) error
type GetWorking404JSONResponse ¶
type GetWorking404JSONResponse struct{ NotFoundJSONResponse }
func (GetWorking404JSONResponse) VisitGetWorkingResponse ¶
func (response GetWorking404JSONResponse) VisitGetWorkingResponse(w http.ResponseWriter) error
type GetWorkingRequestObject ¶
type GetWorkingResponseObject ¶
type GetWorkingResponseObject interface {
VisitGetWorkingResponse(w http.ResponseWriter) error
}
type GoalAligned ¶
type GoalAligned struct {
Kpis int `json:"kpis"`
Operations int `json:"operations"`
Programmes int `json:"programmes"`
Projects int `json:"projects"`
}
GoalAligned defines model for GoalAligned.
type GoalCheck ¶
type GoalCheck struct {
Fix *GoalCheckFix `json:"fix,omitempty"`
Id string `json:"id"`
Message string `json:"message"`
State GoalCheckState `json:"state"`
}
GoalCheck defines model for GoalCheck.
type GoalCheckFix ¶
type GoalCheckFix struct {
Section string `json:"section"`
}
GoalCheckFix defines model for GoalCheckFix.
type GoalCheckState ¶
type GoalCheckState string
GoalCheckState defines model for GoalCheck.State.
const ( GoalCheckStateOk GoalCheckState = "ok" GoalCheckStateWarn GoalCheckState = "warn" )
Defines values for GoalCheckState.
func (GoalCheckState) Valid ¶
func (e GoalCheckState) Valid() bool
Valid indicates whether the value is a known member of the GoalCheckState enum.
type GoalNode ¶
type GoalNode struct {
Aligned GoalAligned `json:"aligned"`
Children []GoalNode `json:"children"`
// ContributesTo Higher objectives this outcome also leads to, with the reason (TAXONOMY.md D24).
ContributesTo *[]struct {
Because *string `json:"because,omitempty"`
Goal string `json:"goal"`
} `json:"contributesTo,omitempty"`
// Gaps The gaps that name this goal as the outcome that would close them, read back from the gaps (D24).
Gaps *[]struct {
Current *string `json:"current,omitempty"`
Desired *string `json:"desired,omitempty"`
Id string `json:"id"`
Name string `json:"name"`
} `json:"gaps,omitempty"`
// Horizon The period it covers as YYYY-MM at each end; inherited is true when it takes its parent's.
Horizon *struct {
End string `json:"end"`
Inherited *bool `json:"inherited,omitempty"`
Start string `json:"start"`
} `json:"horizon,omitempty"`
Id string `json:"id"`
KeyResults int `json:"keyResults"`
Level string `json:"level"`
Name string `json:"name"`
// Objective The goal's short statement (an aim for goals and objectives, a changed state for outcomes).
Objective *string `json:"objective,omitempty"`
// Owner The role accountable for it (a Resource id), when named (TAXONOMY.md D26).
Owner *string `json:"owner,omitempty"`
Parent *string `json:"parent,omitempty"`
// Smart Which SMART criteria it meets, read from what it holds (TAXONOMY.md D25).
Smart struct {
Attainable bool `json:"attainable"`
Measurable bool `json:"measurable"`
Relevant bool `json:"relevant"`
Specific bool `json:"specific"`
TimeBound bool `json:"timeBound"`
} `json:"smart"`
// Why Why it matters (whyItMatters).
Why *string `json:"why,omitempty"`
}
GoalNode defines model for GoalNode.
type InvalidParamFormatError ¶
func (*InvalidParamFormatError) Error ¶
func (e *InvalidParamFormatError) Error() string
func (*InvalidParamFormatError) Unwrap ¶
func (e *InvalidParamFormatError) Unwrap() error
type ListExcluded200JSONResponse ¶
type ListExcluded200JSONResponse []Exclusion
func (ListExcluded200JSONResponse) VisitListExcludedResponse ¶
func (response ListExcluded200JSONResponse) VisitListExcludedResponse(w http.ResponseWriter) error
type ListExcluded401JSONResponse ¶
type ListExcluded401JSONResponse struct{ UnauthenticatedJSONResponse }
func (ListExcluded401JSONResponse) VisitListExcludedResponse ¶
func (response ListExcluded401JSONResponse) VisitListExcludedResponse(w http.ResponseWriter) error
type ListExcluded403JSONResponse ¶
type ListExcluded403JSONResponse struct{ ForbiddenJSONResponse }
func (ListExcluded403JSONResponse) VisitListExcludedResponse ¶
func (response ListExcluded403JSONResponse) VisitListExcludedResponse(w http.ResponseWriter) error
type ListExcludedRequestObject ¶
type ListExcludedRequestObject struct {
}
type ListExcludedResponseObject ¶
type ListExcludedResponseObject interface {
VisitListExcludedResponse(w http.ResponseWriter) error
}
type ListFlows200JSONResponse ¶
type ListFlows200JSONResponse []string
func (ListFlows200JSONResponse) VisitListFlowsResponse ¶
func (response ListFlows200JSONResponse) VisitListFlowsResponse(w http.ResponseWriter) error
type ListFlows401JSONResponse ¶
type ListFlows401JSONResponse struct{ UnauthenticatedJSONResponse }
func (ListFlows401JSONResponse) VisitListFlowsResponse ¶
func (response ListFlows401JSONResponse) VisitListFlowsResponse(w http.ResponseWriter) error
type ListFlows403JSONResponse ¶
type ListFlows403JSONResponse struct{ ForbiddenJSONResponse }
func (ListFlows403JSONResponse) VisitListFlowsResponse ¶
func (response ListFlows403JSONResponse) VisitListFlowsResponse(w http.ResponseWriter) error
type ListFlowsRequestObject ¶
type ListFlowsRequestObject struct {
}
type ListFlowsResponseObject ¶
type ListFlowsResponseObject interface {
VisitListFlowsResponse(w http.ResponseWriter) error
}
type ListKinds200JSONResponse ¶
type ListKinds200JSONResponse []KindCount
func (ListKinds200JSONResponse) VisitListKindsResponse ¶
func (response ListKinds200JSONResponse) VisitListKindsResponse(w http.ResponseWriter) error
type ListKinds401JSONResponse ¶
type ListKinds401JSONResponse struct{ UnauthenticatedJSONResponse }
func (ListKinds401JSONResponse) VisitListKindsResponse ¶
func (response ListKinds401JSONResponse) VisitListKindsResponse(w http.ResponseWriter) error
type ListKinds403JSONResponse ¶
type ListKinds403JSONResponse struct{ ForbiddenJSONResponse }
func (ListKinds403JSONResponse) VisitListKindsResponse ¶
func (response ListKinds403JSONResponse) VisitListKindsResponse(w http.ResponseWriter) error
type ListKindsRequestObject ¶
type ListKindsRequestObject struct {
}
type ListKindsResponseObject ¶
type ListKindsResponseObject interface {
VisitListKindsResponse(w http.ResponseWriter) error
}
type ListManifests200JSONResponse ¶
type ListManifests200JSONResponse = ListManifests200JSONResponseBody
func (ListManifests200JSONResponse) VisitListManifestsResponse ¶
func (response ListManifests200JSONResponse) VisitListManifestsResponse(w http.ResponseWriter) error
type ListManifests200JSONResponseBody ¶
type ListManifests200JSONResponseBody struct {
// contains filtered or unexported fields
}
ListManifests200JSONResponseBody defines parameters for ListManifests.
func (ListManifests200JSONResponseBody) AsListManifests200JSONResponseBody0 ¶
func (t ListManifests200JSONResponseBody) AsListManifests200JSONResponseBody0() (ListManifests200JSONResponseBody0, error)
AsListManifests200JSONResponseBody0 returns the union data inside the ListManifests200JSONResponseBody as a ListManifests200JSONResponseBody0
func (ListManifests200JSONResponseBody) AsManifestList ¶
func (t ListManifests200JSONResponseBody) AsManifestList() (ManifestList, error)
AsManifestList returns the union data inside the ListManifests200JSONResponseBody as a ManifestList
func (*ListManifests200JSONResponseBody) FromListManifests200JSONResponseBody0 ¶
func (t *ListManifests200JSONResponseBody) FromListManifests200JSONResponseBody0(v ListManifests200JSONResponseBody0) error
FromListManifests200JSONResponseBody0 overwrites any union data inside the ListManifests200JSONResponseBody as the provided ListManifests200JSONResponseBody0
func (*ListManifests200JSONResponseBody) FromManifestList ¶
func (t *ListManifests200JSONResponseBody) FromManifestList(v ManifestList) error
FromManifestList overwrites any union data inside the ListManifests200JSONResponseBody as the provided ManifestList
func (ListManifests200JSONResponseBody) MarshalJSON ¶
func (t ListManifests200JSONResponseBody) MarshalJSON() ([]byte, error)
func (*ListManifests200JSONResponseBody) MergeListManifests200JSONResponseBody0 ¶
func (t *ListManifests200JSONResponseBody) MergeListManifests200JSONResponseBody0(v ListManifests200JSONResponseBody0) error
MergeListManifests200JSONResponseBody0 performs a merge with any union data inside the ListManifests200JSONResponseBody, using the provided ListManifests200JSONResponseBody0
func (*ListManifests200JSONResponseBody) MergeManifestList ¶
func (t *ListManifests200JSONResponseBody) MergeManifestList(v ManifestList) error
MergeManifestList performs a merge with any union data inside the ListManifests200JSONResponseBody, using the provided ManifestList
func (*ListManifests200JSONResponseBody) UnmarshalJSON ¶
func (t *ListManifests200JSONResponseBody) UnmarshalJSON(b []byte) error
type ListManifests200JSONResponseBody0 ¶
type ListManifests200JSONResponseBody0 = []Summary
ListManifests200JSONResponseBody0 defines parameters for ListManifests.
type ListManifests401JSONResponse ¶
type ListManifests401JSONResponse struct{ UnauthenticatedJSONResponse }
func (ListManifests401JSONResponse) VisitListManifestsResponse ¶
func (response ListManifests401JSONResponse) VisitListManifestsResponse(w http.ResponseWriter) error
type ListManifests403JSONResponse ¶
type ListManifests403JSONResponse struct{ ForbiddenJSONResponse }
func (ListManifests403JSONResponse) VisitListManifestsResponse ¶
func (response ListManifests403JSONResponse) VisitListManifestsResponse(w http.ResponseWriter) error
type ListManifests404JSONResponse ¶
type ListManifests404JSONResponse struct{ NotFoundJSONResponse }
func (ListManifests404JSONResponse) VisitListManifestsResponse ¶
func (response ListManifests404JSONResponse) VisitListManifestsResponse(w http.ResponseWriter) error
type ListManifestsParams ¶
type ListManifestsParams struct {
// Q Case-insensitive substring filter over id and name.
Q *string `form:"q,omitempty" json:"q,omitempty"`
// Ref Repeatable. Each value is "Kind/id"; a manifest must have an outgoing reference matching every one given (logical AND). For example ref=Goal/reading-outcomes lists only manifests that reference that goal.
Ref *[]string `form:"ref,omitempty" json:"ref,omitempty"`
// Expand spec carries each manifest's spec on its summary, so a list can show what each record holds without one request per row.
Expand *ListManifestsParamsExpand `form:"expand,omitempty" json:"expand,omitempty"`
// Limit Page size (default 50, max 200). Giving limit or cursor (either one) switches the response from the bare array to the paginated envelope; omitting both keeps the bare-array response.
Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
// Cursor Opaque pagination cursor from a previous response's next field. Giving limit or cursor (either one) switches the response from the bare array to the paginated envelope; omitting both keeps the bare-array response.
Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`
}
ListManifestsParams defines parameters for ListManifests.
type ListManifestsParamsExpand ¶
type ListManifestsParamsExpand string
ListManifestsParamsExpand defines parameters for ListManifests.
const (
Spec ListManifestsParamsExpand = "spec"
)
Defines values for ListManifestsParamsExpand.
func (ListManifestsParamsExpand) Valid ¶
func (e ListManifestsParamsExpand) Valid() bool
Valid indicates whether the value is a known member of the ListManifestsParamsExpand enum.
type ListManifestsRequestObject ¶
type ListManifestsRequestObject struct {
Kind KindParam `json:"kind"`
Params ListManifestsParams
}
type ListManifestsResponseObject ¶
type ListManifestsResponseObject interface {
VisitListManifestsResponse(w http.ResponseWriter) error
}
type ListSnapshots200JSONResponse ¶
type ListSnapshots200JSONResponse SnapshotList
func (ListSnapshots200JSONResponse) VisitListSnapshotsResponse ¶
func (response ListSnapshots200JSONResponse) VisitListSnapshotsResponse(w http.ResponseWriter) error
type ListSnapshots400JSONResponse ¶
type ListSnapshots400JSONResponse struct{ BadRequestJSONResponse }
func (ListSnapshots400JSONResponse) VisitListSnapshotsResponse ¶
func (response ListSnapshots400JSONResponse) VisitListSnapshotsResponse(w http.ResponseWriter) error
type ListSnapshots401JSONResponse ¶
type ListSnapshots401JSONResponse struct{ UnauthenticatedJSONResponse }
func (ListSnapshots401JSONResponse) VisitListSnapshotsResponse ¶
func (response ListSnapshots401JSONResponse) VisitListSnapshotsResponse(w http.ResponseWriter) error
type ListSnapshots403JSONResponse ¶
type ListSnapshots403JSONResponse struct{ ForbiddenJSONResponse }
func (ListSnapshots403JSONResponse) VisitListSnapshotsResponse ¶
func (response ListSnapshots403JSONResponse) VisitListSnapshotsResponse(w http.ResponseWriter) error
type ListSnapshotsParams ¶
type ListSnapshotsParams struct {
// Limit Maximum number of snapshots to return
Limit *int `form:"limit,omitempty" json:"limit,omitempty"`
// Cursor Pagination cursor from a prior response's nextCursor
Cursor *string `form:"cursor,omitempty" json:"cursor,omitempty"`
}
ListSnapshotsParams defines parameters for ListSnapshots.
type ListSnapshotsRequestObject ¶
type ListSnapshotsRequestObject struct {
Params ListSnapshotsParams
}
type ListSnapshotsResponseObject ¶
type ListSnapshotsResponseObject interface {
VisitListSnapshotsResponse(w http.ResponseWriter) error
}
type ListUnapplied200JSONResponse ¶
type ListUnapplied200JSONResponse []ManifestRef
func (ListUnapplied200JSONResponse) VisitListUnappliedResponse ¶
func (response ListUnapplied200JSONResponse) VisitListUnappliedResponse(w http.ResponseWriter) error
type ListUnapplied401JSONResponse ¶
type ListUnapplied401JSONResponse struct{ UnauthenticatedJSONResponse }
func (ListUnapplied401JSONResponse) VisitListUnappliedResponse ¶
func (response ListUnapplied401JSONResponse) VisitListUnappliedResponse(w http.ResponseWriter) error
type ListUnapplied403JSONResponse ¶
type ListUnapplied403JSONResponse struct{ ForbiddenJSONResponse }
func (ListUnapplied403JSONResponse) VisitListUnappliedResponse ¶
func (response ListUnapplied403JSONResponse) VisitListUnappliedResponse(w http.ResponseWriter) error
type ListUnappliedRequestObject ¶
type ListUnappliedRequestObject struct {
}
type ListUnappliedResponseObject ¶
type ListUnappliedResponseObject interface {
VisitListUnappliedResponse(w http.ResponseWriter) error
}
type ListVersions200JSONResponse ¶
type ListVersions200JSONResponse []Version
func (ListVersions200JSONResponse) VisitListVersionsResponse ¶
func (response ListVersions200JSONResponse) VisitListVersionsResponse(w http.ResponseWriter) error
type ListVersions401JSONResponse ¶
type ListVersions401JSONResponse struct{ UnauthenticatedJSONResponse }
func (ListVersions401JSONResponse) VisitListVersionsResponse ¶
func (response ListVersions401JSONResponse) VisitListVersionsResponse(w http.ResponseWriter) error
type ListVersions403JSONResponse ¶
type ListVersions403JSONResponse struct{ ForbiddenJSONResponse }
func (ListVersions403JSONResponse) VisitListVersionsResponse ¶
func (response ListVersions403JSONResponse) VisitListVersionsResponse(w http.ResponseWriter) error
type ListVersions404JSONResponse ¶
type ListVersions404JSONResponse struct{ NotFoundJSONResponse }
func (ListVersions404JSONResponse) VisitListVersionsResponse ¶
func (response ListVersions404JSONResponse) VisitListVersionsResponse(w http.ResponseWriter) error
type ListVersionsResponseObject ¶
type ListVersionsResponseObject interface {
VisitListVersionsResponse(w http.ResponseWriter) error
}
type Manifest ¶
type Manifest struct {
ApiVersion string `json:"apiVersion"`
Kind string `json:"kind"`
Metadata struct {
Id string `json:"id"`
Labels *map[string]string `json:"labels,omitempty"`
Name string `json:"name"`
} `json:"metadata"`
Spec map[string]interface{} `json:"spec"`
}
Manifest The generic manifest envelope, mirroring contract/schemas/manifest.schema.json (kept in sync by hand: the authoritative shape and every kind-specific spec shape live under contract/schemas/, since the code generator cannot follow that file's further reference into common.schema.json without a hand-written import mapping). Runtime validation always uses the JSON Schema files directly, never this generated type.
type ManifestDraft ¶
type ManifestDraft struct {
// Manifest The generic manifest envelope, mirroring contract/schemas/manifest.schema.json (kept in sync by hand: the authoritative shape and every kind-specific spec shape live under contract/schemas/, since the code generator cannot follow that file's further reference into common.schema.json without a hand-written import mapping). Runtime validation always uses the JSON Schema files directly, never this generated type.
Manifest Manifest `json:"manifest"`
Yaml string `json:"yaml"`
}
ManifestDraft A manifest's working copy, kind-agnostic (the kind and id are already in the request path): the text as saved, in the deployment's codec, and the same decoded.
type ManifestList ¶
type ManifestList struct {
Items []Summary `json:"items"`
// Next Opaque cursor for the next page, or null when this is the last page.
Next *string `json:"next"`
}
ManifestList The paginated envelope for listManifests, returned instead of the bare array when limit or cursor is given.
type ManifestRef ¶
type ManifestRef struct {
// Id Manifest id
Id string `json:"id"`
// Kind Manifest kind
Kind string `json:"kind"`
// Name Manifest name from metadata.name
Name string `json:"name"`
}
ManifestRef defines model for ManifestRef.
type ManifestView ¶
type ManifestView struct {
// Manifest The generic manifest envelope, mirroring contract/schemas/manifest.schema.json (kept in sync by hand: the authoritative shape and every kind-specific spec shape live under contract/schemas/, since the code generator cannot follow that file's further reference into common.schema.json without a hand-written import mapping). Runtime validation always uses the JSON Schema files directly, never this generated type.
Manifest Manifest `json:"manifest"`
Version Version `json:"version"`
Yaml string `json:"yaml"`
}
ManifestView defines model for ManifestView.
type NotFoundJSONResponse ¶
type NotFoundJSONResponse ProblemList
type PostSnapshot200JSONResponse ¶
type PostSnapshot200JSONResponse Version
func (PostSnapshot200JSONResponse) VisitPostSnapshotResponse ¶
func (response PostSnapshot200JSONResponse) VisitPostSnapshotResponse(w http.ResponseWriter) error
type PostSnapshot401JSONResponse ¶
type PostSnapshot401JSONResponse struct{ UnauthenticatedJSONResponse }
func (PostSnapshot401JSONResponse) VisitPostSnapshotResponse ¶
func (response PostSnapshot401JSONResponse) VisitPostSnapshotResponse(w http.ResponseWriter) error
type PostSnapshot403JSONResponse ¶
type PostSnapshot403JSONResponse struct{ ForbiddenJSONResponse }
func (PostSnapshot403JSONResponse) VisitPostSnapshotResponse ¶
func (response PostSnapshot403JSONResponse) VisitPostSnapshotResponse(w http.ResponseWriter) error
type PostSnapshot404JSONResponse ¶
type PostSnapshot404JSONResponse struct{ NotFoundJSONResponse }
func (PostSnapshot404JSONResponse) VisitPostSnapshotResponse ¶
func (response PostSnapshot404JSONResponse) VisitPostSnapshotResponse(w http.ResponseWriter) error
type PostSnapshot422JSONResponse ¶
type PostSnapshot422JSONResponse struct{ UnprocessableJSONResponse }
func (PostSnapshot422JSONResponse) VisitPostSnapshotResponse ¶
func (response PostSnapshot422JSONResponse) VisitPostSnapshotResponse(w http.ResponseWriter) error
type PostSnapshotJSONBody ¶
type PostSnapshotJSONBody struct {
// Reason Reason for this snapshot
Reason string `json:"reason"`
}
PostSnapshotJSONBody defines parameters for PostSnapshot.
type PostSnapshotJSONRequestBody ¶
type PostSnapshotJSONRequestBody PostSnapshotJSONBody
PostSnapshotJSONRequestBody defines body for PostSnapshot for application/json ContentType.
type PostSnapshotRequestObject ¶
type PostSnapshotRequestObject struct {
Kind KindParam `json:"kind"`
Id IdParam `json:"id"`
Body *PostSnapshotJSONRequestBody
}
type PostSnapshotResponseObject ¶
type PostSnapshotResponseObject interface {
VisitPostSnapshotResponse(w http.ResponseWriter) error
}
type Problem ¶
type Problem struct {
Message string `json:"message"`
// Path A JSON pointer into the manifest.
Path string `json:"path"`
}
Problem defines model for Problem.
type ProblemList ¶
type ProblemList struct {
Problems []Problem `json:"problems"`
}
ProblemList defines model for ProblemList.
type ProgrammeCheck ¶
type ProgrammeCheck struct {
Id string `json:"id"`
Message string `json:"message"`
// Section The step of the programme walk this is about, so the panel can send the reader there.
Section string `json:"section"`
// State No block state. A programme's checks read other manifests (the work that names it, the graph it sits in), so one could otherwise refuse a definition because a different file changed.
State ProgrammeCheckState `json:"state"`
}
ProgrammeCheck defines model for ProgrammeCheck.
type ProgrammeCheckState ¶
type ProgrammeCheckState string
ProgrammeCheckState No block state. A programme's checks read other manifests (the work that names it, the graph it sits in), so one could otherwise refuse a definition because a different file changed.
const ( ProgrammeCheckStateOk ProgrammeCheckState = "ok" ProgrammeCheckStateWarn ProgrammeCheckState = "warn" )
Defines values for ProgrammeCheckState.
func (ProgrammeCheckState) Valid ¶
func (e ProgrammeCheckState) Valid() bool
Valid indicates whether the value is a known member of the ProgrammeCheckState enum.
type ProjectCheckFix ¶
type ProjectCheckFix struct {
Phase ProjectCheckFixPhase `json:"phase"`
Section string `json:"section"`
}
ProjectCheckFix defines model for ProjectCheckFix.
type ProjectCheckFixPhase ¶
type ProjectCheckFixPhase string
ProjectCheckFixPhase defines model for ProjectCheckFix.Phase.
const ( ProjectCheckFixPhaseClosing ProjectCheckFixPhase = "closing" ProjectCheckFixPhaseInitiation ProjectCheckFixPhase = "initiation" ProjectCheckFixPhaseLanding ProjectCheckFixPhase = "landing" )
Defines values for ProjectCheckFixPhase.
func (ProjectCheckFixPhase) Valid ¶
func (e ProjectCheckFixPhase) Valid() bool
Valid indicates whether the value is a known member of the ProjectCheckFixPhase enum.
type ProjectCheckItem ¶
type ProjectCheckItem struct {
Fix ProjectCheckFix `json:"fix"`
Id string `json:"id"`
Message string `json:"message"`
Phase ProjectCheckItemPhase `json:"phase"`
Section string `json:"section"`
State ProjectCheckState `json:"state"`
}
ProjectCheckItem defines model for ProjectCheckItem.
type ProjectCheckItemPhase ¶
type ProjectCheckItemPhase string
ProjectCheckItemPhase defines model for ProjectCheckItem.Phase.
const ( ProjectCheckItemPhaseClosing ProjectCheckItemPhase = "closing" ProjectCheckItemPhaseInitiation ProjectCheckItemPhase = "initiation" ProjectCheckItemPhaseLanding ProjectCheckItemPhase = "landing" )
Defines values for ProjectCheckItemPhase.
func (ProjectCheckItemPhase) Valid ¶
func (e ProjectCheckItemPhase) Valid() bool
Valid indicates whether the value is a known member of the ProjectCheckItemPhase enum.
type ProjectCheckState ¶
type ProjectCheckState string
ProjectCheckState defines model for ProjectCheckState.
const ( ProjectCheckStateBlock ProjectCheckState = "block" ProjectCheckStateOk ProjectCheckState = "ok" ProjectCheckStateWarn ProjectCheckState = "warn" )
Defines values for ProjectCheckState.
func (ProjectCheckState) Valid ¶
func (e ProjectCheckState) Valid() bool
Valid indicates whether the value is a known member of the ProjectCheckState enum.
type ProjectChecks ¶
type ProjectChecks struct {
Blocking int `json:"blocking"`
// DerivedEnd The end month derived from timeline.start plus every phase's months.
DerivedEnd *string `json:"derivedEnd,omitempty"`
Items []ProjectCheckItem `json:"items"`
}
ProjectChecks defines model for ProjectChecks.
type ProjectState ¶
type ProjectState struct {
History []ProjectStateEntry `json:"history"`
State ProjectStateName `json:"state"`
}
ProjectState defines model for ProjectState.
type ProjectStateEntry ¶
type ProjectStateEntry struct {
Actor string `json:"actor"`
// Bundle The directory path where the rendered charter bundle was written, relative to vault root
Bundle *string `json:"bundle,omitempty"`
On time.Time `json:"on"`
Reason *string `json:"reason,omitempty"`
// Snapshot The snapshot number rendered to the bundle, set when state is handed off
Snapshot *int `json:"snapshot,omitempty"`
State ProjectStateName `json:"state"`
}
ProjectStateEntry defines model for ProjectStateEntry.
type ProjectStateName ¶
type ProjectStateName string
ProjectStateName defines model for ProjectStateName.
const ( Cancelled ProjectStateName = "cancelled" Defined ProjectStateName = "defined" Draft ProjectStateName = "draft" HandedOff ProjectStateName = "handed off" )
Defines values for ProjectStateName.
func (ProjectStateName) Valid ¶
func (e ProjectStateName) Valid() bool
Valid indicates whether the value is a known member of the ProjectStateName enum.
type ProjectStateTransitionRequest ¶
type ProjectStateTransitionRequest struct {
// Reason Required when to is cancelled.
Reason *string `json:"reason,omitempty"`
To ProjectStateName `json:"to"`
}
ProjectStateTransitionRequest defines model for ProjectStateTransitionRequest.
type PutManifest200JSONResponse ¶
type PutManifest200JSONResponse Version
func (PutManifest200JSONResponse) VisitPutManifestResponse ¶
func (response PutManifest200JSONResponse) VisitPutManifestResponse(w http.ResponseWriter) error
type PutManifest400JSONResponse ¶
type PutManifest400JSONResponse struct{ BadRequestJSONResponse }
func (PutManifest400JSONResponse) VisitPutManifestResponse ¶
func (response PutManifest400JSONResponse) VisitPutManifestResponse(w http.ResponseWriter) error
type PutManifest401JSONResponse ¶
type PutManifest401JSONResponse struct{ UnauthenticatedJSONResponse }
func (PutManifest401JSONResponse) VisitPutManifestResponse ¶
func (response PutManifest401JSONResponse) VisitPutManifestResponse(w http.ResponseWriter) error
type PutManifest403JSONResponse ¶
type PutManifest403JSONResponse struct{ ForbiddenJSONResponse }
func (PutManifest403JSONResponse) VisitPutManifestResponse ¶
func (response PutManifest403JSONResponse) VisitPutManifestResponse(w http.ResponseWriter) error
type PutManifest404JSONResponse ¶
type PutManifest404JSONResponse struct{ NotFoundJSONResponse }
func (PutManifest404JSONResponse) VisitPutManifestResponse ¶
func (response PutManifest404JSONResponse) VisitPutManifestResponse(w http.ResponseWriter) error
type PutManifest409JSONResponse ¶
type PutManifest409JSONResponse struct{ ConflictJSONResponse }
func (PutManifest409JSONResponse) VisitPutManifestResponse ¶
func (response PutManifest409JSONResponse) VisitPutManifestResponse(w http.ResponseWriter) error
type PutManifest422JSONResponse ¶
type PutManifest422JSONResponse struct{ UnprocessableJSONResponse }
func (PutManifest422JSONResponse) VisitPutManifestResponse ¶
func (response PutManifest422JSONResponse) VisitPutManifestResponse(w http.ResponseWriter) error
type PutManifestJSONRequestBody ¶
type PutManifestJSONRequestBody = WriteRequest
PutManifestJSONRequestBody defines body for PutManifest for application/json ContentType.
type PutManifestRequestObject ¶
type PutManifestRequestObject struct {
Kind KindParam `json:"kind"`
Id IdParam `json:"id"`
Body *PutManifestJSONRequestBody
}
type PutManifestResponseObject ¶
type PutManifestResponseObject interface {
VisitPutManifestResponse(w http.ResponseWriter) error
}
type PutWorking204Response ¶
type PutWorking204Response struct {
}
func (PutWorking204Response) VisitPutWorkingResponse ¶
func (response PutWorking204Response) VisitPutWorkingResponse(w http.ResponseWriter) error
type PutWorking400JSONResponse ¶
type PutWorking400JSONResponse struct{ BadRequestJSONResponse }
func (PutWorking400JSONResponse) VisitPutWorkingResponse ¶
func (response PutWorking400JSONResponse) VisitPutWorkingResponse(w http.ResponseWriter) error
type PutWorking401JSONResponse ¶
type PutWorking401JSONResponse struct{ UnauthenticatedJSONResponse }
func (PutWorking401JSONResponse) VisitPutWorkingResponse ¶
func (response PutWorking401JSONResponse) VisitPutWorkingResponse(w http.ResponseWriter) error
type PutWorking403JSONResponse ¶
type PutWorking403JSONResponse struct{ ForbiddenJSONResponse }
func (PutWorking403JSONResponse) VisitPutWorkingResponse ¶
func (response PutWorking403JSONResponse) VisitPutWorkingResponse(w http.ResponseWriter) error
type PutWorking404JSONResponse ¶
type PutWorking404JSONResponse struct{ NotFoundJSONResponse }
func (PutWorking404JSONResponse) VisitPutWorkingResponse ¶
func (response PutWorking404JSONResponse) VisitPutWorkingResponse(w http.ResponseWriter) error
type PutWorking409JSONResponse ¶
type PutWorking409JSONResponse ProblemList
func (PutWorking409JSONResponse) VisitPutWorkingResponse ¶
func (response PutWorking409JSONResponse) VisitPutWorkingResponse(w http.ResponseWriter) error
type PutWorking422JSONResponse ¶
type PutWorking422JSONResponse struct{ UnprocessableJSONResponse }
func (PutWorking422JSONResponse) VisitPutWorkingResponse ¶
func (response PutWorking422JSONResponse) VisitPutWorkingResponse(w http.ResponseWriter) error
type PutWorkingJSONBody ¶
type PutWorkingJSONBody struct {
// Yaml YAML manifest document
Yaml string `json:"yaml"`
}
PutWorkingJSONBody defines parameters for PutWorking.
type PutWorkingJSONRequestBody ¶
type PutWorkingJSONRequestBody PutWorkingJSONBody
PutWorkingJSONRequestBody defines body for PutWorking for application/json ContentType.
type PutWorkingRequestObject ¶
type PutWorkingRequestObject struct {
Kind KindParam `json:"kind"`
Id IdParam `json:"id"`
Body *PutWorkingJSONRequestBody
}
type PutWorkingResponseObject ¶
type PutWorkingResponseObject interface {
VisitPutWorkingResponse(w http.ResponseWriter) error
}
type RecoverRef200JSONResponse ¶
type RecoverRef200JSONResponse Vault
func (RecoverRef200JSONResponse) VisitRecoverRefResponse ¶
func (response RecoverRef200JSONResponse) VisitRecoverRefResponse(w http.ResponseWriter) error
type RecoverRef401JSONResponse ¶
type RecoverRef401JSONResponse struct{ UnauthenticatedJSONResponse }
func (RecoverRef401JSONResponse) VisitRecoverRefResponse ¶
func (response RecoverRef401JSONResponse) VisitRecoverRefResponse(w http.ResponseWriter) error
type RecoverRef403JSONResponse ¶
type RecoverRef403JSONResponse struct{ ForbiddenJSONResponse }
func (RecoverRef403JSONResponse) VisitRecoverRefResponse ¶
func (response RecoverRef403JSONResponse) VisitRecoverRefResponse(w http.ResponseWriter) error
type RecoverRef404JSONResponse ¶
type RecoverRef404JSONResponse struct{ NotFoundJSONResponse }
func (RecoverRef404JSONResponse) VisitRecoverRefResponse ¶
func (response RecoverRef404JSONResponse) VisitRecoverRefResponse(w http.ResponseWriter) error
type RecoverRef422JSONResponse ¶
type RecoverRef422JSONResponse struct{ UnprocessableJSONResponse }
func (RecoverRef422JSONResponse) VisitRecoverRefResponse ¶
func (response RecoverRef422JSONResponse) VisitRecoverRefResponse(w http.ResponseWriter) error
type RecoverRefJSONRequestBody ¶
type RecoverRefJSONRequestBody = RecoverRequest
RecoverRefJSONRequestBody defines body for RecoverRef for application/json ContentType.
type RecoverRefRequestObject ¶
type RecoverRefRequestObject struct {
Body *RecoverRefJSONRequestBody
}
type RecoverRefResponseObject ¶
type RecoverRefResponseObject interface {
VisitRecoverRefResponse(w http.ResponseWriter) error
}
type RecoverRequest ¶
type RecoverRequest struct {
// Ref Reference to recover (Kind/id)
Ref string `json:"ref"`
}
RecoverRequest defines model for RecoverRequest.
type Ref ¶
type Ref struct {
Id string `json:"id"`
Kind string `json:"kind"`
// Path JSON pointer within the manifest where this reference sits.
Path *string `json:"path,omitempty"`
}
Ref defines model for Ref.
type References ¶
References defines model for References.
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 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 {
// ListFlows The kinds that have a flow (a stepped definition, contract/flows). A kind without one is a sheet: one step, every field.
// (GET /flows)
ListFlows(w http.ResponseWriter, r *http.Request)
// GetFlow The flow document for a kind, as written in the contract
// (GET /flows/{kind})
GetFlow(w http.ResponseWriter, r *http.Request, kind KindParam)
// GetGoalTree The goal tree, computed from every Goal manifest and the reference index
// (GET /goals/tree)
GetGoalTree(w http.ResponseWriter, r *http.Request)
// GetHealth Liveness check
// (GET /health)
GetHealth(w http.ResponseWriter, r *http.Request)
// ListKinds Every registered kind and how many manifests exist for it
// (GET /kinds)
ListKinds(w http.ResponseWriter, r *http.Request)
// GetGapChecks Whether a gap can be used for what a gap register is for. Advisory only, like a programme's: every one of these reads a manifest other than the gap.
// (GET /manifests/Gap/{id}/checks)
GetGapChecks(w http.ResponseWriter, r *http.Request, id IdParam)
// GetGapCoverage Which part of a gap each piece of work addresses, and which parts nobody does. Derived from the citations, never stored: work declares what it reaches and this reads it back, the same way a programme's members are derived. Addressed, not closed: whether the shortfall narrowed is what the gap's measure reads.
// (GET /manifests/Gap/{id}/coverage)
GetGapCoverage(w http.ResponseWriter, r *http.Request, id IdParam)
// DeleteGoal Delete a goal (goals are easily mutable). Allowed only when nothing currently references it; every committed version of every manifest remains in the immutable manifest store regardless (a tombstone, not a destructive delete), so this never disturbs history or audit -- it only stops the goal from being listed, picked or resolved as a reference going forward.
// (DELETE /manifests/Goal/{id})
DeleteGoal(w http.ResponseWriter, r *http.Request, id IdParam)
// GetGoalChecks Whether a goal can be assessed. Checks never block a save.
// (GET /manifests/Goal/{id}/checks)
GetGoalChecks(w http.ResponseWriter, r *http.Request, id IdParam)
// GetOperationCharterHtml Operation charter rendered as HTML from the working copy: what the service does and when, who runs it, what it is part of, how it is measured, what it uses and produces, and which projects will hand over to it. Derived, like every other view.
// (GET /manifests/Operation/{id}/charter.html)
GetOperationCharterHtml(w http.ResponseWriter, r *http.Request, id IdParam)
// GetOperationChecks Whether an operation is described well enough to be run and measured, step by step. Advisory only.
// (GET /manifests/Operation/{id}/checks)
GetOperationChecks(w http.ResponseWriter, r *http.Request, id IdParam)
// GetProgrammeCharterHtml Programme charter rendered as HTML from the working copy: what it is for, what is wrong, what it serves, how it believes the change happens, what is inside it and who runs it. Derived, like every other view, so there is nothing to keep in step.
// (GET /manifests/Programme/{id}/charter.html)
GetProgrammeCharterHtml(w http.ResponseWriter, r *http.Request, id IdParam)
// GetProgrammeChecks Whether a programme can be judged on what a programme is judged on. Advisory only: none of these has a state that stops anything, because most of them can change when somebody edits a different manifest.
// (GET /manifests/Programme/{id}/checks)
GetProgrammeChecks(w http.ResponseWriter, r *http.Request, id IdParam)
// GetProjectCharterHtml Project charter rendered as HTML from the latest snapshot (or working copy with ?working=true).
// (GET /manifests/Project/{id}/charter.html)
GetProjectCharterHtml(w http.ResponseWriter, r *http.Request, id IdParam, params GetProjectCharterHtmlParams)
// GetProjectChecks Every per-section check for a project (goals, aim, scope, deliverables, beneficiaries, timeline, data, risks, closing, landing). Checks never block a save; state block stops submission.
// (GET /manifests/Project/{id}/checks)
GetProjectChecks(w http.ResponseWriter, r *http.Request, id IdParam)
// GetProjectState A project's current state and its full transition history
// (GET /manifests/Project/{id}/state)
GetProjectState(w http.ResponseWriter, r *http.Request, id IdParam)
// TransitionProjectState Move a project to a new state. draft to in review is refused with 422 (the blocking checks as problems) unless every blocking check currently passes; cancelled requires a reason; every other move must be the next state in the fixed sequence.
// (POST /manifests/Project/{id}/state)
TransitionProjectState(w http.ResponseWriter, r *http.Request, id IdParam)
// ListManifests Summaries of every manifest of a kind
// (GET /manifests/{kind})
ListManifests(w http.ResponseWriter, r *http.Request, kind KindParam, params ListManifestsParams)
// DeleteManifest Exclude a manifest from the live state (a tombstone operation). Allowed only when nothing currently references it; the file remains on disk, and the exclusion can be recovered. Applies the leaf rule: a manifest is a leaf if no live manifest references it.
// (DELETE /manifests/{kind}/{id})
DeleteManifest(w http.ResponseWriter, r *http.Request, kind KindParam, id IdParam)
// GetManifest The current version of one manifest
// (GET /manifests/{kind}/{id})
GetManifest(w http.ResponseWriter, r *http.Request, kind KindParam, id IdParam)
// PutManifest Validate and commit a new version of a manifest: the save that promotes a staged draft into the vault's own tree and its include list, in one atomic journalled write, then clears the draft. Only this ref's draft; other drafts are left alone, because there may be many and saving one is not a decision about the rest.
// (PUT /manifests/{kind}/{id})
PutManifest(w http.ResponseWriter, r *http.Request, kind KindParam, id IdParam)
// GetCharterPdf The charter of a project, programme or operation as a PDF, printed from the same HTML the charter page shows. Needs a chromium: the vault's spec.chromium, the CHROMIUM environment variable, or one on the PATH.
// (GET /manifests/{kind}/{id}/charter.pdf)
GetCharterPdf(w http.ResponseWriter, r *http.Request, kind KindParam, id IdParam, params GetCharterPdfParams)
// DiffManifest Structural diff between two versions
// (GET /manifests/{kind}/{id}/diff)
DiffManifest(w http.ResponseWriter, r *http.Request, kind KindParam, id IdParam, params DiffManifestParams)
// (GET /manifests/{kind}/{id}/document)
GetSharedDocument(w http.ResponseWriter, r *http.Request, kind KindParam, id IdParam)
// GetReferences What a manifest points to, and what points back at it
// (GET /manifests/{kind}/{id}/references)
GetReferences(w http.ResponseWriter, r *http.Request, kind KindParam, id IdParam)
// PostSnapshot Create an explicit snapshot (version) with a reason
// (POST /manifests/{kind}/{id}/snapshots)
PostSnapshot(w http.ResponseWriter, r *http.Request, kind KindParam, id IdParam)
// ListVersions Version history of one manifest
// (GET /manifests/{kind}/{id}/versions)
ListVersions(w http.ResponseWriter, r *http.Request, kind KindParam, id IdParam)
// GetVersion One historical version of a manifest
// (GET /manifests/{kind}/{id}/versions/{n})
GetVersion(w http.ResponseWriter, r *http.Request, kind KindParam, id IdParam, n int)
// DiscardWorking Throw away a staged draft and go back to what the vault holds. The operation that could not exist before drafts were staged: the working copy used to be the file, so there was nothing to go back to. A ref the vault has never held leaves nothing behind, which is the honest answer rather than an empty manifest.
// (DELETE /manifests/{kind}/{id}/working)
DiscardWorking(w http.ResponseWriter, r *http.Request, kind KindParam, id IdParam)
// GetWorking The working copy as last saved, decoded, so an interface or a conformance driver can read the draft back without a version.
// (GET /manifests/{kind}/{id}/working)
GetWorking(w http.ResponseWriter, r *http.Request, kind KindParam, id IdParam)
// PutWorking Stage a draft. Writes to the vault's staging directory, not to the vault's own tree, and does not include the ref: autosave is not a decision to add something to the vault. A save promotes it.
// (PUT /manifests/{kind}/{id}/working)
PutWorking(w http.ResponseWriter, r *http.Request, kind KindParam, id IdParam)
// GetPresenceDocument The document that carries presence for screens not about one manifest
// (GET /presence)
GetPresenceDocument(w http.ResponseWriter, r *http.Request)
// GetSchema The JSON Schema document for a kind
// (GET /schemas/{kind})
GetSchema(w http.ResponseWriter, r *http.Request, kind KindParam)
// GetSession Who this request acts as, as the engine records it
// (GET /session)
GetSession(w http.ResponseWriter, r *http.Request)
// GetSettings The singleton configuration, defaulted where unset
// (GET /settings)
GetSettings(w http.ResponseWriter, r *http.Request)
// ListSnapshots Every snapshot (version) across all kinds, newest first, with pagination
// (GET /snapshots)
ListSnapshots(w http.ResponseWriter, r *http.Request, params ListSnapshotsParams)
// Sync The sync socket (automerge-repo network protocol, version 1)
// (GET /sync)
Sync(w http.ResponseWriter, r *http.Request)
// ValidateManifest Validate a manifest without storing it
// (POST /validate/{kind})
ValidateManifest(w http.ResponseWriter, r *http.Request, kind KindParam)
// GetVault The vault state manifest
// (GET /vault)
GetVault(w http.ResponseWriter, r *http.Request)
// ApplyRef Include a manifest in the live state
// (POST /vault/apply)
ApplyRef(w http.ResponseWriter, r *http.Request)
// ListExcluded Manifests that were excluded from the live state with reasons
// (GET /vault/excluded)
ListExcluded(w http.ResponseWriter, r *http.Request)
// RecoverRef Re-include an excluded manifest in the live state
// (POST /vault/recover)
RecoverRef(w http.ResponseWriter, r *http.Request)
// ListUnapplied Manifest files present but not included in the live state
// (GET /vault/unapplied)
ListUnapplied(w http.ResponseWriter, r *http.Request)
}
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) ApplyRef ¶
func (siw *ServerInterfaceWrapper) ApplyRef(w http.ResponseWriter, r *http.Request)
ApplyRef operation middleware
func (*ServerInterfaceWrapper) DeleteGoal ¶
func (siw *ServerInterfaceWrapper) DeleteGoal(w http.ResponseWriter, r *http.Request)
DeleteGoal operation middleware
func (*ServerInterfaceWrapper) DeleteManifest ¶
func (siw *ServerInterfaceWrapper) DeleteManifest(w http.ResponseWriter, r *http.Request)
DeleteManifest operation middleware
func (*ServerInterfaceWrapper) DiffManifest ¶
func (siw *ServerInterfaceWrapper) DiffManifest(w http.ResponseWriter, r *http.Request)
DiffManifest operation middleware
func (*ServerInterfaceWrapper) DiscardWorking ¶
func (siw *ServerInterfaceWrapper) DiscardWorking(w http.ResponseWriter, r *http.Request)
DiscardWorking operation middleware
func (*ServerInterfaceWrapper) GetCharterPdf ¶
func (siw *ServerInterfaceWrapper) GetCharterPdf(w http.ResponseWriter, r *http.Request)
GetCharterPdf operation middleware
func (*ServerInterfaceWrapper) GetFlow ¶
func (siw *ServerInterfaceWrapper) GetFlow(w http.ResponseWriter, r *http.Request)
GetFlow operation middleware
func (*ServerInterfaceWrapper) GetGapChecks ¶
func (siw *ServerInterfaceWrapper) GetGapChecks(w http.ResponseWriter, r *http.Request)
GetGapChecks operation middleware
func (*ServerInterfaceWrapper) GetGapCoverage ¶
func (siw *ServerInterfaceWrapper) GetGapCoverage(w http.ResponseWriter, r *http.Request)
GetGapCoverage operation middleware
func (*ServerInterfaceWrapper) GetGoalChecks ¶
func (siw *ServerInterfaceWrapper) GetGoalChecks(w http.ResponseWriter, r *http.Request)
GetGoalChecks operation middleware
func (*ServerInterfaceWrapper) GetGoalTree ¶
func (siw *ServerInterfaceWrapper) GetGoalTree(w http.ResponseWriter, r *http.Request)
GetGoalTree operation middleware
func (*ServerInterfaceWrapper) GetHealth ¶
func (siw *ServerInterfaceWrapper) GetHealth(w http.ResponseWriter, r *http.Request)
GetHealth operation middleware
func (*ServerInterfaceWrapper) GetManifest ¶
func (siw *ServerInterfaceWrapper) GetManifest(w http.ResponseWriter, r *http.Request)
GetManifest operation middleware
func (*ServerInterfaceWrapper) GetOperationCharterHtml ¶
func (siw *ServerInterfaceWrapper) GetOperationCharterHtml(w http.ResponseWriter, r *http.Request)
GetOperationCharterHtml operation middleware
func (*ServerInterfaceWrapper) GetOperationChecks ¶
func (siw *ServerInterfaceWrapper) GetOperationChecks(w http.ResponseWriter, r *http.Request)
GetOperationChecks operation middleware
func (*ServerInterfaceWrapper) GetPresenceDocument ¶
func (siw *ServerInterfaceWrapper) GetPresenceDocument(w http.ResponseWriter, r *http.Request)
GetPresenceDocument operation middleware
func (*ServerInterfaceWrapper) GetProgrammeCharterHtml ¶
func (siw *ServerInterfaceWrapper) GetProgrammeCharterHtml(w http.ResponseWriter, r *http.Request)
GetProgrammeCharterHtml operation middleware
func (*ServerInterfaceWrapper) GetProgrammeChecks ¶
func (siw *ServerInterfaceWrapper) GetProgrammeChecks(w http.ResponseWriter, r *http.Request)
GetProgrammeChecks operation middleware
func (*ServerInterfaceWrapper) GetProjectCharterHtml ¶
func (siw *ServerInterfaceWrapper) GetProjectCharterHtml(w http.ResponseWriter, r *http.Request)
GetProjectCharterHtml operation middleware
func (*ServerInterfaceWrapper) GetProjectChecks ¶
func (siw *ServerInterfaceWrapper) GetProjectChecks(w http.ResponseWriter, r *http.Request)
GetProjectChecks operation middleware
func (*ServerInterfaceWrapper) GetProjectState ¶
func (siw *ServerInterfaceWrapper) GetProjectState(w http.ResponseWriter, r *http.Request)
GetProjectState operation middleware
func (*ServerInterfaceWrapper) GetReferences ¶
func (siw *ServerInterfaceWrapper) GetReferences(w http.ResponseWriter, r *http.Request)
GetReferences operation middleware
func (*ServerInterfaceWrapper) GetSchema ¶
func (siw *ServerInterfaceWrapper) GetSchema(w http.ResponseWriter, r *http.Request)
GetSchema operation middleware
func (*ServerInterfaceWrapper) GetSession ¶
func (siw *ServerInterfaceWrapper) GetSession(w http.ResponseWriter, r *http.Request)
GetSession operation middleware
func (*ServerInterfaceWrapper) GetSettings ¶
func (siw *ServerInterfaceWrapper) GetSettings(w http.ResponseWriter, r *http.Request)
GetSettings operation middleware
func (*ServerInterfaceWrapper) GetSharedDocument ¶
func (siw *ServerInterfaceWrapper) GetSharedDocument(w http.ResponseWriter, r *http.Request)
GetSharedDocument operation middleware
func (*ServerInterfaceWrapper) GetVault ¶
func (siw *ServerInterfaceWrapper) GetVault(w http.ResponseWriter, r *http.Request)
GetVault operation middleware
func (*ServerInterfaceWrapper) GetVersion ¶
func (siw *ServerInterfaceWrapper) GetVersion(w http.ResponseWriter, r *http.Request)
GetVersion operation middleware
func (*ServerInterfaceWrapper) GetWorking ¶
func (siw *ServerInterfaceWrapper) GetWorking(w http.ResponseWriter, r *http.Request)
GetWorking operation middleware
func (*ServerInterfaceWrapper) ListExcluded ¶
func (siw *ServerInterfaceWrapper) ListExcluded(w http.ResponseWriter, r *http.Request)
ListExcluded operation middleware
func (*ServerInterfaceWrapper) ListFlows ¶
func (siw *ServerInterfaceWrapper) ListFlows(w http.ResponseWriter, r *http.Request)
ListFlows operation middleware
func (*ServerInterfaceWrapper) ListKinds ¶
func (siw *ServerInterfaceWrapper) ListKinds(w http.ResponseWriter, r *http.Request)
ListKinds operation middleware
func (*ServerInterfaceWrapper) ListManifests ¶
func (siw *ServerInterfaceWrapper) ListManifests(w http.ResponseWriter, r *http.Request)
ListManifests operation middleware
func (*ServerInterfaceWrapper) ListSnapshots ¶
func (siw *ServerInterfaceWrapper) ListSnapshots(w http.ResponseWriter, r *http.Request)
ListSnapshots operation middleware
func (*ServerInterfaceWrapper) ListUnapplied ¶
func (siw *ServerInterfaceWrapper) ListUnapplied(w http.ResponseWriter, r *http.Request)
ListUnapplied operation middleware
func (*ServerInterfaceWrapper) ListVersions ¶
func (siw *ServerInterfaceWrapper) ListVersions(w http.ResponseWriter, r *http.Request)
ListVersions operation middleware
func (*ServerInterfaceWrapper) PostSnapshot ¶
func (siw *ServerInterfaceWrapper) PostSnapshot(w http.ResponseWriter, r *http.Request)
PostSnapshot operation middleware
func (*ServerInterfaceWrapper) PutManifest ¶
func (siw *ServerInterfaceWrapper) PutManifest(w http.ResponseWriter, r *http.Request)
PutManifest operation middleware
func (*ServerInterfaceWrapper) PutWorking ¶
func (siw *ServerInterfaceWrapper) PutWorking(w http.ResponseWriter, r *http.Request)
PutWorking operation middleware
func (*ServerInterfaceWrapper) RecoverRef ¶
func (siw *ServerInterfaceWrapper) RecoverRef(w http.ResponseWriter, r *http.Request)
RecoverRef operation middleware
func (*ServerInterfaceWrapper) Sync ¶
func (siw *ServerInterfaceWrapper) Sync(w http.ResponseWriter, r *http.Request)
Sync operation middleware
func (*ServerInterfaceWrapper) TransitionProjectState ¶
func (siw *ServerInterfaceWrapper) TransitionProjectState(w http.ResponseWriter, r *http.Request)
TransitionProjectState operation middleware
func (*ServerInterfaceWrapper) ValidateManifest ¶
func (siw *ServerInterfaceWrapper) ValidateManifest(w http.ResponseWriter, r *http.Request)
ValidateManifest operation middleware
type Session ¶
type Session struct {
// Actor The principal as the engine records it on versions and state.
Actor string `json:"actor"`
// CanWrite Whether the authorizer allows this principal to write.
CanWrite bool `json:"canWrite"`
// Name A display name, where the authenticator has one; otherwise absent.
Name *string `json:"name,omitempty"`
}
Session defines model for Session.
type Settings ¶
type Settings struct {
// Examples Examples this vault shows per field, in its own words (TAXONOMY.md D20). Absent when the vault supplies none.
Examples *map[string][]string `json:"examples,omitempty"`
// GoalLevels Display names for the three levels, in order goal, objective, outcome.
GoalLevels []string `json:"goalLevels"`
// Operator Author name recorded in versions (default local)
Operator string `json:"operator"`
ProjectLevelName string `json:"projectLevelName"`
// Purpose The vault's vision and mission, stated once above every goal (TAXONOMY.md D24).
Purpose *struct {
Mission *string `json:"mission,omitempty"`
Source *string `json:"source,omitempty"`
Vision *string `json:"vision,omitempty"`
} `json:"purpose,omitempty"`
}
Settings defines model for Settings.
type SharedDocument ¶
SharedDocument defines model for SharedDocument.
type Snapshot ¶
type Snapshot struct {
// Bundle Handoff bundle directory (relative to vault root), when a handoff used this snapshot
Bundle *string `json:"bundle,omitempty"`
// Definition Manifest name
Definition *string `json:"definition,omitempty"`
// Id Manifest id
Id string `json:"id"`
// Kind Manifest kind
Kind string `json:"kind"`
// Number Version number
Number int `json:"number"`
// On When the snapshot was created
On time.Time `json:"on"`
// Reason Reason for this snapshot
Reason string `json:"reason"`
// Version Version identifier (e.g., "v1", "v2")
Version string `json:"version"`
}
Snapshot defines model for Snapshot.
type SnapshotList ¶
type SnapshotList struct {
// Cursor Opaque cursor for the next page, or null when this is the last page
Cursor *string `json:"cursor"`
Snapshots []Snapshot `json:"snapshots"`
}
SnapshotList defines model for SnapshotList.
type StdHTTPServerOptions ¶
type StdHTTPServerOptions struct {
BaseURL string
BaseRouter ServeMux
Middlewares []MiddlewareFunc
ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}
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 {
// ListFlows The kinds that have a flow (a stepped definition, contract/flows). A kind without one is a sheet: one step, every field.
// (GET /flows)
ListFlows(ctx context.Context, request ListFlowsRequestObject) (ListFlowsResponseObject, error)
// GetFlow The flow document for a kind, as written in the contract
// (GET /flows/{kind})
GetFlow(ctx context.Context, request GetFlowRequestObject) (GetFlowResponseObject, error)
// GetGoalTree The goal tree, computed from every Goal manifest and the reference index
// (GET /goals/tree)
GetGoalTree(ctx context.Context, request GetGoalTreeRequestObject) (GetGoalTreeResponseObject, error)
// GetHealth Liveness check
// (GET /health)
GetHealth(ctx context.Context, request GetHealthRequestObject) (GetHealthResponseObject, error)
// ListKinds Every registered kind and how many manifests exist for it
// (GET /kinds)
ListKinds(ctx context.Context, request ListKindsRequestObject) (ListKindsResponseObject, error)
// GetGapChecks Whether a gap can be used for what a gap register is for. Advisory only, like a programme's: every one of these reads a manifest other than the gap.
// (GET /manifests/Gap/{id}/checks)
GetGapChecks(ctx context.Context, request GetGapChecksRequestObject) (GetGapChecksResponseObject, error)
// GetGapCoverage Which part of a gap each piece of work addresses, and which parts nobody does. Derived from the citations, never stored: work declares what it reaches and this reads it back, the same way a programme's members are derived. Addressed, not closed: whether the shortfall narrowed is what the gap's measure reads.
// (GET /manifests/Gap/{id}/coverage)
GetGapCoverage(ctx context.Context, request GetGapCoverageRequestObject) (GetGapCoverageResponseObject, error)
// DeleteGoal Delete a goal (goals are easily mutable). Allowed only when nothing currently references it; every committed version of every manifest remains in the immutable manifest store regardless (a tombstone, not a destructive delete), so this never disturbs history or audit -- it only stops the goal from being listed, picked or resolved as a reference going forward.
// (DELETE /manifests/Goal/{id})
DeleteGoal(ctx context.Context, request DeleteGoalRequestObject) (DeleteGoalResponseObject, error)
// GetGoalChecks Whether a goal can be assessed. Checks never block a save.
// (GET /manifests/Goal/{id}/checks)
GetGoalChecks(ctx context.Context, request GetGoalChecksRequestObject) (GetGoalChecksResponseObject, error)
// GetOperationCharterHtml Operation charter rendered as HTML from the working copy: what the service does and when, who runs it, what it is part of, how it is measured, what it uses and produces, and which projects will hand over to it. Derived, like every other view.
// (GET /manifests/Operation/{id}/charter.html)
GetOperationCharterHtml(ctx context.Context, request GetOperationCharterHtmlRequestObject) (GetOperationCharterHtmlResponseObject, error)
// GetOperationChecks Whether an operation is described well enough to be run and measured, step by step. Advisory only.
// (GET /manifests/Operation/{id}/checks)
GetOperationChecks(ctx context.Context, request GetOperationChecksRequestObject) (GetOperationChecksResponseObject, error)
// GetProgrammeCharterHtml Programme charter rendered as HTML from the working copy: what it is for, what is wrong, what it serves, how it believes the change happens, what is inside it and who runs it. Derived, like every other view, so there is nothing to keep in step.
// (GET /manifests/Programme/{id}/charter.html)
GetProgrammeCharterHtml(ctx context.Context, request GetProgrammeCharterHtmlRequestObject) (GetProgrammeCharterHtmlResponseObject, error)
// GetProgrammeChecks Whether a programme can be judged on what a programme is judged on. Advisory only: none of these has a state that stops anything, because most of them can change when somebody edits a different manifest.
// (GET /manifests/Programme/{id}/checks)
GetProgrammeChecks(ctx context.Context, request GetProgrammeChecksRequestObject) (GetProgrammeChecksResponseObject, error)
// GetProjectCharterHtml Project charter rendered as HTML from the latest snapshot (or working copy with ?working=true).
// (GET /manifests/Project/{id}/charter.html)
GetProjectCharterHtml(ctx context.Context, request GetProjectCharterHtmlRequestObject) (GetProjectCharterHtmlResponseObject, error)
// GetProjectChecks Every per-section check for a project (goals, aim, scope, deliverables, beneficiaries, timeline, data, risks, closing, landing). Checks never block a save; state block stops submission.
// (GET /manifests/Project/{id}/checks)
GetProjectChecks(ctx context.Context, request GetProjectChecksRequestObject) (GetProjectChecksResponseObject, error)
// GetProjectState A project's current state and its full transition history
// (GET /manifests/Project/{id}/state)
GetProjectState(ctx context.Context, request GetProjectStateRequestObject) (GetProjectStateResponseObject, error)
// TransitionProjectState Move a project to a new state. draft to in review is refused with 422 (the blocking checks as problems) unless every blocking check currently passes; cancelled requires a reason; every other move must be the next state in the fixed sequence.
// (POST /manifests/Project/{id}/state)
TransitionProjectState(ctx context.Context, request TransitionProjectStateRequestObject) (TransitionProjectStateResponseObject, error)
// ListManifests Summaries of every manifest of a kind
// (GET /manifests/{kind})
ListManifests(ctx context.Context, request ListManifestsRequestObject) (ListManifestsResponseObject, error)
// DeleteManifest Exclude a manifest from the live state (a tombstone operation). Allowed only when nothing currently references it; the file remains on disk, and the exclusion can be recovered. Applies the leaf rule: a manifest is a leaf if no live manifest references it.
// (DELETE /manifests/{kind}/{id})
DeleteManifest(ctx context.Context, request DeleteManifestRequestObject) (DeleteManifestResponseObject, error)
// GetManifest The current version of one manifest
// (GET /manifests/{kind}/{id})
GetManifest(ctx context.Context, request GetManifestRequestObject) (GetManifestResponseObject, error)
// PutManifest Validate and commit a new version of a manifest: the save that promotes a staged draft into the vault's own tree and its include list, in one atomic journalled write, then clears the draft. Only this ref's draft; other drafts are left alone, because there may be many and saving one is not a decision about the rest.
// (PUT /manifests/{kind}/{id})
PutManifest(ctx context.Context, request PutManifestRequestObject) (PutManifestResponseObject, error)
// GetCharterPdf The charter of a project, programme or operation as a PDF, printed from the same HTML the charter page shows. Needs a chromium: the vault's spec.chromium, the CHROMIUM environment variable, or one on the PATH.
// (GET /manifests/{kind}/{id}/charter.pdf)
GetCharterPdf(ctx context.Context, request GetCharterPdfRequestObject) (GetCharterPdfResponseObject, error)
// DiffManifest Structural diff between two versions
// (GET /manifests/{kind}/{id}/diff)
DiffManifest(ctx context.Context, request DiffManifestRequestObject) (DiffManifestResponseObject, error)
// (GET /manifests/{kind}/{id}/document)
GetSharedDocument(ctx context.Context, request GetSharedDocumentRequestObject) (GetSharedDocumentResponseObject, error)
// GetReferences What a manifest points to, and what points back at it
// (GET /manifests/{kind}/{id}/references)
GetReferences(ctx context.Context, request GetReferencesRequestObject) (GetReferencesResponseObject, error)
// PostSnapshot Create an explicit snapshot (version) with a reason
// (POST /manifests/{kind}/{id}/snapshots)
PostSnapshot(ctx context.Context, request PostSnapshotRequestObject) (PostSnapshotResponseObject, error)
// ListVersions Version history of one manifest
// (GET /manifests/{kind}/{id}/versions)
ListVersions(ctx context.Context, request ListVersionsRequestObject) (ListVersionsResponseObject, error)
// GetVersion One historical version of a manifest
// (GET /manifests/{kind}/{id}/versions/{n})
GetVersion(ctx context.Context, request GetVersionRequestObject) (GetVersionResponseObject, error)
// DiscardWorking Throw away a staged draft and go back to what the vault holds. The operation that could not exist before drafts were staged: the working copy used to be the file, so there was nothing to go back to. A ref the vault has never held leaves nothing behind, which is the honest answer rather than an empty manifest.
// (DELETE /manifests/{kind}/{id}/working)
DiscardWorking(ctx context.Context, request DiscardWorkingRequestObject) (DiscardWorkingResponseObject, error)
// GetWorking The working copy as last saved, decoded, so an interface or a conformance driver can read the draft back without a version.
// (GET /manifests/{kind}/{id}/working)
GetWorking(ctx context.Context, request GetWorkingRequestObject) (GetWorkingResponseObject, error)
// PutWorking Stage a draft. Writes to the vault's staging directory, not to the vault's own tree, and does not include the ref: autosave is not a decision to add something to the vault. A save promotes it.
// (PUT /manifests/{kind}/{id}/working)
PutWorking(ctx context.Context, request PutWorkingRequestObject) (PutWorkingResponseObject, error)
// GetPresenceDocument The document that carries presence for screens not about one manifest
// (GET /presence)
GetPresenceDocument(ctx context.Context, request GetPresenceDocumentRequestObject) (GetPresenceDocumentResponseObject, error)
// GetSchema The JSON Schema document for a kind
// (GET /schemas/{kind})
GetSchema(ctx context.Context, request GetSchemaRequestObject) (GetSchemaResponseObject, error)
// GetSession Who this request acts as, as the engine records it
// (GET /session)
GetSession(ctx context.Context, request GetSessionRequestObject) (GetSessionResponseObject, error)
// GetSettings The singleton configuration, defaulted where unset
// (GET /settings)
GetSettings(ctx context.Context, request GetSettingsRequestObject) (GetSettingsResponseObject, error)
// ListSnapshots Every snapshot (version) across all kinds, newest first, with pagination
// (GET /snapshots)
ListSnapshots(ctx context.Context, request ListSnapshotsRequestObject) (ListSnapshotsResponseObject, error)
// Sync The sync socket (automerge-repo network protocol, version 1)
// (GET /sync)
Sync(ctx context.Context, request SyncRequestObject) (SyncResponseObject, error)
// ValidateManifest Validate a manifest without storing it
// (POST /validate/{kind})
ValidateManifest(ctx context.Context, request ValidateManifestRequestObject) (ValidateManifestResponseObject, error)
// GetVault The vault state manifest
// (GET /vault)
GetVault(ctx context.Context, request GetVaultRequestObject) (GetVaultResponseObject, error)
// ApplyRef Include a manifest in the live state
// (POST /vault/apply)
ApplyRef(ctx context.Context, request ApplyRefRequestObject) (ApplyRefResponseObject, error)
// ListExcluded Manifests that were excluded from the live state with reasons
// (GET /vault/excluded)
ListExcluded(ctx context.Context, request ListExcludedRequestObject) (ListExcludedResponseObject, error)
// RecoverRef Re-include an excluded manifest in the live state
// (POST /vault/recover)
RecoverRef(ctx context.Context, request RecoverRefRequestObject) (RecoverRefResponseObject, error)
// ListUnapplied Manifest files present but not included in the live state
// (GET /vault/unapplied)
ListUnapplied(ctx context.Context, request ListUnappliedRequestObject) (ListUnappliedResponseObject, error)
}
StrictServerInterface represents all server handlers.
type Summary ¶
type Summary struct {
// Draft true when this Summary represents a project that has only ever been saved as a draft, never committed (version is then 0). Present only when kind is Project and includeDrafts=true surfaced it; omitted (never false) for every ordinary, committed Summary.
Draft *bool `json:"draft,omitempty"`
Id string `json:"id"`
Kind string `json:"kind"`
// Labels metadata.labels, carried on the summary so a register can be grouped and filtered without fetching every manifest behind it. Omitted (never {}) where the manifest sets none.
Labels *map[string]string `json:"labels,omitempty"`
Name string `json:"name"`
// Spec The manifest's spec, present only when expand=spec was given.
Spec *map[string]interface{} `json:"spec,omitempty"`
// State The project's current state (see ProjectState). Present only when kind is Project.
State *string `json:"state,omitempty"`
UpdatedOn time.Time `json:"updatedOn"`
Version int `json:"version"`
}
Summary defines model for Summary.
type Sync101Response ¶
type Sync101Response struct {
}
func (Sync101Response) VisitSyncResponse ¶
func (response Sync101Response) VisitSyncResponse(w http.ResponseWriter) error
type Sync401JSONResponse ¶
type Sync401JSONResponse struct{ UnauthenticatedJSONResponse }
func (Sync401JSONResponse) VisitSyncResponse ¶
func (response Sync401JSONResponse) VisitSyncResponse(w http.ResponseWriter) error
type Sync403JSONResponse ¶
type Sync403JSONResponse struct{ ForbiddenJSONResponse }
func (Sync403JSONResponse) VisitSyncResponse ¶
func (response Sync403JSONResponse) VisitSyncResponse(w http.ResponseWriter) error
type Sync426Response ¶
type Sync426Response struct {
}
func (Sync426Response) VisitSyncResponse ¶
func (response Sync426Response) VisitSyncResponse(w http.ResponseWriter) error
type SyncRequestObject ¶
type SyncRequestObject struct {
}
type SyncResponseObject ¶
type SyncResponseObject interface {
VisitSyncResponse(w http.ResponseWriter) error
}
type TooManyValuesForParamError ¶
func (*TooManyValuesForParamError) Error ¶
func (e *TooManyValuesForParamError) Error() string
type TransitionProjectState200JSONResponse ¶
type TransitionProjectState200JSONResponse ProjectState
func (TransitionProjectState200JSONResponse) VisitTransitionProjectStateResponse ¶
func (response TransitionProjectState200JSONResponse) VisitTransitionProjectStateResponse(w http.ResponseWriter) error
type TransitionProjectState401JSONResponse ¶
type TransitionProjectState401JSONResponse struct{ UnauthenticatedJSONResponse }
func (TransitionProjectState401JSONResponse) VisitTransitionProjectStateResponse ¶
func (response TransitionProjectState401JSONResponse) VisitTransitionProjectStateResponse(w http.ResponseWriter) error
type TransitionProjectState403JSONResponse ¶
type TransitionProjectState403JSONResponse struct{ ForbiddenJSONResponse }
func (TransitionProjectState403JSONResponse) VisitTransitionProjectStateResponse ¶
func (response TransitionProjectState403JSONResponse) VisitTransitionProjectStateResponse(w http.ResponseWriter) error
type TransitionProjectState404JSONResponse ¶
type TransitionProjectState404JSONResponse struct{ NotFoundJSONResponse }
func (TransitionProjectState404JSONResponse) VisitTransitionProjectStateResponse ¶
func (response TransitionProjectState404JSONResponse) VisitTransitionProjectStateResponse(w http.ResponseWriter) error
type TransitionProjectState422JSONResponse ¶
type TransitionProjectState422JSONResponse struct{ UnprocessableJSONResponse }
func (TransitionProjectState422JSONResponse) VisitTransitionProjectStateResponse ¶
func (response TransitionProjectState422JSONResponse) VisitTransitionProjectStateResponse(w http.ResponseWriter) error
type TransitionProjectStateJSONRequestBody ¶
type TransitionProjectStateJSONRequestBody = ProjectStateTransitionRequest
TransitionProjectStateJSONRequestBody defines body for TransitionProjectState for application/json ContentType.
type TransitionProjectStateRequestObject ¶
type TransitionProjectStateRequestObject struct {
Id IdParam `json:"id"`
Body *TransitionProjectStateJSONRequestBody
}
type TransitionProjectStateResponseObject ¶
type TransitionProjectStateResponseObject interface {
VisitTransitionProjectStateResponse(w http.ResponseWriter) error
}
type Unauthenticated ¶
type Unauthenticated = ProblemList
Unauthenticated defines model for Unauthenticated.
type UnauthenticatedJSONResponse ¶
type UnauthenticatedJSONResponse ProblemList
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 Unprocessable ¶
type Unprocessable = ProblemList
Unprocessable defines model for Unprocessable.
type UnprocessableJSONResponse ¶
type UnprocessableJSONResponse ProblemList
type ValidateManifest200JSONResponse ¶
type ValidateManifest200JSONResponse ProblemList
func (ValidateManifest200JSONResponse) VisitValidateManifestResponse ¶
func (response ValidateManifest200JSONResponse) VisitValidateManifestResponse(w http.ResponseWriter) error
type ValidateManifest400JSONResponse ¶
type ValidateManifest400JSONResponse struct{ BadRequestJSONResponse }
func (ValidateManifest400JSONResponse) VisitValidateManifestResponse ¶
func (response ValidateManifest400JSONResponse) VisitValidateManifestResponse(w http.ResponseWriter) error
type ValidateManifest401JSONResponse ¶
type ValidateManifest401JSONResponse struct{ UnauthenticatedJSONResponse }
func (ValidateManifest401JSONResponse) VisitValidateManifestResponse ¶
func (response ValidateManifest401JSONResponse) VisitValidateManifestResponse(w http.ResponseWriter) error
type ValidateManifest403JSONResponse ¶
type ValidateManifest403JSONResponse struct{ ForbiddenJSONResponse }
func (ValidateManifest403JSONResponse) VisitValidateManifestResponse ¶
func (response ValidateManifest403JSONResponse) VisitValidateManifestResponse(w http.ResponseWriter) error
type ValidateManifest404JSONResponse ¶
type ValidateManifest404JSONResponse struct{ NotFoundJSONResponse }
func (ValidateManifest404JSONResponse) VisitValidateManifestResponse ¶
func (response ValidateManifest404JSONResponse) VisitValidateManifestResponse(w http.ResponseWriter) error
type ValidateManifestJSONRequestBody ¶
type ValidateManifestJSONRequestBody = ValidateRequest
ValidateManifestJSONRequestBody defines body for ValidateManifest for application/json ContentType.
type ValidateManifestRequestObject ¶
type ValidateManifestRequestObject struct {
Kind KindParam `json:"kind"`
Body *ValidateManifestJSONRequestBody
}
type ValidateManifestResponseObject ¶
type ValidateManifestResponseObject interface {
VisitValidateManifestResponse(w http.ResponseWriter) error
}
type ValidateRequest ¶
type ValidateRequest struct {
Manifest *map[string]interface{} `json:"manifest,omitempty"`
Yaml *string `json:"yaml,omitempty"`
}
ValidateRequest Exactly one of yaml or manifest must be supplied.
type Vault ¶
type Vault struct {
ApiVersion interface{} `json:"apiVersion"`
Kind interface{} `json:"kind"`
Metadata struct {
// Id Vault directory name
Id string `json:"id"`
} `json:"metadata"`
Spec struct {
// Include Manifests in live state (Kind/id, one per line)
Include *[]string `json:"include,omitempty"`
} `json:"spec"`
}
Vault defines model for Vault.
type Version ¶
type Version struct {
Actor string `json:"actor"`
// Draft true when this response is a draft save (X-Cartograph-Draft): number then reflects the current committed version, 0 when the project has never been committed, and no new version was created.
Draft *bool `json:"draft,omitempty"`
Id string `json:"id"`
Kind string `json:"kind"`
Number int `json:"number"`
On time.Time `json:"on"`
Reason string `json:"reason"`
}
Version defines model for Version.
type WriteRequest ¶
type WriteRequest struct {
Manifest *map[string]interface{} `json:"manifest,omitempty"`
Reason string `json:"reason"`
Yaml *string `json:"yaml,omitempty"`
}
WriteRequest Exactly one of yaml or manifest must be supplied.