apigen

package
v2.10.1 Latest Latest
Warning

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

Go to latest
Published: Oct 9, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

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

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 AcceptChangeSet200JSONResponse added in v2.7.0

type AcceptChangeSet200JSONResponse ChangeSet

func (AcceptChangeSet200JSONResponse) VisitAcceptChangeSetResponse added in v2.7.0

func (response AcceptChangeSet200JSONResponse) VisitAcceptChangeSetResponse(w http.ResponseWriter) error

type AcceptChangeSet401JSONResponse added in v2.7.0

type AcceptChangeSet401JSONResponse struct{ UnauthenticatedJSONResponse }

func (AcceptChangeSet401JSONResponse) VisitAcceptChangeSetResponse added in v2.7.0

func (response AcceptChangeSet401JSONResponse) VisitAcceptChangeSetResponse(w http.ResponseWriter) error

type AcceptChangeSet403JSONResponse added in v2.7.0

type AcceptChangeSet403JSONResponse struct{ ForbiddenJSONResponse }

func (AcceptChangeSet403JSONResponse) VisitAcceptChangeSetResponse added in v2.7.0

func (response AcceptChangeSet403JSONResponse) VisitAcceptChangeSetResponse(w http.ResponseWriter) error

type AcceptChangeSet404JSONResponse added in v2.7.0

type AcceptChangeSet404JSONResponse struct{ NotFoundJSONResponse }

func (AcceptChangeSet404JSONResponse) VisitAcceptChangeSetResponse added in v2.7.0

func (response AcceptChangeSet404JSONResponse) VisitAcceptChangeSetResponse(w http.ResponseWriter) error

type AcceptChangeSet409JSONResponse added in v2.7.0

type AcceptChangeSet409JSONResponse ProblemList

func (AcceptChangeSet409JSONResponse) VisitAcceptChangeSetResponse added in v2.7.0

func (response AcceptChangeSet409JSONResponse) VisitAcceptChangeSetResponse(w http.ResponseWriter) error

type AcceptChangeSet422JSONResponse added in v2.7.0

type AcceptChangeSet422JSONResponse struct{ UnprocessableJSONResponse }

func (AcceptChangeSet422JSONResponse) VisitAcceptChangeSetResponse added in v2.7.0

func (response AcceptChangeSet422JSONResponse) VisitAcceptChangeSetResponse(w http.ResponseWriter) error

type AcceptChangeSetJSONRequestBody added in v2.7.0

type AcceptChangeSetJSONRequestBody = ProposalDecision

AcceptChangeSetJSONRequestBody defines body for AcceptChangeSet for application/json ContentType.

type AcceptChangeSetRequestObject added in v2.7.0

type AcceptChangeSetRequestObject struct {
	Set  ChangeSetParam `json:"set"`
	Body *AcceptChangeSetJSONRequestBody
}

type AcceptChangeSetResponseObject added in v2.7.0

type AcceptChangeSetResponseObject interface {
	VisitAcceptChangeSetResponse(w http.ResponseWriter) error
}

type AcceptProposal200JSONResponse added in v2.5.0

type AcceptProposal200JSONResponse Proposal

func (AcceptProposal200JSONResponse) VisitAcceptProposalResponse added in v2.5.0

func (response AcceptProposal200JSONResponse) VisitAcceptProposalResponse(w http.ResponseWriter) error

type AcceptProposal401JSONResponse added in v2.5.0

type AcceptProposal401JSONResponse struct{ UnauthenticatedJSONResponse }

func (AcceptProposal401JSONResponse) VisitAcceptProposalResponse added in v2.5.0

func (response AcceptProposal401JSONResponse) VisitAcceptProposalResponse(w http.ResponseWriter) error

type AcceptProposal403JSONResponse added in v2.5.0

type AcceptProposal403JSONResponse struct{ ForbiddenJSONResponse }

func (AcceptProposal403JSONResponse) VisitAcceptProposalResponse added in v2.5.0

func (response AcceptProposal403JSONResponse) VisitAcceptProposalResponse(w http.ResponseWriter) error

type AcceptProposal404JSONResponse added in v2.5.0

type AcceptProposal404JSONResponse struct{ NotFoundJSONResponse }

func (AcceptProposal404JSONResponse) VisitAcceptProposalResponse added in v2.5.0

func (response AcceptProposal404JSONResponse) VisitAcceptProposalResponse(w http.ResponseWriter) error

type AcceptProposal409JSONResponse added in v2.5.0

type AcceptProposal409JSONResponse ProblemList

func (AcceptProposal409JSONResponse) VisitAcceptProposalResponse added in v2.5.0

func (response AcceptProposal409JSONResponse) VisitAcceptProposalResponse(w http.ResponseWriter) error

type AcceptProposal422JSONResponse added in v2.5.0

type AcceptProposal422JSONResponse struct{ UnprocessableJSONResponse }

func (AcceptProposal422JSONResponse) VisitAcceptProposalResponse added in v2.5.0

func (response AcceptProposal422JSONResponse) VisitAcceptProposalResponse(w http.ResponseWriter) error

type AcceptProposalJSONRequestBody added in v2.5.0

type AcceptProposalJSONRequestBody = ProposalDecision

AcceptProposalJSONRequestBody defines body for AcceptProposal for application/json ContentType.

type AcceptProposalRequestObject added in v2.5.0

type AcceptProposalRequestObject struct {
	Proposal ProposalParam `json:"proposal"`
	Body     *AcceptProposalJSONRequestBody
}

type AcceptProposalResponseObject added in v2.5.0

type AcceptProposalResponseObject interface {
	VisitAcceptProposalResponse(w http.ResponseWriter) error
}

type AgentGrant added in v2.5.0

type AgentGrant struct {
	CreatedAt time.Time `json:"createdAt"`
	ExpiresAt time.Time `json:"expiresAt"`
	Id        string    `json:"id"`

	// Label The agent's name, as it was shown when its person consented.
	Label     string     `json:"label"`
	LastUsed  *time.Time `json:"lastUsed,omitempty"`
	Person    string     `json:"person"`
	RevokedAt *time.Time `json:"revokedAt,omitempty"`
}

AgentGrant One agent a person let act for them (docs/adr/0016). Its token is never kept.

type AgentToken added in v2.5.0

type AgentToken struct {
	// Grant One agent a person let act for them (docs/adr/0016). Its token is never kept.
	Grant AgentGrant `json:"grant"`

	// Token The bearer token, shown once.
	Token string `json:"token"`
}

AgentToken defines model for AgentToken.

type AgentTokenRequest added in v2.5.0

type AgentTokenRequest struct {
	// Days How long the token lasts; 90 days when omitted.
	Days  *int   `json:"days,omitempty"`
	Label string `json:"label"`
}

AgentTokenRequest defines model for AgentTokenRequest.

type AppendSeriesItem200JSONResponse added in v2.3.0

type AppendSeriesItem200JSONResponse Version

func (AppendSeriesItem200JSONResponse) VisitAppendSeriesItemResponse added in v2.3.0

func (response AppendSeriesItem200JSONResponse) VisitAppendSeriesItemResponse(w http.ResponseWriter) error

type AppendSeriesItem400JSONResponse added in v2.3.0

type AppendSeriesItem400JSONResponse struct{ BadRequestJSONResponse }

func (AppendSeriesItem400JSONResponse) VisitAppendSeriesItemResponse added in v2.3.0

func (response AppendSeriesItem400JSONResponse) VisitAppendSeriesItemResponse(w http.ResponseWriter) error

type AppendSeriesItem401JSONResponse added in v2.3.0

type AppendSeriesItem401JSONResponse struct{ UnauthenticatedJSONResponse }

func (AppendSeriesItem401JSONResponse) VisitAppendSeriesItemResponse added in v2.3.0

func (response AppendSeriesItem401JSONResponse) VisitAppendSeriesItemResponse(w http.ResponseWriter) error

type AppendSeriesItem403JSONResponse added in v2.3.0

type AppendSeriesItem403JSONResponse struct{ ForbiddenJSONResponse }

func (AppendSeriesItem403JSONResponse) VisitAppendSeriesItemResponse added in v2.3.0

func (response AppendSeriesItem403JSONResponse) VisitAppendSeriesItemResponse(w http.ResponseWriter) error

type AppendSeriesItem404JSONResponse added in v2.3.0

type AppendSeriesItem404JSONResponse struct{ NotFoundJSONResponse }

func (AppendSeriesItem404JSONResponse) VisitAppendSeriesItemResponse added in v2.3.0

func (response AppendSeriesItem404JSONResponse) VisitAppendSeriesItemResponse(w http.ResponseWriter) error

type AppendSeriesItem409JSONResponse added in v2.3.0

type AppendSeriesItem409JSONResponse struct{ ConflictJSONResponse }

func (AppendSeriesItem409JSONResponse) VisitAppendSeriesItemResponse added in v2.3.0

func (response AppendSeriesItem409JSONResponse) VisitAppendSeriesItemResponse(w http.ResponseWriter) error

type AppendSeriesItem422JSONResponse added in v2.3.0

type AppendSeriesItem422JSONResponse struct{ UnprocessableJSONResponse }

func (AppendSeriesItem422JSONResponse) VisitAppendSeriesItemResponse added in v2.3.0

func (response AppendSeriesItem422JSONResponse) VisitAppendSeriesItemResponse(w http.ResponseWriter) error

type AppendSeriesItemJSONRequestBody added in v2.3.0

type AppendSeriesItemJSONRequestBody = SeriesAppend

AppendSeriesItemJSONRequestBody defines body for AppendSeriesItem for application/json ContentType.

type AppendSeriesItemRequestObject added in v2.3.0

type AppendSeriesItemRequestObject struct {
	Kind   KindParam `json:"kind"`
	Id     IdParam   `json:"id"`
	Series string    `json:"series"`
	Body   *AppendSeriesItemJSONRequestBody
}

type AppendSeriesItemResponseObject added in v2.3.0

type AppendSeriesItemResponseObject interface {
	VisitAppendSeriesItemResponse(w http.ResponseWriter) error
}

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 BadRequest

type BadRequest = ProblemList

BadRequest defines model for BadRequest.

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 ChangeControl added in v2.9.0

type ChangeControl struct {
	// ChangeSetsRequired Every change goes through a change set; direct saves, working copies, snapshots, deletes and project state changes are refused with a problem of type change-control.
	ChangeSetsRequired *bool `json:"changeSetsRequired,omitempty"`

	// RollIn What a change set needs before it is rolled into the record.
	RollIn *struct {
		// ChecksMet Every check on every record in it is met.
		ChecksMet *bool `json:"checksMet,omitempty"`

		// NothingLeftOpen No check is left open for the person, even with a reason.
		NothingLeftOpen *bool `json:"nothingLeftOpen,omitempty"`

		// SecondReviewer Someone other than its author rolls it in.
		SecondReviewer *bool `json:"secondReviewer,omitempty"`
	} `json:"rollIn,omitempty"`
}

ChangeControl How the record may change (docs/adr/0024). Absent or false, every write path works as before.

type ChangeOp

type ChangeOp string

ChangeOp defines model for Change.Op.

const (
	Add     ChangeOp = "add"
	Remove  ChangeOp = "remove"
	Replace ChangeOp = "replace"
)

Defines values for ChangeOp.

func (ChangeOp) Valid

func (e ChangeOp) Valid() bool

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

type ChangeSet added in v2.7.0

type ChangeSet struct {
	// Agent The agent working in it, if one is.
	Agent          *string    `json:"agent,omitempty"`
	At             time.Time  `json:"at"`
	DecidedAt      *time.Time `json:"decidedAt,omitempty"`
	DecidedBy      *string    `json:"decidedBy,omitempty"`
	DecisionReason *string    `json:"decisionReason,omitempty"`
	Description    *string    `json:"description,omitempty"`

	// For The person it is for, who accepts it.
	For *string `json:"for,omitempty"`
	Id  string  `json:"id"`

	// Reason What proposing it said.
	Reason  *string         `json:"reason,omitempty"`
	Status  ChangeSetStatus `json:"status"`
	Title   string          `json:"title"`
	Updated time.Time       `json:"updated"`
	Waivers *[]Waiver       `json:"waivers,omitempty"`
}

ChangeSet A piece of work kept apart from the record and from every other piece of work until it is accepted, as a pull request is (docs/adr/0022).

type ChangeSetDraft added in v2.7.0

type ChangeSetDraft struct {
	// InChangeSet Whether the change set has its own draft of it; false when this is the record.
	InChangeSet bool   `json:"inChangeSet"`
	Yaml        string `json:"yaml"`
}

ChangeSetDraft defines model for ChangeSetDraft.

type ChangeSetEdit added in v2.7.0

type ChangeSetEdit struct {
	// Previous The text the editor last had, so only what it changed since is applied.
	Previous *string `json:"previous,omitempty"`
	Yaml     string  `json:"yaml"`
}

ChangeSetEdit defines model for ChangeSetEdit.

type ChangeSetInclude added in v2.7.0

type ChangeSetInclude struct {
	Included bool `json:"included"`
}

ChangeSetInclude defines model for ChangeSetInclude.

type ChangeSetItem added in v2.7.0

type ChangeSetItem struct {
	At *time.Time `json:"at,omitempty"`

	// Base The version it started from; 0 for a manifest the change set creates.
	Base int     `json:"base"`
	By   *string `json:"by,omitempty"`

	// Changes What accepting it would change, against the version it started from.
	Changes []Change        `json:"changes"`
	Checks  []ManifestCheck `json:"checks"`
	Id      string          `json:"id"`

	// Included False for an item trimmed from the next acceptance.
	Included bool    `json:"included"`
	Kind     string  `json:"kind"`
	Name     *string `json:"name,omitempty"`

	// Op What rolling it in does to the record: saves the draft as the next version, deletes the record, or moves a project to state.
	Op *ChangeSetItemOp `json:"op,omitempty"`

	// Proposed Present when read with changeSet and the change set creates this record (new) or changes it (changed); absent otherwise.
	Proposed *Proposed `json:"proposed,omitempty"`

	// Stale The version saved since it started, when one was; accepting is refused until it is reviewed again.
	Stale *int `json:"stale,omitempty"`

	// State The state a project moves to, when op is state.
	State *string `json:"state,omitempty"`
}

ChangeSetItem defines model for ChangeSetItem.

type ChangeSetItemOp added in v2.9.0

type ChangeSetItemOp string

ChangeSetItemOp What rolling it in does to the record: saves the draft as the next version, deletes the record, or moves a project to state.

const (
	ChangeSetItemOpDelete ChangeSetItemOp = "delete"
	ChangeSetItemOpSave   ChangeSetItemOp = "save"
	ChangeSetItemOpState  ChangeSetItemOp = "state"
)

Defines values for ChangeSetItemOp.

func (ChangeSetItemOp) Valid added in v2.9.0

func (e ChangeSetItemOp) Valid() bool

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

type ChangeSetParam added in v2.7.0

type ChangeSetParam = string

ChangeSetParam defines model for ChangeSetParam.

type ChangeSetProposal added in v2.7.0

type ChangeSetProposal struct {
	// OpenChecks Checks left open, by Kind/id, then check id, each with why.
	OpenChecks *map[string]map[string]string `json:"openChecks,omitempty"`
	Reason     *string                       `json:"reason,omitempty"`
}

ChangeSetProposal defines model for ChangeSetProposal.

type ChangeSetRequired added in v2.9.0

type ChangeSetRequired = ProblemList

ChangeSetRequired defines model for ChangeSetRequired.

type ChangeSetRequiredJSONResponse added in v2.9.0

type ChangeSetRequiredJSONResponse ProblemList

type ChangeSetReview added in v2.7.0

type ChangeSetReview struct {
	// ChangeSet A piece of work kept apart from the record and from every other piece of work until it is accepted, as a pull request is (docs/adr/0022).
	ChangeSet ChangeSet       `json:"changeSet"`
	Items     []ChangeSetItem `json:"items"`
}

ChangeSetReview defines model for ChangeSetReview.

type ChangeSetStatus added in v2.7.0

type ChangeSetStatus string

ChangeSetStatus defines model for ChangeSet.Status.

const (
	ChangeSetStatusClosed   ChangeSetStatus = "closed"
	ChangeSetStatusMerged   ChangeSetStatus = "merged"
	ChangeSetStatusMerging  ChangeSetStatus = "merging"
	ChangeSetStatusOpen     ChangeSetStatus = "open"
	ChangeSetStatusProposed ChangeSetStatus = "proposed"
)

Defines values for ChangeSetStatus.

func (ChangeSetStatus) Valid added in v2.7.0

func (e ChangeSetStatus) Valid() bool

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

type ChangeSetTitle added in v2.7.0

type ChangeSetTitle struct {
	Description *string `json:"description,omitempty"`
	Title       *string `json:"title,omitempty"`
}

ChangeSetTitle defines model for ChangeSetTitle.

type ClassifyStructure200JSONResponse added in v2.10.0

type ClassifyStructure200JSONResponse Structure

func (ClassifyStructure200JSONResponse) VisitClassifyStructureResponse added in v2.10.0

func (response ClassifyStructure200JSONResponse) VisitClassifyStructureResponse(w http.ResponseWriter) error

type ClassifyStructure401JSONResponse added in v2.10.0

type ClassifyStructure401JSONResponse struct{ UnauthenticatedJSONResponse }

func (ClassifyStructure401JSONResponse) VisitClassifyStructureResponse added in v2.10.0

func (response ClassifyStructure401JSONResponse) VisitClassifyStructureResponse(w http.ResponseWriter) error

type ClassifyStructureJSONBody added in v2.10.0

type ClassifyStructureJSONBody struct {
	Pieces []StructurePiece `json:"pieces"`
}

ClassifyStructureJSONBody defines parameters for ClassifyStructure.

type ClassifyStructureJSONRequestBody added in v2.10.0

type ClassifyStructureJSONRequestBody ClassifyStructureJSONBody

ClassifyStructureJSONRequestBody defines body for ClassifyStructure for application/json ContentType.

type ClassifyStructureRequestObject added in v2.10.0

type ClassifyStructureRequestObject struct {
	Body *ClassifyStructureJSONRequestBody
}

type ClassifyStructureResponseObject added in v2.10.0

type ClassifyStructureResponseObject interface {
	VisitClassifyStructureResponse(w http.ResponseWriter) error
}

type CloseChangeSet200JSONResponse added in v2.7.0

type CloseChangeSet200JSONResponse ChangeSet

func (CloseChangeSet200JSONResponse) VisitCloseChangeSetResponse added in v2.7.0

func (response CloseChangeSet200JSONResponse) VisitCloseChangeSetResponse(w http.ResponseWriter) error

type CloseChangeSet401JSONResponse added in v2.7.0

type CloseChangeSet401JSONResponse struct{ UnauthenticatedJSONResponse }

func (CloseChangeSet401JSONResponse) VisitCloseChangeSetResponse added in v2.7.0

func (response CloseChangeSet401JSONResponse) VisitCloseChangeSetResponse(w http.ResponseWriter) error

type CloseChangeSet403JSONResponse added in v2.7.0

type CloseChangeSet403JSONResponse struct{ ForbiddenJSONResponse }

func (CloseChangeSet403JSONResponse) VisitCloseChangeSetResponse added in v2.7.0

func (response CloseChangeSet403JSONResponse) VisitCloseChangeSetResponse(w http.ResponseWriter) error

type CloseChangeSet404JSONResponse added in v2.7.0

type CloseChangeSet404JSONResponse struct{ NotFoundJSONResponse }

func (CloseChangeSet404JSONResponse) VisitCloseChangeSetResponse added in v2.7.0

func (response CloseChangeSet404JSONResponse) VisitCloseChangeSetResponse(w http.ResponseWriter) error

type CloseChangeSet409JSONResponse added in v2.7.0

type CloseChangeSet409JSONResponse ProblemList

func (CloseChangeSet409JSONResponse) VisitCloseChangeSetResponse added in v2.7.0

func (response CloseChangeSet409JSONResponse) VisitCloseChangeSetResponse(w http.ResponseWriter) error

type CloseChangeSetJSONRequestBody added in v2.7.0

type CloseChangeSetJSONRequestBody = ProposalDecision

CloseChangeSetJSONRequestBody defines body for CloseChangeSet for application/json ContentType.

type CloseChangeSetRequestObject added in v2.7.0

type CloseChangeSetRequestObject struct {
	Set  ChangeSetParam `json:"set"`
	Body *CloseChangeSetJSONRequestBody
}

type CloseChangeSetResponseObject added in v2.7.0

type CloseChangeSetResponseObject interface {
	VisitCloseChangeSetResponse(w http.ResponseWriter) error
}

type ComponentEdge added in v2.9.0

type ComponentEdge struct {
	From WorkRef `json:"from"`

	// Legacy Read from an older declaration made on the component (a project's alignment.partOf or alignment.programmes, a programme's programmes).
	Legacy *bool   `json:"legacy,omitempty"`
	To     WorkRef `json:"to"`
	Why    *string `json:"why,omitempty"`
}

ComponentEdge defines model for ComponentEdge.

type ComponentGraph added in v2.9.0

type ComponentGraph struct {
	// CriticalMonths The critical path's length on the calendar, in months, both ends counted.
	CriticalMonths int `json:"criticalMonths"`

	// CriticalPath The chain of components that runs longest on the calendar, from the earliest start on it to the latest finish, from the work that depends to the work depended on.
	CriticalPath []WorkRef       `json:"criticalPath"`
	Edges        []ComponentEdge `json:"edges"`

	// Loops Each loop in order, ending where it began.
	Loops [][]WorkRef     `json:"loops"`
	Nodes []ComponentNode `json:"nodes"`
}

ComponentGraph defines model for ComponentGraph.

type ComponentNode added in v2.9.0

type ComponentNode struct {
	// Critical On the critical path.
	Critical bool `json:"critical"`

	// Dependents How many projects and programmes depend on it, directly or through others.
	Dependents int    `json:"dependents"`
	Id         string `json:"id"`

	// InLoop On a loop of components.
	InLoop bool              `json:"inLoop"`
	Kind   ComponentNodeKind `json:"kind"`

	// Months How long it takes itself; a programme takes none of its own.
	Months int `json:"months"`

	// MostDependedOn More work depends on it than on any other, and at least two.
	MostDependedOn bool   `json:"mostDependedOn"`
	Name           string `json:"name"`
}

ComponentNode defines model for ComponentNode.

type ComponentNodeKind added in v2.9.0

type ComponentNodeKind string

ComponentNodeKind defines model for ComponentNode.Kind.

const (
	ComponentNodeKindProgramme ComponentNodeKind = "Programme"
	ComponentNodeKindProject   ComponentNodeKind = "Project"
)

Defines values for ComponentNodeKind.

func (ComponentNodeKind) Valid added in v2.9.0

func (e ComponentNodeKind) Valid() bool

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

type Conflict

type Conflict = ConflictResponse

Conflict defines model for Conflict.

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 ControlChart added in v2.10.0

type ControlChart struct {
	Centre float32  `json:"centre"`
	Cp     *float32 `json:"cp,omitempty"`
	Cpk    *float32 `json:"cpk,omitempty"`

	// Enough Twenty readings or more, the fewest the limits are usually trusted from.
	Enough bool    `json:"enough"`
	Kpi    string  `json:"kpi"`
	Lower  float32 `json:"lower"`
	Note   *string `json:"note,omitempty"`
	Points []struct {
		Period      string                       `json:"period"`
		Provisional *bool                        `json:"provisional,omitempty"`
		Signals     *[]ControlChartPointsSignals `json:"signals,omitempty"`
		Value       float32                      `json:"value"`
	} `json:"points"`
	Sigma      float32  `json:"sigma"`
	SigmaLevel *float32 `json:"sigmaLevel,omitempty"`
	SpecLower  *float32 `json:"specLower,omitempty"`
	SpecUpper  *float32 `json:"specUpper,omitempty"`
	Stable     bool     `json:"stable"`
	Upper      float32  `json:"upper"`
}

ControlChart defines model for ControlChart.

type ControlChartPointsSignals added in v2.10.0

type ControlChartPointsSignals string

ControlChartPointsSignals defines model for ControlChart.Points.Signals.

const (
	Beyond ControlChartPointsSignals = "beyond"
	Run    ControlChartPointsSignals = "run"
	Trend  ControlChartPointsSignals = "trend"
)

Defines values for ControlChartPointsSignals.

func (ControlChartPointsSignals) Valid added in v2.10.0

func (e ControlChartPointsSignals) Valid() bool

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

type CreateAgentToken201JSONResponse added in v2.5.0

type CreateAgentToken201JSONResponse AgentToken

func (CreateAgentToken201JSONResponse) VisitCreateAgentTokenResponse added in v2.5.0

func (response CreateAgentToken201JSONResponse) VisitCreateAgentTokenResponse(w http.ResponseWriter) error

type CreateAgentToken401JSONResponse added in v2.5.0

type CreateAgentToken401JSONResponse struct{ UnauthenticatedJSONResponse }

func (CreateAgentToken401JSONResponse) VisitCreateAgentTokenResponse added in v2.5.0

func (response CreateAgentToken401JSONResponse) VisitCreateAgentTokenResponse(w http.ResponseWriter) error

type CreateAgentToken403JSONResponse added in v2.5.0

type CreateAgentToken403JSONResponse struct{ ForbiddenJSONResponse }

func (CreateAgentToken403JSONResponse) VisitCreateAgentTokenResponse added in v2.5.0

func (response CreateAgentToken403JSONResponse) VisitCreateAgentTokenResponse(w http.ResponseWriter) error

type CreateAgentToken404JSONResponse added in v2.5.0

type CreateAgentToken404JSONResponse struct{ NotFoundJSONResponse }

func (CreateAgentToken404JSONResponse) VisitCreateAgentTokenResponse added in v2.5.0

func (response CreateAgentToken404JSONResponse) VisitCreateAgentTokenResponse(w http.ResponseWriter) error

type CreateAgentToken422JSONResponse added in v2.5.0

type CreateAgentToken422JSONResponse struct{ UnprocessableJSONResponse }

func (CreateAgentToken422JSONResponse) VisitCreateAgentTokenResponse added in v2.5.0

func (response CreateAgentToken422JSONResponse) VisitCreateAgentTokenResponse(w http.ResponseWriter) error

type CreateAgentTokenJSONRequestBody added in v2.5.0

type CreateAgentTokenJSONRequestBody = AgentTokenRequest

CreateAgentTokenJSONRequestBody defines body for CreateAgentToken for application/json ContentType.

type CreateAgentTokenRequestObject added in v2.5.0

type CreateAgentTokenRequestObject struct {
	Body *CreateAgentTokenJSONRequestBody
}

type CreateAgentTokenResponseObject added in v2.5.0

type CreateAgentTokenResponseObject interface {
	VisitCreateAgentTokenResponse(w http.ResponseWriter) error
}

type CyclePeriod added in v2.9.0

type CyclePeriod struct {
	// Due The day the period's reading is due.
	Due openapi_types.Date `json:"due"`

	// End The month the period ends, YYYY-MM; the key its reading is filed under.
	End string `json:"end"`

	// Label What a person reads, where the cycle names its periods: the name with its year for a yearly period (Term I 2026/27), the name alone for a dated one. Absent for equal periods, which are named by month.
	Label *string `json:"label,omitempty"`

	// Name The period's name, where the cycle names its periods.
	Name *string `json:"name,omitempty"`

	// Start The month it starts, YYYY-MM.
	Start string `json:"start"`
}

CyclePeriod One period of a reporting cycle.

type DMAIC added in v2.10.0

type DMAIC struct {
	Phases []struct {
		Items []struct {
			Field   string  `json:"field"`
			Key     string  `json:"key"`
			Lacking *string `json:"lacking,omitempty"`
			Met     bool    `json:"met"`
			Phase   string  `json:"phase"`
			Says    string  `json:"says"`
		} `json:"items"`
		Met   int              `json:"met"`
		Of    int              `json:"of"`
		Phase DMAICPhasesPhase `json:"phase"`
	} `json:"phases"`
	Project string `json:"project"`
}

DMAIC defines model for DMAIC.

type DMAICPhasesPhase added in v2.10.0

type DMAICPhasesPhase string

DMAICPhasesPhase defines model for DMAIC.Phases.Phase.

const (
	Analyze DMAICPhasesPhase = "analyze"
	Control DMAICPhasesPhase = "control"
	Define  DMAICPhasesPhase = "define"
	Improve DMAICPhasesPhase = "improve"
	Measure DMAICPhasesPhase = "measure"
)

Defines values for DMAICPhasesPhase.

func (DMAICPhasesPhase) Valid added in v2.10.0

func (e DMAICPhasesPhase) Valid() bool

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

type DecisionModel added in v2.9.0

type DecisionModel struct {
	Configured bool `json:"configured"`

	// Off While no model answers, what is not judged meanwhile, in plain words (docs/adr/0030).
	Off   *[]string `json:"off,omitempty"`
	Ready bool      `json:"ready"`
}

DecisionModel defines model for DecisionModel.

type DeclineProposal200JSONResponse added in v2.5.0

type DeclineProposal200JSONResponse Proposal

func (DeclineProposal200JSONResponse) VisitDeclineProposalResponse added in v2.5.0

func (response DeclineProposal200JSONResponse) VisitDeclineProposalResponse(w http.ResponseWriter) error

type DeclineProposal401JSONResponse added in v2.5.0

type DeclineProposal401JSONResponse struct{ UnauthenticatedJSONResponse }

func (DeclineProposal401JSONResponse) VisitDeclineProposalResponse added in v2.5.0

func (response DeclineProposal401JSONResponse) VisitDeclineProposalResponse(w http.ResponseWriter) error

type DeclineProposal403JSONResponse added in v2.5.0

type DeclineProposal403JSONResponse struct{ ForbiddenJSONResponse }

func (DeclineProposal403JSONResponse) VisitDeclineProposalResponse added in v2.5.0

func (response DeclineProposal403JSONResponse) VisitDeclineProposalResponse(w http.ResponseWriter) error

type DeclineProposal404JSONResponse added in v2.5.0

type DeclineProposal404JSONResponse struct{ NotFoundJSONResponse }

func (DeclineProposal404JSONResponse) VisitDeclineProposalResponse added in v2.5.0

func (response DeclineProposal404JSONResponse) VisitDeclineProposalResponse(w http.ResponseWriter) error

type DeclineProposal409JSONResponse added in v2.5.0

type DeclineProposal409JSONResponse ProblemList

func (DeclineProposal409JSONResponse) VisitDeclineProposalResponse added in v2.5.0

func (response DeclineProposal409JSONResponse) VisitDeclineProposalResponse(w http.ResponseWriter) error

type DeclineProposalJSONRequestBody added in v2.5.0

type DeclineProposalJSONRequestBody = ProposalDecision

DeclineProposalJSONRequestBody defines body for DeclineProposal for application/json ContentType.

type DeclineProposalRequestObject added in v2.5.0

type DeclineProposalRequestObject struct {
	Proposal ProposalParam `json:"proposal"`
	Body     *DeclineProposalJSONRequestBody
}

type DeclineProposalResponseObject added in v2.5.0

type DeclineProposalResponseObject interface {
	VisitDeclineProposalResponse(w http.ResponseWriter) error
}

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 DeleteGoal409JSONResponse added in v2.9.0

type DeleteGoal409JSONResponse struct{ ChangeSetRequiredJSONResponse }

func (DeleteGoal409JSONResponse) VisitDeleteGoalResponse added in v2.9.0

func (response DeleteGoal409JSONResponse) 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 DeleteManifest409JSONResponse added in v2.9.0

type DeleteManifest409JSONResponse struct{ ChangeSetRequiredJSONResponse }

func (DeleteManifest409JSONResponse) VisitDeleteManifestResponse added in v2.9.0

func (response DeleteManifest409JSONResponse) 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

type DiffManifestParams struct {
	From int `form:"from" json:"from"`
	To   int `form:"to" json:"to"`
}

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 DiscardWorkingRequestObject

type DiscardWorkingRequestObject struct {
	Kind KindParam `json:"kind"`
	Id   IdParam   `json:"id"`
}

type DiscardWorkingResponseObject

type DiscardWorkingResponseObject interface {
	VisitDiscardWorkingResponse(w http.ResponseWriter) error
}

type DropChangeSetItem204Response added in v2.7.0

type DropChangeSetItem204Response struct {
}

func (DropChangeSetItem204Response) VisitDropChangeSetItemResponse added in v2.7.0

func (response DropChangeSetItem204Response) VisitDropChangeSetItemResponse(w http.ResponseWriter) error

type DropChangeSetItem401JSONResponse added in v2.7.0

type DropChangeSetItem401JSONResponse struct{ UnauthenticatedJSONResponse }

func (DropChangeSetItem401JSONResponse) VisitDropChangeSetItemResponse added in v2.7.0

func (response DropChangeSetItem401JSONResponse) VisitDropChangeSetItemResponse(w http.ResponseWriter) error

type DropChangeSetItem403JSONResponse added in v2.7.0

type DropChangeSetItem403JSONResponse struct{ ForbiddenJSONResponse }

func (DropChangeSetItem403JSONResponse) VisitDropChangeSetItemResponse added in v2.7.0

func (response DropChangeSetItem403JSONResponse) VisitDropChangeSetItemResponse(w http.ResponseWriter) error

type DropChangeSetItem404JSONResponse added in v2.7.0

type DropChangeSetItem404JSONResponse struct{ NotFoundJSONResponse }

func (DropChangeSetItem404JSONResponse) VisitDropChangeSetItemResponse added in v2.7.0

func (response DropChangeSetItem404JSONResponse) VisitDropChangeSetItemResponse(w http.ResponseWriter) error

type DropChangeSetItem409JSONResponse added in v2.7.0

type DropChangeSetItem409JSONResponse ProblemList

func (DropChangeSetItem409JSONResponse) VisitDropChangeSetItemResponse added in v2.7.0

func (response DropChangeSetItem409JSONResponse) VisitDropChangeSetItemResponse(w http.ResponseWriter) error

type DropChangeSetItemRequestObject added in v2.7.0

type DropChangeSetItemRequestObject struct {
	Set  ChangeSetParam `json:"set"`
	Kind KindParam      `json:"kind"`
	Id   IdParam        `json:"id"`
}

type DropChangeSetItemResponseObject added in v2.7.0

type DropChangeSetItemResponseObject interface {
	VisitDropChangeSetItemResponse(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 ExportSemanticLayer200JSONResponse added in v2.10.0

type ExportSemanticLayer200JSONResponse SemanticExport

func (ExportSemanticLayer200JSONResponse) VisitExportSemanticLayerResponse added in v2.10.0

func (response ExportSemanticLayer200JSONResponse) VisitExportSemanticLayerResponse(w http.ResponseWriter) error

type ExportSemanticLayer401JSONResponse added in v2.10.0

type ExportSemanticLayer401JSONResponse struct{ UnauthenticatedJSONResponse }

func (ExportSemanticLayer401JSONResponse) VisitExportSemanticLayerResponse added in v2.10.0

func (response ExportSemanticLayer401JSONResponse) VisitExportSemanticLayerResponse(w http.ResponseWriter) error

type ExportSemanticLayer403JSONResponse added in v2.10.0

type ExportSemanticLayer403JSONResponse struct{ ForbiddenJSONResponse }

func (ExportSemanticLayer403JSONResponse) VisitExportSemanticLayerResponse added in v2.10.0

func (response ExportSemanticLayer403JSONResponse) VisitExportSemanticLayerResponse(w http.ResponseWriter) error

type ExportSemanticLayer404JSONResponse added in v2.10.0

type ExportSemanticLayer404JSONResponse Problem

func (ExportSemanticLayer404JSONResponse) VisitExportSemanticLayerResponse added in v2.10.0

func (response ExportSemanticLayer404JSONResponse) VisitExportSemanticLayerResponse(w http.ResponseWriter) error

type ExportSemanticLayerParams added in v2.10.0

type ExportSemanticLayerParams struct {
	// ChangeSet Read as if this change set were accepted (docs/adr/0024): its drafts stand in for the records they change, and the records it creates are there too, each marked proposed. For reviewing a change set in the ordinary screens.
	ChangeSet *PreviewParam `form:"changeSet,omitempty" json:"changeSet,omitempty"`

	// Format The syntax, such as dbt; the first the deployment writes when left out.
	Format *string `form:"format,omitempty" json:"format,omitempty"`
}

ExportSemanticLayerParams defines parameters for ExportSemanticLayer.

type ExportSemanticLayerRequestObject added in v2.10.0

type ExportSemanticLayerRequestObject struct {
	Params ExportSemanticLayerParams
}

type ExportSemanticLayerResponseObject added in v2.10.0

type ExportSemanticLayerResponseObject interface {
	VisitExportSemanticLayerResponse(w http.ResponseWriter) error
}

type Forbidden

type Forbidden = ProblemList

Forbidden defines model for Forbidden.

type ForbiddenJSONResponse

type ForbiddenJSONResponse ProblemList

type FromIdea200JSONResponse added in v2.9.0

type FromIdea200JSONResponse IdeaReading

func (FromIdea200JSONResponse) VisitFromIdeaResponse added in v2.9.0

func (response FromIdea200JSONResponse) VisitFromIdeaResponse(w http.ResponseWriter) error

type FromIdea401JSONResponse added in v2.9.0

type FromIdea401JSONResponse struct{ UnauthenticatedJSONResponse }

func (FromIdea401JSONResponse) VisitFromIdeaResponse added in v2.9.0

func (response FromIdea401JSONResponse) VisitFromIdeaResponse(w http.ResponseWriter) error

type FromIdea403JSONResponse added in v2.9.0

type FromIdea403JSONResponse struct{ ForbiddenJSONResponse }

func (FromIdea403JSONResponse) VisitFromIdeaResponse added in v2.9.0

func (response FromIdea403JSONResponse) VisitFromIdeaResponse(w http.ResponseWriter) error

type FromIdeaJSONBody added in v2.9.0

type FromIdeaJSONBody struct {
	Idea string `json:"idea"`
	Kind string `json:"kind"`
}

FromIdeaJSONBody defines parameters for FromIdea.

type FromIdeaJSONRequestBody added in v2.9.0

type FromIdeaJSONRequestBody FromIdeaJSONBody

FromIdeaJSONRequestBody defines body for FromIdea for application/json ContentType.

type FromIdeaRequestObject added in v2.9.0

type FromIdeaRequestObject struct {
	Body *FromIdeaJSONRequestBody
}

type FromIdeaResponseObject added in v2.9.0

type FromIdeaResponseObject interface {
	VisitFromIdeaResponse(w http.ResponseWriter) error
}

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 GetAgentFeed200JSONResponse added in v2.6.0

type GetAgentFeed200JSONResponse SharedDocument

func (GetAgentFeed200JSONResponse) VisitGetAgentFeedResponse added in v2.6.0

func (response GetAgentFeed200JSONResponse) VisitGetAgentFeedResponse(w http.ResponseWriter) error

type GetAgentFeed401JSONResponse added in v2.6.0

type GetAgentFeed401JSONResponse struct{ UnauthenticatedJSONResponse }

func (GetAgentFeed401JSONResponse) VisitGetAgentFeedResponse added in v2.6.0

func (response GetAgentFeed401JSONResponse) VisitGetAgentFeedResponse(w http.ResponseWriter) error

type GetAgentFeed403JSONResponse added in v2.6.0

type GetAgentFeed403JSONResponse struct{ ForbiddenJSONResponse }

func (GetAgentFeed403JSONResponse) VisitGetAgentFeedResponse added in v2.6.0

func (response GetAgentFeed403JSONResponse) VisitGetAgentFeedResponse(w http.ResponseWriter) error

type GetAgentFeed404JSONResponse added in v2.6.0

type GetAgentFeed404JSONResponse struct{ NotFoundJSONResponse }

func (GetAgentFeed404JSONResponse) VisitGetAgentFeedResponse added in v2.6.0

func (response GetAgentFeed404JSONResponse) VisitGetAgentFeedResponse(w http.ResponseWriter) error

type GetAgentFeedParams added in v2.6.0

type GetAgentFeedParams struct {
	Person *string `form:"person,omitempty" json:"person,omitempty"`
}

GetAgentFeedParams defines parameters for GetAgentFeed.

type GetAgentFeedRequestObject added in v2.6.0

type GetAgentFeedRequestObject struct {
	Params GetAgentFeedParams
}

type GetAgentFeedResponseObject added in v2.6.0

type GetAgentFeedResponseObject interface {
	VisitGetAgentFeedResponse(w http.ResponseWriter) error
}

type GetChangeSet200JSONResponse added in v2.7.0

type GetChangeSet200JSONResponse ChangeSetReview

func (GetChangeSet200JSONResponse) VisitGetChangeSetResponse added in v2.7.0

func (response GetChangeSet200JSONResponse) VisitGetChangeSetResponse(w http.ResponseWriter) error

type GetChangeSet401JSONResponse added in v2.7.0

type GetChangeSet401JSONResponse struct{ UnauthenticatedJSONResponse }

func (GetChangeSet401JSONResponse) VisitGetChangeSetResponse added in v2.7.0

func (response GetChangeSet401JSONResponse) VisitGetChangeSetResponse(w http.ResponseWriter) error

type GetChangeSet403JSONResponse added in v2.7.0

type GetChangeSet403JSONResponse struct{ ForbiddenJSONResponse }

func (GetChangeSet403JSONResponse) VisitGetChangeSetResponse added in v2.7.0

func (response GetChangeSet403JSONResponse) VisitGetChangeSetResponse(w http.ResponseWriter) error

type GetChangeSet404JSONResponse added in v2.7.0

type GetChangeSet404JSONResponse struct{ NotFoundJSONResponse }

func (GetChangeSet404JSONResponse) VisitGetChangeSetResponse added in v2.7.0

func (response GetChangeSet404JSONResponse) VisitGetChangeSetResponse(w http.ResponseWriter) error

type GetChangeSetDocument200JSONResponse added in v2.9.0

type GetChangeSetDocument200JSONResponse SharedDocument

func (GetChangeSetDocument200JSONResponse) VisitGetChangeSetDocumentResponse added in v2.9.0

func (response GetChangeSetDocument200JSONResponse) VisitGetChangeSetDocumentResponse(w http.ResponseWriter) error

type GetChangeSetDocument401JSONResponse added in v2.9.0

type GetChangeSetDocument401JSONResponse struct{ UnauthenticatedJSONResponse }

func (GetChangeSetDocument401JSONResponse) VisitGetChangeSetDocumentResponse added in v2.9.0

func (response GetChangeSetDocument401JSONResponse) VisitGetChangeSetDocumentResponse(w http.ResponseWriter) error

type GetChangeSetDocument403JSONResponse added in v2.9.0

type GetChangeSetDocument403JSONResponse struct{ ForbiddenJSONResponse }

func (GetChangeSetDocument403JSONResponse) VisitGetChangeSetDocumentResponse added in v2.9.0

func (response GetChangeSetDocument403JSONResponse) VisitGetChangeSetDocumentResponse(w http.ResponseWriter) error

type GetChangeSetDocument404JSONResponse added in v2.9.0

type GetChangeSetDocument404JSONResponse struct{ NotFoundJSONResponse }

func (GetChangeSetDocument404JSONResponse) VisitGetChangeSetDocumentResponse added in v2.9.0

func (response GetChangeSetDocument404JSONResponse) VisitGetChangeSetDocumentResponse(w http.ResponseWriter) error

type GetChangeSetDocumentRequestObject added in v2.9.0

type GetChangeSetDocumentRequestObject struct {
	Set  ChangeSetParam `json:"set"`
	Kind KindParam      `json:"kind"`
	Id   IdParam        `json:"id"`
}

type GetChangeSetDocumentResponseObject added in v2.9.0

type GetChangeSetDocumentResponseObject interface {
	VisitGetChangeSetDocumentResponse(w http.ResponseWriter) error
}

type GetChangeSetItem200JSONResponse added in v2.7.0

type GetChangeSetItem200JSONResponse ChangeSetDraft

func (GetChangeSetItem200JSONResponse) VisitGetChangeSetItemResponse added in v2.7.0

func (response GetChangeSetItem200JSONResponse) VisitGetChangeSetItemResponse(w http.ResponseWriter) error

type GetChangeSetItem401JSONResponse added in v2.7.0

type GetChangeSetItem401JSONResponse struct{ UnauthenticatedJSONResponse }

func (GetChangeSetItem401JSONResponse) VisitGetChangeSetItemResponse added in v2.7.0

func (response GetChangeSetItem401JSONResponse) VisitGetChangeSetItemResponse(w http.ResponseWriter) error

type GetChangeSetItem403JSONResponse added in v2.7.0

type GetChangeSetItem403JSONResponse struct{ ForbiddenJSONResponse }

func (GetChangeSetItem403JSONResponse) VisitGetChangeSetItemResponse added in v2.7.0

func (response GetChangeSetItem403JSONResponse) VisitGetChangeSetItemResponse(w http.ResponseWriter) error

type GetChangeSetItem404JSONResponse added in v2.7.0

type GetChangeSetItem404JSONResponse struct{ NotFoundJSONResponse }

func (GetChangeSetItem404JSONResponse) VisitGetChangeSetItemResponse added in v2.7.0

func (response GetChangeSetItem404JSONResponse) VisitGetChangeSetItemResponse(w http.ResponseWriter) error

type GetChangeSetItemRequestObject added in v2.7.0

type GetChangeSetItemRequestObject struct {
	Set  ChangeSetParam `json:"set"`
	Kind KindParam      `json:"kind"`
	Id   IdParam        `json:"id"`
}

type GetChangeSetItemResponseObject added in v2.7.0

type GetChangeSetItemResponseObject interface {
	VisitGetChangeSetItemResponse(w http.ResponseWriter) error
}

type GetChangeSetRequestObject added in v2.7.0

type GetChangeSetRequestObject struct {
	Set ChangeSetParam `json:"set"`
}

type GetChangeSetResponseObject added in v2.7.0

type GetChangeSetResponseObject interface {
	VisitGetChangeSetResponse(w http.ResponseWriter) error
}

type GetCharterPdf200ApplicationpdfResponse

type GetCharterPdf200ApplicationpdfResponse struct {
	Body          io.Reader
	ContentLength int64
}

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 {
	// ChangeSet Read as if this change set were accepted (docs/adr/0024): its drafts stand in for the records they change, and the records it creates are there too, each marked proposed. For reviewing a change set in the ordinary screens.
	ChangeSet *PreviewParam `form:"changeSet,omitempty" json:"changeSet,omitempty"`

	// 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 GetComponents200JSONResponse added in v2.9.0

type GetComponents200JSONResponse ComponentGraph

func (GetComponents200JSONResponse) VisitGetComponentsResponse added in v2.9.0

func (response GetComponents200JSONResponse) VisitGetComponentsResponse(w http.ResponseWriter) error

type GetComponents401JSONResponse added in v2.9.0

type GetComponents401JSONResponse struct{ UnauthenticatedJSONResponse }

func (GetComponents401JSONResponse) VisitGetComponentsResponse added in v2.9.0

func (response GetComponents401JSONResponse) VisitGetComponentsResponse(w http.ResponseWriter) error

type GetComponents403JSONResponse added in v2.9.0

type GetComponents403JSONResponse struct{ ForbiddenJSONResponse }

func (GetComponents403JSONResponse) VisitGetComponentsResponse added in v2.9.0

func (response GetComponents403JSONResponse) VisitGetComponentsResponse(w http.ResponseWriter) error

type GetComponentsParams added in v2.9.0

type GetComponentsParams struct {
	// ChangeSet Read as if this change set were accepted (docs/adr/0024): its drafts stand in for the records they change, and the records it creates are there too, each marked proposed. For reviewing a change set in the ordinary screens.
	ChangeSet *PreviewParam `form:"changeSet,omitempty" json:"changeSet,omitempty"`
}

GetComponentsParams defines parameters for GetComponents.

type GetComponentsRequestObject added in v2.9.0

type GetComponentsRequestObject struct {
	Params GetComponentsParams
}

type GetComponentsResponseObject added in v2.9.0

type GetComponentsResponseObject interface {
	VisitGetComponentsResponse(w http.ResponseWriter) error
}

type GetCyclePeriods200JSONResponse added in v2.9.0

type GetCyclePeriods200JSONResponse []CyclePeriod

func (GetCyclePeriods200JSONResponse) VisitGetCyclePeriodsResponse added in v2.9.0

func (response GetCyclePeriods200JSONResponse) VisitGetCyclePeriodsResponse(w http.ResponseWriter) error

type GetCyclePeriods401JSONResponse added in v2.9.0

type GetCyclePeriods401JSONResponse struct{ UnauthenticatedJSONResponse }

func (GetCyclePeriods401JSONResponse) VisitGetCyclePeriodsResponse added in v2.9.0

func (response GetCyclePeriods401JSONResponse) VisitGetCyclePeriodsResponse(w http.ResponseWriter) error

type GetCyclePeriods403JSONResponse added in v2.9.0

type GetCyclePeriods403JSONResponse struct{ ForbiddenJSONResponse }

func (GetCyclePeriods403JSONResponse) VisitGetCyclePeriodsResponse added in v2.9.0

func (response GetCyclePeriods403JSONResponse) VisitGetCyclePeriodsResponse(w http.ResponseWriter) error

type GetCyclePeriods404JSONResponse added in v2.9.0

type GetCyclePeriods404JSONResponse struct{ NotFoundJSONResponse }

func (GetCyclePeriods404JSONResponse) VisitGetCyclePeriodsResponse added in v2.9.0

func (response GetCyclePeriods404JSONResponse) VisitGetCyclePeriodsResponse(w http.ResponseWriter) error

type GetCyclePeriods422JSONResponse added in v2.9.0

type GetCyclePeriods422JSONResponse struct{ UnprocessableJSONResponse }

func (GetCyclePeriods422JSONResponse) VisitGetCyclePeriodsResponse added in v2.9.0

func (response GetCyclePeriods422JSONResponse) VisitGetCyclePeriodsResponse(w http.ResponseWriter) error

type GetCyclePeriodsParams added in v2.9.0

type GetCyclePeriodsParams struct {
	// From The first month, YYYY-MM.
	From string `form:"from" json:"from"`

	// To The last month, YYYY-MM; at most 1,200 months after from.
	To string `form:"to" json:"to"`
}

GetCyclePeriodsParams defines parameters for GetCyclePeriods.

type GetCyclePeriodsRequestObject added in v2.9.0

type GetCyclePeriodsRequestObject struct {
	Id     IdParam `json:"id"`
	Params GetCyclePeriodsParams
}

type GetCyclePeriodsResponseObject added in v2.9.0

type GetCyclePeriodsResponseObject interface {
	VisitGetCyclePeriodsResponse(w http.ResponseWriter) error
}

type GetDecisionModel200JSONResponse added in v2.9.0

type GetDecisionModel200JSONResponse DecisionModel

func (GetDecisionModel200JSONResponse) VisitGetDecisionModelResponse added in v2.9.0

func (response GetDecisionModel200JSONResponse) VisitGetDecisionModelResponse(w http.ResponseWriter) error

type GetDecisionModel401JSONResponse added in v2.9.0

type GetDecisionModel401JSONResponse struct{ UnauthenticatedJSONResponse }

func (GetDecisionModel401JSONResponse) VisitGetDecisionModelResponse added in v2.9.0

func (response GetDecisionModel401JSONResponse) VisitGetDecisionModelResponse(w http.ResponseWriter) error

type GetDecisionModelRequestObject added in v2.9.0

type GetDecisionModelRequestObject struct {
}

type GetDecisionModelResponseObject added in v2.9.0

type GetDecisionModelResponseObject interface {
	VisitGetDecisionModelResponse(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 GetGapChecksParams added in v2.9.0

type GetGapChecksParams struct {
	// ChangeSet Read as if this change set were accepted (docs/adr/0024): its drafts stand in for the records they change, and the records it creates are there too, each marked proposed. For reviewing a change set in the ordinary screens.
	ChangeSet *PreviewParam `form:"changeSet,omitempty" json:"changeSet,omitempty"`
}

GetGapChecksParams defines parameters for GetGapChecks.

type GetGapChecksRequestObject

type GetGapChecksRequestObject struct {
	Id     IdParam `json:"id"`
	Params GetGapChecksParams
}

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 GetGlossary200JSONResponse added in v2.7.0

type GetGlossary200JSONResponse []GlossaryEntry

func (GetGlossary200JSONResponse) VisitGetGlossaryResponse added in v2.7.0

func (response GetGlossary200JSONResponse) VisitGetGlossaryResponse(w http.ResponseWriter) error

type GetGlossary401JSONResponse added in v2.7.0

type GetGlossary401JSONResponse struct{ UnauthenticatedJSONResponse }

func (GetGlossary401JSONResponse) VisitGetGlossaryResponse added in v2.7.0

func (response GetGlossary401JSONResponse) VisitGetGlossaryResponse(w http.ResponseWriter) error

type GetGlossary403JSONResponse added in v2.7.0

type GetGlossary403JSONResponse struct{ ForbiddenJSONResponse }

func (GetGlossary403JSONResponse) VisitGetGlossaryResponse added in v2.7.0

func (response GetGlossary403JSONResponse) VisitGetGlossaryResponse(w http.ResponseWriter) error

type GetGlossaryParams added in v2.7.0

type GetGlossaryParams struct {
	// Locale A language the guidance is written in; English when left out or unknown.
	Locale *string `form:"locale,omitempty" json:"locale,omitempty"`
}

GetGlossaryParams defines parameters for GetGlossary.

type GetGlossaryRequestObject added in v2.7.0

type GetGlossaryRequestObject struct {
	Params GetGlossaryParams
}

type GetGlossaryResponseObject added in v2.7.0

type GetGlossaryResponseObject interface {
	VisitGetGlossaryResponse(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 GetGoalChecksParams added in v2.9.0

type GetGoalChecksParams struct {
	// ChangeSet Read as if this change set were accepted (docs/adr/0024): its drafts stand in for the records they change, and the records it creates are there too, each marked proposed. For reviewing a change set in the ordinary screens.
	ChangeSet *PreviewParam `form:"changeSet,omitempty" json:"changeSet,omitempty"`
}

GetGoalChecksParams defines parameters for GetGoalChecks.

type GetGoalChecksRequestObject

type GetGoalChecksRequestObject struct {
	Id     IdParam `json:"id"`
	Params GetGoalChecksParams
}

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 GetGoalTreeParams added in v2.9.0

type GetGoalTreeParams struct {
	// ChangeSet Read as if this change set were accepted (docs/adr/0024): its drafts stand in for the records they change, and the records it creates are there too, each marked proposed. For reviewing a change set in the ordinary screens.
	ChangeSet *PreviewParam `form:"changeSet,omitempty" json:"changeSet,omitempty"`
}

GetGoalTreeParams defines parameters for GetGoalTree.

type GetGoalTreeRequestObject

type GetGoalTreeRequestObject struct {
	Params GetGoalTreeParams
}

type GetGoalTreeResponseObject

type GetGoalTreeResponseObject interface {
	VisitGetGoalTreeResponse(w http.ResponseWriter) error
}

type GetGraph200JSONResponse added in v2.7.0

type GetGraph200JSONResponse Graph

func (GetGraph200JSONResponse) VisitGetGraphResponse added in v2.7.0

func (response GetGraph200JSONResponse) VisitGetGraphResponse(w http.ResponseWriter) error

type GetGraph401JSONResponse added in v2.7.0

type GetGraph401JSONResponse struct{ UnauthenticatedJSONResponse }

func (GetGraph401JSONResponse) VisitGetGraphResponse added in v2.7.0

func (response GetGraph401JSONResponse) VisitGetGraphResponse(w http.ResponseWriter) error

type GetGraph403JSONResponse added in v2.7.0

type GetGraph403JSONResponse struct{ ForbiddenJSONResponse }

func (GetGraph403JSONResponse) VisitGetGraphResponse added in v2.7.0

func (response GetGraph403JSONResponse) VisitGetGraphResponse(w http.ResponseWriter) error

type GetGraphParams added in v2.7.0

type GetGraphParams struct {
	// ChangeSet Read as if this change set were accepted (docs/adr/0024): its drafts stand in for the records they change, and the records it creates are there too, each marked proposed. For reviewing a change set in the ordinary screens.
	ChangeSet *PreviewParam `form:"changeSet,omitempty" json:"changeSet,omitempty"`

	// Focus A manifest as Kind/id, to measure every node's distance from.
	Focus *string `form:"focus,omitempty" json:"focus,omitempty"`
}

GetGraphParams defines parameters for GetGraph.

type GetGraphRequestObject added in v2.7.0

type GetGraphRequestObject struct {
	Params GetGraphParams
}

type GetGraphResponseObject added in v2.7.0

type GetGraphResponseObject interface {
	VisitGetGraphResponse(w http.ResponseWriter) error
}

type GetGuide200JSONResponse added in v2.6.0

type GetGuide200JSONResponse Guide

func (GetGuide200JSONResponse) VisitGetGuideResponse added in v2.6.0

func (response GetGuide200JSONResponse) VisitGetGuideResponse(w http.ResponseWriter) error

type GetGuide401JSONResponse added in v2.6.0

type GetGuide401JSONResponse struct{ UnauthenticatedJSONResponse }

func (GetGuide401JSONResponse) VisitGetGuideResponse added in v2.6.0

func (response GetGuide401JSONResponse) VisitGetGuideResponse(w http.ResponseWriter) error

type GetGuide403JSONResponse added in v2.6.0

type GetGuide403JSONResponse struct{ ForbiddenJSONResponse }

func (GetGuide403JSONResponse) VisitGetGuideResponse added in v2.6.0

func (response GetGuide403JSONResponse) VisitGetGuideResponse(w http.ResponseWriter) error

type GetGuide404JSONResponse added in v2.6.0

type GetGuide404JSONResponse struct{ NotFoundJSONResponse }

func (GetGuide404JSONResponse) VisitGetGuideResponse added in v2.6.0

func (response GetGuide404JSONResponse) VisitGetGuideResponse(w http.ResponseWriter) error

type GetGuideParams added in v2.6.0

type GetGuideParams struct {
	// Level For a Goal, goal, objective or outcome.
	Level *string `form:"level,omitempty" json:"level,omitempty"`

	// Locale The language of the words; English when there are none in it.
	Locale *string `form:"locale,omitempty" json:"locale,omitempty"`
}

GetGuideParams defines parameters for GetGuide.

type GetGuideRequestObject added in v2.6.0

type GetGuideRequestObject struct {
	Kind   KindParam `json:"kind"`
	Params GetGuideParams
}

type GetGuideResponseObject added in v2.6.0

type GetGuideResponseObject interface {
	VisitGetGuideResponse(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 GetKPIControlChart200JSONResponse added in v2.10.0

type GetKPIControlChart200JSONResponse ControlChart

func (GetKPIControlChart200JSONResponse) VisitGetKPIControlChartResponse added in v2.10.0

func (response GetKPIControlChart200JSONResponse) VisitGetKPIControlChartResponse(w http.ResponseWriter) error

type GetKPIControlChart401JSONResponse added in v2.10.0

type GetKPIControlChart401JSONResponse struct{ UnauthenticatedJSONResponse }

func (GetKPIControlChart401JSONResponse) VisitGetKPIControlChartResponse added in v2.10.0

func (response GetKPIControlChart401JSONResponse) VisitGetKPIControlChartResponse(w http.ResponseWriter) error

type GetKPIControlChart403JSONResponse added in v2.10.0

type GetKPIControlChart403JSONResponse struct{ ForbiddenJSONResponse }

func (GetKPIControlChart403JSONResponse) VisitGetKPIControlChartResponse added in v2.10.0

func (response GetKPIControlChart403JSONResponse) VisitGetKPIControlChartResponse(w http.ResponseWriter) error

type GetKPIControlChart404JSONResponse added in v2.10.0

type GetKPIControlChart404JSONResponse struct{ NotFoundJSONResponse }

func (GetKPIControlChart404JSONResponse) VisitGetKPIControlChartResponse added in v2.10.0

func (response GetKPIControlChart404JSONResponse) VisitGetKPIControlChartResponse(w http.ResponseWriter) error

type GetKPIControlChartParams added in v2.10.0

type GetKPIControlChartParams struct {
	// ChangeSet Read as if this change set were accepted (docs/adr/0024): its drafts stand in for the records they change, and the records it creates are there too, each marked proposed. For reviewing a change set in the ordinary screens.
	ChangeSet *PreviewParam `form:"changeSet,omitempty" json:"changeSet,omitempty"`
}

GetKPIControlChartParams defines parameters for GetKPIControlChart.

type GetKPIControlChartRequestObject added in v2.10.0

type GetKPIControlChartRequestObject struct {
	Id     IdParam `json:"id"`
	Params GetKPIControlChartParams
}

type GetKPIControlChartResponseObject added in v2.10.0

type GetKPIControlChartResponseObject interface {
	VisitGetKPIControlChartResponse(w http.ResponseWriter) error
}

type GetLineage200JSONResponse added in v2.10.0

type GetLineage200JSONResponse Lineage

func (GetLineage200JSONResponse) VisitGetLineageResponse added in v2.10.0

func (response GetLineage200JSONResponse) VisitGetLineageResponse(w http.ResponseWriter) error

type GetLineage401JSONResponse added in v2.10.0

type GetLineage401JSONResponse struct{ UnauthenticatedJSONResponse }

func (GetLineage401JSONResponse) VisitGetLineageResponse added in v2.10.0

func (response GetLineage401JSONResponse) VisitGetLineageResponse(w http.ResponseWriter) error

type GetLineage403JSONResponse added in v2.10.0

type GetLineage403JSONResponse struct{ ForbiddenJSONResponse }

func (GetLineage403JSONResponse) VisitGetLineageResponse added in v2.10.0

func (response GetLineage403JSONResponse) VisitGetLineageResponse(w http.ResponseWriter) error

type GetLineageJSONBody added in v2.10.0

type GetLineageJSONBody struct {
	Name *string `json:"name,omitempty"`

	// Produces The ids of the data sources it produces into.
	Produces []string `json:"produces"`

	// Project The project's id.
	Project string `json:"project"`

	// Uses The ids of the data sources it uses.
	Uses []string `json:"uses"`
}

GetLineageJSONBody defines parameters for GetLineage.

type GetLineageJSONRequestBody added in v2.10.0

type GetLineageJSONRequestBody GetLineageJSONBody

GetLineageJSONRequestBody defines body for GetLineage for application/json ContentType.

type GetLineageParams added in v2.10.0

type GetLineageParams struct {
	// ChangeSet Read as if this change set were accepted (docs/adr/0024): its drafts stand in for the records they change, and the records it creates are there too, each marked proposed. For reviewing a change set in the ordinary screens.
	ChangeSet *PreviewParam `form:"changeSet,omitempty" json:"changeSet,omitempty"`
}

GetLineageParams defines parameters for GetLineage.

type GetLineageRequestObject added in v2.10.0

type GetLineageRequestObject struct {
	Params GetLineageParams
	Body   *GetLineageJSONRequestBody
}

type GetLineageResponseObject added in v2.10.0

type GetLineageResponseObject interface {
	VisitGetLineageResponse(w http.ResponseWriter) error
}

type GetLinkCandidates200JSONResponse added in v2.9.0

type GetLinkCandidates200JSONResponse []LinkCandidate

func (GetLinkCandidates200JSONResponse) VisitGetLinkCandidatesResponse added in v2.9.0

func (response GetLinkCandidates200JSONResponse) VisitGetLinkCandidatesResponse(w http.ResponseWriter) error

type GetLinkCandidates401JSONResponse added in v2.9.0

type GetLinkCandidates401JSONResponse struct{ UnauthenticatedJSONResponse }

func (GetLinkCandidates401JSONResponse) VisitGetLinkCandidatesResponse added in v2.9.0

func (response GetLinkCandidates401JSONResponse) VisitGetLinkCandidatesResponse(w http.ResponseWriter) error

type GetLinkCandidates403JSONResponse added in v2.9.0

type GetLinkCandidates403JSONResponse struct{ ForbiddenJSONResponse }

func (GetLinkCandidates403JSONResponse) VisitGetLinkCandidatesResponse added in v2.9.0

func (response GetLinkCandidates403JSONResponse) VisitGetLinkCandidatesResponse(w http.ResponseWriter) error

type GetLinkCandidates404JSONResponse added in v2.9.0

type GetLinkCandidates404JSONResponse struct{ NotFoundJSONResponse }

func (GetLinkCandidates404JSONResponse) VisitGetLinkCandidatesResponse added in v2.9.0

func (response GetLinkCandidates404JSONResponse) VisitGetLinkCandidatesResponse(w http.ResponseWriter) error

type GetLinkCandidatesParams added in v2.9.0

type GetLinkCandidatesParams struct {
	// From The id of the record the link starts from.
	From string `form:"from" json:"from"`

	// Problem For a link from a project's problem, the problem's id, or #n for the one at position n counting from 0 when it has no id yet.
	Problem *string `form:"problem,omitempty" json:"problem,omitempty"`

	// ChangeSet Read as if this change set were accepted (docs/adr/0024): its drafts stand in for the records they change, and the records it creates are there too, each marked proposed. For reviewing a change set in the ordinary screens.
	ChangeSet *PreviewParam `form:"changeSet,omitempty" json:"changeSet,omitempty"`
}

GetLinkCandidatesParams defines parameters for GetLinkCandidates.

type GetLinkCandidatesRequestObject added in v2.9.0

type GetLinkCandidatesRequestObject struct {
	Link   LinkKind `json:"link"`
	Params GetLinkCandidatesParams
}

type GetLinkCandidatesResponseObject added in v2.9.0

type GetLinkCandidatesResponseObject interface {
	VisitGetLinkCandidatesResponse(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 GetManifestParams added in v2.9.0

type GetManifestParams struct {
	// ChangeSet Read as if this change set were accepted (docs/adr/0024): its drafts stand in for the records they change, and the records it creates are there too, each marked proposed. For reviewing a change set in the ordinary screens.
	ChangeSet *PreviewParam `form:"changeSet,omitempty" json:"changeSet,omitempty"`
}

GetManifestParams defines parameters for GetManifest.

type GetManifestRequestObject

type GetManifestRequestObject struct {
	Kind   KindParam `json:"kind"`
	Id     IdParam   `json:"id"`
	Params GetManifestParams
}

type GetManifestResponseObject

type GetManifestResponseObject interface {
	VisitGetManifestResponse(w http.ResponseWriter) error
}

type GetOperationCharterHtml200TexthtmlResponse

type GetOperationCharterHtml200TexthtmlResponse struct {
	Body          io.Reader
	ContentLength int64
}

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 GetOperationCharterHtmlParams added in v2.9.0

type GetOperationCharterHtmlParams struct {
	// ChangeSet Read as if this change set were accepted (docs/adr/0024): its drafts stand in for the records they change, and the records it creates are there too, each marked proposed. For reviewing a change set in the ordinary screens.
	ChangeSet *PreviewParam `form:"changeSet,omitempty" json:"changeSet,omitempty"`
}

GetOperationCharterHtmlParams defines parameters for GetOperationCharterHtml.

type GetOperationCharterHtmlRequestObject

type GetOperationCharterHtmlRequestObject struct {
	Id     IdParam `json:"id"`
	Params GetOperationCharterHtmlParams
}

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 GetOperationChecksParams added in v2.9.0

type GetOperationChecksParams struct {
	// ChangeSet Read as if this change set were accepted (docs/adr/0024): its drafts stand in for the records they change, and the records it creates are there too, each marked proposed. For reviewing a change set in the ordinary screens.
	ChangeSet *PreviewParam `form:"changeSet,omitempty" json:"changeSet,omitempty"`
}

GetOperationChecksParams defines parameters for GetOperationChecks.

type GetOperationChecksRequestObject

type GetOperationChecksRequestObject struct {
	Id     IdParam `json:"id"`
	Params GetOperationChecksParams
}

type GetOperationChecksResponseObject

type GetOperationChecksResponseObject interface {
	VisitGetOperationChecksResponse(w http.ResponseWriter) error
}

type GetOrder200JSONResponse added in v2.7.0

type GetOrder200JSONResponse Order

func (GetOrder200JSONResponse) VisitGetOrderResponse added in v2.7.0

func (response GetOrder200JSONResponse) VisitGetOrderResponse(w http.ResponseWriter) error

type GetOrder401JSONResponse added in v2.7.0

type GetOrder401JSONResponse struct{ UnauthenticatedJSONResponse }

func (GetOrder401JSONResponse) VisitGetOrderResponse added in v2.7.0

func (response GetOrder401JSONResponse) VisitGetOrderResponse(w http.ResponseWriter) error

type GetOrder403JSONResponse added in v2.7.0

type GetOrder403JSONResponse struct{ ForbiddenJSONResponse }

func (GetOrder403JSONResponse) VisitGetOrderResponse added in v2.7.0

func (response GetOrder403JSONResponse) VisitGetOrderResponse(w http.ResponseWriter) error

type GetOrderParams added in v2.9.0

type GetOrderParams struct {
	// ChangeSet Read as if this change set were accepted (docs/adr/0024): its drafts stand in for the records they change, and the records it creates are there too, each marked proposed. For reviewing a change set in the ordinary screens.
	ChangeSet *PreviewParam `form:"changeSet,omitempty" json:"changeSet,omitempty"`
}

GetOrderParams defines parameters for GetOrder.

type GetOrderRequestObject added in v2.7.0

type GetOrderRequestObject struct {
	Params GetOrderParams
}

type GetOrderResponseObject added in v2.7.0

type GetOrderResponseObject interface {
	VisitGetOrderResponse(w http.ResponseWriter) error
}

type GetPortfolioChecks200JSONResponse added in v2.9.0

type GetPortfolioChecks200JSONResponse []ProgrammeCheck

func (GetPortfolioChecks200JSONResponse) VisitGetPortfolioChecksResponse added in v2.9.0

func (response GetPortfolioChecks200JSONResponse) VisitGetPortfolioChecksResponse(w http.ResponseWriter) error

type GetPortfolioChecks401JSONResponse added in v2.9.0

type GetPortfolioChecks401JSONResponse struct{ UnauthenticatedJSONResponse }

func (GetPortfolioChecks401JSONResponse) VisitGetPortfolioChecksResponse added in v2.9.0

func (response GetPortfolioChecks401JSONResponse) VisitGetPortfolioChecksResponse(w http.ResponseWriter) error

type GetPortfolioChecks403JSONResponse added in v2.9.0

type GetPortfolioChecks403JSONResponse struct{ ForbiddenJSONResponse }

func (GetPortfolioChecks403JSONResponse) VisitGetPortfolioChecksResponse added in v2.9.0

func (response GetPortfolioChecks403JSONResponse) VisitGetPortfolioChecksResponse(w http.ResponseWriter) error

type GetPortfolioChecks404JSONResponse added in v2.9.0

type GetPortfolioChecks404JSONResponse struct{ NotFoundJSONResponse }

func (GetPortfolioChecks404JSONResponse) VisitGetPortfolioChecksResponse added in v2.9.0

func (response GetPortfolioChecks404JSONResponse) VisitGetPortfolioChecksResponse(w http.ResponseWriter) error

type GetPortfolioChecksParams added in v2.9.0

type GetPortfolioChecksParams struct {
	// ChangeSet Read as if this change set were accepted (docs/adr/0024): its drafts stand in for the records they change, and the records it creates are there too, each marked proposed. For reviewing a change set in the ordinary screens.
	ChangeSet *PreviewParam `form:"changeSet,omitempty" json:"changeSet,omitempty"`
}

GetPortfolioChecksParams defines parameters for GetPortfolioChecks.

type GetPortfolioChecksRequestObject added in v2.9.0

type GetPortfolioChecksRequestObject struct {
	Id     IdParam `json:"id"`
	Params GetPortfolioChecksParams
}

type GetPortfolioChecksResponseObject added in v2.9.0

type GetPortfolioChecksResponseObject interface {
	VisitGetPortfolioChecksResponse(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 GetPresenceDocument404JSONResponse added in v2.10.0

type GetPresenceDocument404JSONResponse struct{ NotFoundJSONResponse }

func (GetPresenceDocument404JSONResponse) VisitGetPresenceDocumentResponse added in v2.10.0

func (response GetPresenceDocument404JSONResponse) VisitGetPresenceDocumentResponse(w http.ResponseWriter) error

type GetPresenceDocumentParams added in v2.10.0

type GetPresenceDocumentParams struct {
	Kind *string `form:"kind,omitempty" json:"kind,omitempty"`
	Id   *string `form:"id,omitempty" json:"id,omitempty"`
}

GetPresenceDocumentParams defines parameters for GetPresenceDocument.

type GetPresenceDocumentRequestObject

type GetPresenceDocumentRequestObject struct {
	Params GetPresenceDocumentParams
}

type GetPresenceDocumentResponseObject

type GetPresenceDocumentResponseObject interface {
	VisitGetPresenceDocumentResponse(w http.ResponseWriter) error
}

type GetProgrammeCharterHtml200TexthtmlResponse

type GetProgrammeCharterHtml200TexthtmlResponse struct {
	Body          io.Reader
	ContentLength int64
}

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 GetProgrammeCharterHtmlParams added in v2.9.0

type GetProgrammeCharterHtmlParams struct {
	// ChangeSet Read as if this change set were accepted (docs/adr/0024): its drafts stand in for the records they change, and the records it creates are there too, each marked proposed. For reviewing a change set in the ordinary screens.
	ChangeSet *PreviewParam `form:"changeSet,omitempty" json:"changeSet,omitempty"`
}

GetProgrammeCharterHtmlParams defines parameters for GetProgrammeCharterHtml.

type GetProgrammeCharterHtmlRequestObject

type GetProgrammeCharterHtmlRequestObject struct {
	Id     IdParam `json:"id"`
	Params GetProgrammeCharterHtmlParams
}

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 GetProgrammeChecksParams added in v2.9.0

type GetProgrammeChecksParams struct {
	// ChangeSet Read as if this change set were accepted (docs/adr/0024): its drafts stand in for the records they change, and the records it creates are there too, each marked proposed. For reviewing a change set in the ordinary screens.
	ChangeSet *PreviewParam `form:"changeSet,omitempty" json:"changeSet,omitempty"`
}

GetProgrammeChecksParams defines parameters for GetProgrammeChecks.

type GetProgrammeChecksRequestObject

type GetProgrammeChecksRequestObject struct {
	Id     IdParam `json:"id"`
	Params GetProgrammeChecksParams
}

type GetProgrammeChecksResponseObject

type GetProgrammeChecksResponseObject interface {
	VisitGetProgrammeChecksResponse(w http.ResponseWriter) error
}

type GetProjectCharterHtml200TexthtmlResponse

type GetProjectCharterHtml200TexthtmlResponse struct {
	Body          io.Reader
	ContentLength int64
}

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 {
	// ChangeSet Read as if this change set were accepted (docs/adr/0024): its drafts stand in for the records they change, and the records it creates are there too, each marked proposed. For reviewing a change set in the ordinary screens.
	ChangeSet *PreviewParam `form:"changeSet,omitempty" json:"changeSet,omitempty"`

	// 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 GetProjectChecksParams added in v2.9.0

type GetProjectChecksParams struct {
	// ChangeSet Read as if this change set were accepted (docs/adr/0024): its drafts stand in for the records they change, and the records it creates are there too, each marked proposed. For reviewing a change set in the ordinary screens.
	ChangeSet *PreviewParam `form:"changeSet,omitempty" json:"changeSet,omitempty"`
}

GetProjectChecksParams defines parameters for GetProjectChecks.

type GetProjectChecksRequestObject

type GetProjectChecksRequestObject struct {
	Id     IdParam `json:"id"`
	Params GetProjectChecksParams
}

type GetProjectChecksResponseObject

type GetProjectChecksResponseObject interface {
	VisitGetProjectChecksResponse(w http.ResponseWriter) error
}

type GetProjectDMAIC200JSONResponse added in v2.10.0

type GetProjectDMAIC200JSONResponse DMAIC

func (GetProjectDMAIC200JSONResponse) VisitGetProjectDMAICResponse added in v2.10.0

func (response GetProjectDMAIC200JSONResponse) VisitGetProjectDMAICResponse(w http.ResponseWriter) error

type GetProjectDMAIC401JSONResponse added in v2.10.0

type GetProjectDMAIC401JSONResponse struct{ UnauthenticatedJSONResponse }

func (GetProjectDMAIC401JSONResponse) VisitGetProjectDMAICResponse added in v2.10.0

func (response GetProjectDMAIC401JSONResponse) VisitGetProjectDMAICResponse(w http.ResponseWriter) error

type GetProjectDMAIC403JSONResponse added in v2.10.0

type GetProjectDMAIC403JSONResponse struct{ ForbiddenJSONResponse }

func (GetProjectDMAIC403JSONResponse) VisitGetProjectDMAICResponse added in v2.10.0

func (response GetProjectDMAIC403JSONResponse) VisitGetProjectDMAICResponse(w http.ResponseWriter) error

type GetProjectDMAIC404JSONResponse added in v2.10.0

type GetProjectDMAIC404JSONResponse struct{ NotFoundJSONResponse }

func (GetProjectDMAIC404JSONResponse) VisitGetProjectDMAICResponse added in v2.10.0

func (response GetProjectDMAIC404JSONResponse) VisitGetProjectDMAICResponse(w http.ResponseWriter) error

type GetProjectDMAICParams added in v2.10.0

type GetProjectDMAICParams struct {
	// ChangeSet Read as if this change set were accepted (docs/adr/0024): its drafts stand in for the records they change, and the records it creates are there too, each marked proposed. For reviewing a change set in the ordinary screens.
	ChangeSet *PreviewParam `form:"changeSet,omitempty" json:"changeSet,omitempty"`
}

GetProjectDMAICParams defines parameters for GetProjectDMAIC.

type GetProjectDMAICRequestObject added in v2.10.0

type GetProjectDMAICRequestObject struct {
	Id     IdParam `json:"id"`
	Params GetProjectDMAICParams
}

type GetProjectDMAICResponseObject added in v2.10.0

type GetProjectDMAICResponseObject interface {
	VisitGetProjectDMAICResponse(w http.ResponseWriter) error
}

type GetProjectSchedule200JSONResponse added in v2.9.0

type GetProjectSchedule200JSONResponse []ScheduleItem

func (GetProjectSchedule200JSONResponse) VisitGetProjectScheduleResponse added in v2.9.0

func (response GetProjectSchedule200JSONResponse) VisitGetProjectScheduleResponse(w http.ResponseWriter) error

type GetProjectSchedule401JSONResponse added in v2.9.0

type GetProjectSchedule401JSONResponse struct{ UnauthenticatedJSONResponse }

func (GetProjectSchedule401JSONResponse) VisitGetProjectScheduleResponse added in v2.9.0

func (response GetProjectSchedule401JSONResponse) VisitGetProjectScheduleResponse(w http.ResponseWriter) error

type GetProjectSchedule403JSONResponse added in v2.9.0

type GetProjectSchedule403JSONResponse struct{ ForbiddenJSONResponse }

func (GetProjectSchedule403JSONResponse) VisitGetProjectScheduleResponse added in v2.9.0

func (response GetProjectSchedule403JSONResponse) VisitGetProjectScheduleResponse(w http.ResponseWriter) error

type GetProjectSchedule404JSONResponse added in v2.9.0

type GetProjectSchedule404JSONResponse struct{ NotFoundJSONResponse }

func (GetProjectSchedule404JSONResponse) VisitGetProjectScheduleResponse added in v2.9.0

func (response GetProjectSchedule404JSONResponse) VisitGetProjectScheduleResponse(w http.ResponseWriter) error

type GetProjectScheduleParams added in v2.9.0

type GetProjectScheduleParams struct {
	// ChangeSet Read as if this change set were accepted (docs/adr/0024): its drafts stand in for the records they change, and the records it creates are there too, each marked proposed. For reviewing a change set in the ordinary screens.
	ChangeSet *PreviewParam `form:"changeSet,omitempty" json:"changeSet,omitempty"`
}

GetProjectScheduleParams defines parameters for GetProjectSchedule.

type GetProjectScheduleRequestObject added in v2.9.0

type GetProjectScheduleRequestObject struct {
	Id     IdParam `json:"id"`
	Params GetProjectScheduleParams
}

type GetProjectScheduleResponseObject added in v2.9.0

type GetProjectScheduleResponseObject interface {
	VisitGetProjectScheduleResponse(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 GetProposal200JSONResponse added in v2.6.0

type GetProposal200JSONResponse ProposalReview

func (GetProposal200JSONResponse) VisitGetProposalResponse added in v2.6.0

func (response GetProposal200JSONResponse) VisitGetProposalResponse(w http.ResponseWriter) error

type GetProposal401JSONResponse added in v2.6.0

type GetProposal401JSONResponse struct{ UnauthenticatedJSONResponse }

func (GetProposal401JSONResponse) VisitGetProposalResponse added in v2.6.0

func (response GetProposal401JSONResponse) VisitGetProposalResponse(w http.ResponseWriter) error

type GetProposal403JSONResponse added in v2.6.0

type GetProposal403JSONResponse struct{ ForbiddenJSONResponse }

func (GetProposal403JSONResponse) VisitGetProposalResponse added in v2.6.0

func (response GetProposal403JSONResponse) VisitGetProposalResponse(w http.ResponseWriter) error

type GetProposal404JSONResponse added in v2.6.0

type GetProposal404JSONResponse struct{ NotFoundJSONResponse }

func (GetProposal404JSONResponse) VisitGetProposalResponse added in v2.6.0

func (response GetProposal404JSONResponse) VisitGetProposalResponse(w http.ResponseWriter) error

type GetProposalRequestObject added in v2.6.0

type GetProposalRequestObject struct {
	Proposal ProposalParam `json:"proposal"`
}

type GetProposalResponseObject added in v2.6.0

type GetProposalResponseObject interface {
	VisitGetProposalResponse(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 GetReferencesRequestObject

type GetReferencesRequestObject struct {
	Kind KindParam `json:"kind"`
	Id   IdParam   `json:"id"`
}

type GetReferencesResponseObject

type GetReferencesResponseObject interface {
	VisitGetReferencesResponse(w http.ResponseWriter) error
}

type GetReport200JSONResponse added in v2.3.0

type GetReport200JSONResponse Report

func (GetReport200JSONResponse) VisitGetReportResponse added in v2.3.0

func (response GetReport200JSONResponse) VisitGetReportResponse(w http.ResponseWriter) error

type GetReport200TextcsvResponse added in v2.3.0

type GetReport200TextcsvResponse struct {
	Body          io.Reader
	ContentLength int64
}

func (GetReport200TextcsvResponse) VisitGetReportResponse added in v2.3.0

func (response GetReport200TextcsvResponse) VisitGetReportResponse(w http.ResponseWriter) error

type GetReport401JSONResponse added in v2.3.0

type GetReport401JSONResponse struct{ UnauthenticatedJSONResponse }

func (GetReport401JSONResponse) VisitGetReportResponse added in v2.3.0

func (response GetReport401JSONResponse) VisitGetReportResponse(w http.ResponseWriter) error

type GetReport403JSONResponse added in v2.3.0

type GetReport403JSONResponse struct{ ForbiddenJSONResponse }

func (GetReport403JSONResponse) VisitGetReportResponse added in v2.3.0

func (response GetReport403JSONResponse) VisitGetReportResponse(w http.ResponseWriter) error

type GetReport404JSONResponse added in v2.3.0

type GetReport404JSONResponse struct{ NotFoundJSONResponse }

func (GetReport404JSONResponse) VisitGetReportResponse added in v2.3.0

func (response GetReport404JSONResponse) VisitGetReportResponse(w http.ResponseWriter) error

type GetReportParams added in v2.3.0

type GetReportParams struct {
	// Format json (the default) or csv, for a spreadsheet.
	Format *GetReportParamsFormat `form:"format,omitempty" json:"format,omitempty"`
}

GetReportParams defines parameters for GetReport.

type GetReportParamsFormat added in v2.3.0

type GetReportParamsFormat string

GetReportParamsFormat defines parameters for GetReport.

const (
	Csv  GetReportParamsFormat = "csv"
	Json GetReportParamsFormat = "json"
)

Defines values for GetReportParamsFormat.

func (GetReportParamsFormat) Valid added in v2.3.0

func (e GetReportParamsFormat) Valid() bool

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

type GetReportParamsName added in v2.3.0

type GetReportParamsName string

GetReportParamsName defines parameters for GetReport.

const (
	GetReportParamsNameAlignment   GetReportParamsName = "alignment"
	GetReportParamsNameKpiReadings GetReportParamsName = "kpi-readings"
	GetReportParamsNameProjects    GetReportParamsName = "projects"
	GetReportParamsNameTeams       GetReportParamsName = "teams"
)

Defines values for GetReportParamsName.

func (GetReportParamsName) Valid added in v2.3.0

func (e GetReportParamsName) Valid() bool

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

type GetReportRequestObject added in v2.3.0

type GetReportRequestObject struct {
	Name   GetReportParamsName `json:"name"`
	Params GetReportParams
}

type GetReportResponseObject added in v2.3.0

type GetReportResponseObject interface {
	VisitGetReportResponse(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

type GetSharedDocument401JSONResponse struct{ UnauthenticatedJSONResponse }

func (GetSharedDocument401JSONResponse) VisitGetSharedDocumentResponse

func (response GetSharedDocument401JSONResponse) VisitGetSharedDocumentResponse(w http.ResponseWriter) error

type GetSharedDocument403JSONResponse

type GetSharedDocument403JSONResponse struct{ ForbiddenJSONResponse }

func (GetSharedDocument403JSONResponse) VisitGetSharedDocumentResponse

func (response GetSharedDocument403JSONResponse) VisitGetSharedDocumentResponse(w http.ResponseWriter) error

type GetSharedDocument404JSONResponse

type GetSharedDocument404JSONResponse struct{ NotFoundJSONResponse }

func (GetSharedDocument404JSONResponse) VisitGetSharedDocumentResponse

func (response GetSharedDocument404JSONResponse) VisitGetSharedDocumentResponse(w http.ResponseWriter) error

type GetSharedDocumentRequestObject

type GetSharedDocumentRequestObject struct {
	Kind KindParam `json:"kind"`
	Id   IdParam   `json:"id"`
}

type GetSharedDocumentResponseObject

type GetSharedDocumentResponseObject interface {
	VisitGetSharedDocumentResponse(w http.ResponseWriter) error
}

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 GetVersionRequestObject struct {
	Kind KindParam `json:"kind"`
	Id   IdParam   `json:"id"`
	N    int       `json:"n"`
}

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 GetWorkingRequestObject struct {
	Kind KindParam `json:"kind"`
	Id   IdParam   `json:"id"`
}

type GetWorkingResponseObject

type GetWorkingResponseObject interface {
	VisitGetWorkingResponse(w http.ResponseWriter) error
}

type GlossaryEntry added in v2.7.0

type GlossaryEntry struct {
	// After The stages it comes after in the order of work.
	After *[]string `json:"after,omitempty"`

	// Example One instance of it, from the example workspace.
	Example *string `json:"example,omitempty"`

	// Key The stage's key in the order of work, or for a register its kind.
	Key  string `json:"key"`
	Kind string `json:"kind"`

	// Level For a Goal, the level the entry defines.
	Level *string `json:"level,omitempty"`

	// Register A root kind, added when a field first asks for one.
	Register *bool `json:"register,omitempty"`

	// Summary What it is, in one plain sentence that does not repeat its name.
	Summary string `json:"summary"`
}

GlossaryEntry defines model for GlossaryEntry.

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 {
	// Goal The goal, objective or outcome whose editor holds the fix, when it is not the one checked: an objective's outcome that closes no gap is fixed on the outcome.
	Goal    *string `json:"goal,omitempty"`
	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"`

	// Proposed Present when read with changeSet and the change set creates this record (new) or changes it (changed); absent otherwise.
	Proposed *Proposed `json:"proposed,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 GoalTree

type GoalTree struct {
	Levels []string   `json:"levels"`
	Nodes  []GoalNode `json:"nodes"`

	// Unplaced Objectives and outcomes with no parent yet, held by a placeholder (TAXONOMY.md D35), each with what sits under it.
	Unplaced *[]GoalNode `json:"unplaced,omitempty"`
}

GoalTree defines model for GoalTree.

type GrantParam added in v2.5.0

type GrantParam = string

GrantParam defines model for GrantParam.

type GrantPerson200JSONResponse added in v2.2.0

type GrantPerson200JSONResponse Person

func (GrantPerson200JSONResponse) VisitGrantPersonResponse added in v2.2.0

func (response GrantPerson200JSONResponse) VisitGrantPersonResponse(w http.ResponseWriter) error

type GrantPerson401JSONResponse added in v2.2.0

type GrantPerson401JSONResponse struct{ UnauthenticatedJSONResponse }

func (GrantPerson401JSONResponse) VisitGrantPersonResponse added in v2.2.0

func (response GrantPerson401JSONResponse) VisitGrantPersonResponse(w http.ResponseWriter) error

type GrantPerson403JSONResponse added in v2.2.0

type GrantPerson403JSONResponse struct{ ForbiddenJSONResponse }

func (GrantPerson403JSONResponse) VisitGrantPersonResponse added in v2.2.0

func (response GrantPerson403JSONResponse) VisitGrantPersonResponse(w http.ResponseWriter) error

type GrantPerson404JSONResponse added in v2.2.0

type GrantPerson404JSONResponse struct{ NotFoundJSONResponse }

func (GrantPerson404JSONResponse) VisitGrantPersonResponse added in v2.2.0

func (response GrantPerson404JSONResponse) VisitGrantPersonResponse(w http.ResponseWriter) error

type GrantPerson409JSONResponse added in v2.2.0

type GrantPerson409JSONResponse ProblemList

func (GrantPerson409JSONResponse) VisitGrantPersonResponse added in v2.2.0

func (response GrantPerson409JSONResponse) VisitGrantPersonResponse(w http.ResponseWriter) error

type GrantPerson422JSONResponse added in v2.2.0

type GrantPerson422JSONResponse struct{ UnprocessableJSONResponse }

func (GrantPerson422JSONResponse) VisitGrantPersonResponse added in v2.2.0

func (response GrantPerson422JSONResponse) VisitGrantPersonResponse(w http.ResponseWriter) error

type GrantPersonJSONRequestBody added in v2.2.0

type GrantPersonJSONRequestBody = PersonGrant

GrantPersonJSONRequestBody defines body for GrantPerson for application/json ContentType.

type GrantPersonRequestObject added in v2.2.0

type GrantPersonRequestObject struct {
	Email string `json:"email"`
	Body  *GrantPersonJSONRequestBody
}

type GrantPersonResponseObject added in v2.2.0

type GrantPersonResponseObject interface {
	VisitGrantPersonResponse(w http.ResponseWriter) error
}

type Graph added in v2.7.0

type Graph struct {
	Edges []GraphEdge `json:"edges"`
	Nodes []GraphNode `json:"nodes"`
}

Graph defines model for Graph.

type GraphEdge added in v2.7.0

type GraphEdge struct {
	From Ref `json:"from"`
	To   Ref `json:"to"`
}

GraphEdge defines model for GraphEdge.

type GraphNode added in v2.7.0

type GraphNode struct {
	// Distance How many edges, either way, from the focus asked for; absent when nothing joins them or no focus was asked for.
	Distance *int   `json:"distance,omitempty"`
	Id       string `json:"id"`
	Kind     string `json:"kind"`

	// Layer Its band in the graph: 0 for the registers, then one per stage, in the order of work. Every edge runs to a lower layer or along its own.
	Layer *int `json:"layer,omitempty"`

	// Level A goal's level (goal, objective, outcome); absent for every other kind.
	Level *string `json:"level,omitempty"`

	// Name metadata.name
	Name string `json:"name"`

	// Proposed Present when read with changeSet and the change set creates this record (new) or changes it (changed); absent otherwise.
	Proposed *Proposed `json:"proposed,omitempty"`

	// Stage The key of the stage of the order of work it is written in; absent for a register.
	Stage *string `json:"stage,omitempty"`

	// X Where the engine's layout placed it, in units an interface scales to its screen.
	X float64 `json:"x"`
	Y float64 `json:"y"`
}

GraphNode defines model for GraphNode.

type Guide added in v2.6.0

type Guide struct {
	// Checks By check id, how to meet it.
	Checks *map[string]string `json:"checks,omitempty"`

	// Definition What the kind is, in the discipline's words, and what it is not.
	Definition string `json:"definition"`

	// Existing The records of this kind (at this level) already defined: reuse or improve one before defining another.
	Existing []GuideCandidate `json:"existing"`
	Kind     string           `json:"kind"`
	Level    *string          `json:"level,omitempty"`

	// LevelIs What the asked level is.
	LevelIs *string `json:"levelIs,omitempty"`

	// Levels What each level is, when no level was asked for.
	Levels *map[string]string `json:"levels,omitempty"`
	Locale string             `json:"locale"`

	// Plan The work around this kind, in the order of work, from the flows' links: what it names, which must exist before it (when before), then what will name it, each after what it names in turn (when after; for an objective, its outcomes, the KPI measuring each, then the gaps they close).
	Plan *[]GuidePlanItem `json:"plan,omitempty"`

	// Purpose The organisation's vision and mission, for a Goal.
	Purpose *struct {
		Mission *string `json:"mission,omitempty"`
		Source  *string `json:"source,omitempty"`
		Vision  *string `json:"vision,omitempty"`
	} `json:"purpose,omitempty"`
	Steps []GuideStep `json:"steps"`

	// Template A manifest of this kind with its envelope and required fields, to fill in.
	Template map[string]interface{} `json:"template"`

	// Vocabulary Words an interface offers for writing a field in this language, such as the verbs an aim opens with; never used to judge one.
	Vocabulary *map[string][]string `json:"vocabulary,omitempty"`
}

Guide defines model for Guide.

type GuideCandidate added in v2.6.0

type GuideCandidate struct {
	Detail *string `json:"detail,omitempty"`
	Id     string  `json:"id"`
	Name   string  `json:"name"`

	// Under A goal's parent.
	Under *string `json:"under,omitempty"`
}

GuideCandidate defines model for GuideCandidate.

type GuideField added in v2.6.0

type GuideField struct {
	Candidates *[]GuideCandidate `json:"candidates,omitempty"`
	Checks     *[]string         `json:"checks,omitempty"`
	Control    string            `json:"control"`

	// Format How a dated value is written, such as YYYY-MM.
	Format *string   `json:"format,omitempty"`
	Good   *[]string `json:"good,omitempty"`
	Guide  *string   `json:"guide,omitempty"`

	// MaxLength The longest the value may be, in characters, where the schema limits it.
	MaxLength *int `json:"maxLength,omitempty"`

	// Path The field's JSON pointer; list items as /spec/keyResults/-/metric.
	Path string       `json:"path"`
	Poor *[]GuidePoor `json:"poor,omitempty"`

	// References The kind the field references.
	References *string `json:"references,omitempty"`

	// Required The field must be filled: the schema requires it where it sits, or one of its checks blocks a handoff while it is empty. Absent when it may be left out.
	Required *bool `json:"required,omitempty"`

	// Shape For a reference, a period, an object or a list: a compact example of the JSON it is written as, alternatives joined by " | ", an optional property marked with "?".
	Shape *string `json:"shape,omitempty"`

	// Values The values the field may take, where the schema lists them.
	Values *[]interface{} `json:"values,omitempty"`
}

GuideField defines model for GuideField.

type GuideLink struct {
	Ask        *string           `json:"ask,omitempty"`
	Candidates *[]GuideCandidate `json:"candidates,omitempty"`
	Check      *string           `json:"check,omitempty"`
	IfNone     *string           `json:"ifNone,omitempty"`

	// Kind The kind that holds the link.
	Kind string `json:"kind"`

	// Path Where on that kind the link is held.
	Path string `json:"path"`
}

GuideLink defines model for GuideLink.

type GuidePlanItem added in v2.7.0

type GuidePlanItem struct {
	Ask *string `json:"ask,omitempty"`

	// Check The check that reports whether the link is made.
	Check    *string           `json:"check,omitempty"`
	Existing *[]GuideCandidate `json:"existing,omitempty"`

	// For What it is needed for, as Kind or Kind (level).
	For    string  `json:"for"`
	IfNone *string `json:"ifNone,omitempty"`
	Kind   string  `json:"kind"`
	Level  *string `json:"level,omitempty"`

	// Link How the two are joined, as the holding kind and the path that names the other.
	Link string `json:"link"`

	// Missing True for a before item no record of which exists yet, which is defined first; an agent's draft naming what does not exist is refused.
	Missing *bool `json:"missing,omitempty"`

	// When before for what the new thing names, which must exist first; after for what will name it, written once it exists.
	When GuidePlanItemWhen `json:"when"`
}

GuidePlanItem defines model for GuidePlanItem.

type GuidePlanItemWhen added in v2.7.0

type GuidePlanItemWhen string

GuidePlanItemWhen before for what the new thing names, which must exist first; after for what will name it, written once it exists.

const (
	GuidePlanItemWhenAfter  GuidePlanItemWhen = "after"
	GuidePlanItemWhenBefore GuidePlanItemWhen = "before"
)

Defines values for GuidePlanItemWhen.

func (GuidePlanItemWhen) Valid added in v2.7.0

func (e GuidePlanItemWhen) Valid() bool

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

type GuidePoor added in v2.6.0

type GuidePoor struct {
	Text string `json:"text"`
	Why  string `json:"why"`
}

GuidePoor defines model for GuidePoor.

type GuideStep added in v2.6.0

type GuideStep struct {
	Fields []GuideField `json:"fields"`
	Guide  *string      `json:"guide,omitempty"`
	Key    string       `json:"key"`
	Links  *[]GuideLink `json:"links,omitempty"`
	Title  string       `json:"title"`
}

GuideStep defines model for GuideStep.

type Health

type Health struct {
	Status string `json:"status"`
}

Health defines model for Health.

type IdParam

type IdParam = string

IdParam defines model for IdParam.

type IdeaReading added in v2.9.0

type IdeaReading struct {
	Answers []struct {
		// Field The field the question fills, by JSON pointer.
		Field      string  `json:"field"`
		Key        string  `json:"key"`
		Likelihood float32 `json:"likelihood"`
		Question   string  `json:"question"`
		Sentence   string  `json:"sentence"`
	} `json:"answers"`
	Available bool `json:"available"`
}

IdeaReading defines model for IdeaReading.

type IncludeChangeSetItem204Response added in v2.7.0

type IncludeChangeSetItem204Response struct {
}

func (IncludeChangeSetItem204Response) VisitIncludeChangeSetItemResponse added in v2.7.0

func (response IncludeChangeSetItem204Response) VisitIncludeChangeSetItemResponse(w http.ResponseWriter) error

type IncludeChangeSetItem401JSONResponse added in v2.7.0

type IncludeChangeSetItem401JSONResponse struct{ UnauthenticatedJSONResponse }

func (IncludeChangeSetItem401JSONResponse) VisitIncludeChangeSetItemResponse added in v2.7.0

func (response IncludeChangeSetItem401JSONResponse) VisitIncludeChangeSetItemResponse(w http.ResponseWriter) error

type IncludeChangeSetItem403JSONResponse added in v2.7.0

type IncludeChangeSetItem403JSONResponse struct{ ForbiddenJSONResponse }

func (IncludeChangeSetItem403JSONResponse) VisitIncludeChangeSetItemResponse added in v2.7.0

func (response IncludeChangeSetItem403JSONResponse) VisitIncludeChangeSetItemResponse(w http.ResponseWriter) error

type IncludeChangeSetItem404JSONResponse added in v2.7.0

type IncludeChangeSetItem404JSONResponse struct{ NotFoundJSONResponse }

func (IncludeChangeSetItem404JSONResponse) VisitIncludeChangeSetItemResponse added in v2.7.0

func (response IncludeChangeSetItem404JSONResponse) VisitIncludeChangeSetItemResponse(w http.ResponseWriter) error

type IncludeChangeSetItem409JSONResponse added in v2.7.0

type IncludeChangeSetItem409JSONResponse ProblemList

func (IncludeChangeSetItem409JSONResponse) VisitIncludeChangeSetItemResponse added in v2.7.0

func (response IncludeChangeSetItem409JSONResponse) VisitIncludeChangeSetItemResponse(w http.ResponseWriter) error

type IncludeChangeSetItemJSONRequestBody added in v2.7.0

type IncludeChangeSetItemJSONRequestBody = ChangeSetInclude

IncludeChangeSetItemJSONRequestBody defines body for IncludeChangeSetItem for application/json ContentType.

type IncludeChangeSetItemRequestObject added in v2.7.0

type IncludeChangeSetItemRequestObject struct {
	Set  ChangeSetParam `json:"set"`
	Kind KindParam      `json:"kind"`
	Id   IdParam        `json:"id"`
	Body *IncludeChangeSetItemJSONRequestBody
}

type IncludeChangeSetItemResponseObject added in v2.7.0

type IncludeChangeSetItemResponseObject interface {
	VisitIncludeChangeSetItemResponse(w http.ResponseWriter) error
}

type InvalidParamFormatError

type InvalidParamFormatError struct {
	ParamName string
	Err       error
}

func (*InvalidParamFormatError) Error

func (e *InvalidParamFormatError) Error() string

func (*InvalidParamFormatError) Unwrap

func (e *InvalidParamFormatError) Unwrap() error

type KindCount

type KindCount struct {
	Count int    `json:"count"`
	Kind  string `json:"kind"`

	// Summary The kind in one sentence, from its guidance, for a list of kinds to show beside its name.
	Summary *string `json:"summary,omitempty"`
}

KindCount defines model for KindCount.

type KindParam

type KindParam = string

KindParam defines model for KindParam.

type Lineage added in v2.10.0

type Lineage struct {
	// Edges Each in the direction the data flows.
	Edges []GraphEdge   `json:"edges"`
	Nodes []LineageNode `json:"nodes"`
}

Lineage defines model for Lineage.

type LineageNode added in v2.10.0

type LineageNode struct {
	Id   string          `json:"id"`
	Kind string          `json:"kind"`
	Name string          `json:"name"`
	Role LineageNodeRole `json:"role"`

	// X Its column, 0 to 4, left to right as the data flows.
	X float32 `json:"x"`

	// Y Its row in the column, centred on 0.
	Y float32 `json:"y"`
}

LineageNode defines model for LineageNode.

type LineageNodeRole added in v2.10.0

type LineageNodeRole string

LineageNodeRole defines model for LineageNode.Role.

const (
	LineageNodeRoleDownstream LineageNodeRole = "downstream"
	LineageNodeRoleOutput     LineageNodeRole = "output"
	LineageNodeRoleProject    LineageNodeRole = "project"
	LineageNodeRoleSource     LineageNodeRole = "source"
	LineageNodeRoleUpstream   LineageNodeRole = "upstream"
)

Defines values for LineageNodeRole.

func (LineageNodeRole) Valid added in v2.10.0

func (e LineageNodeRole) Valid() bool

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

type LinkCandidate added in v2.9.0

type LinkCandidate struct {
	Allowed bool   `json:"allowed"`
	Id      string `json:"id"`
	Kind    string `json:"kind"`

	// Linked Already linked; removing it is the way to change it.
	Linked *bool  `json:"linked,omitempty"`
	Name   string `json:"name"`

	// Reason Why the link may not be made, in a sentence a person reads.
	Reason *string `json:"reason,omitempty"`
}

LinkCandidate defines model for LinkCandidate.

type LinkKind added in v2.9.0

type LinkKind string

LinkKind A kind of link between two records: problem-gap (a project's problem cites a gap), problem-group (a problem affects a beneficiary group), gap-group (a gap affects a group), gap-outcome (a gap closes into an outcome), goal-parent (an aim sits under another), goal-contributes (an outcome also leads to another aim), kpi-gap (an indicator measures a gap), project-outcome (a project serves an outcome), project-component and programme-component (a project or a programme depends on another project or programme, TAXONOMY.md D46).

const (
	GapGroup           LinkKind = "gap-group"
	GapOutcome         LinkKind = "gap-outcome"
	GoalContributes    LinkKind = "goal-contributes"
	GoalParent         LinkKind = "goal-parent"
	KpiGap             LinkKind = "kpi-gap"
	ProblemGap         LinkKind = "problem-gap"
	ProblemGroup       LinkKind = "problem-group"
	ProgrammeComponent LinkKind = "programme-component"
	ProjectComponent   LinkKind = "project-component"
	ProjectOutcome     LinkKind = "project-outcome"
)

Defines values for LinkKind.

func (LinkKind) Valid added in v2.9.0

func (e LinkKind) Valid() bool

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

type ListAgentGrants200JSONResponse added in v2.5.0

type ListAgentGrants200JSONResponse []AgentGrant

func (ListAgentGrants200JSONResponse) VisitListAgentGrantsResponse added in v2.5.0

func (response ListAgentGrants200JSONResponse) VisitListAgentGrantsResponse(w http.ResponseWriter) error

type ListAgentGrants401JSONResponse added in v2.5.0

type ListAgentGrants401JSONResponse struct{ UnauthenticatedJSONResponse }

func (ListAgentGrants401JSONResponse) VisitListAgentGrantsResponse added in v2.5.0

func (response ListAgentGrants401JSONResponse) VisitListAgentGrantsResponse(w http.ResponseWriter) error

type ListAgentGrants403JSONResponse added in v2.5.0

type ListAgentGrants403JSONResponse struct{ ForbiddenJSONResponse }

func (ListAgentGrants403JSONResponse) VisitListAgentGrantsResponse added in v2.5.0

func (response ListAgentGrants403JSONResponse) VisitListAgentGrantsResponse(w http.ResponseWriter) error

type ListAgentGrantsParams added in v2.5.0

type ListAgentGrantsParams struct {
	Person *string `form:"person,omitempty" json:"person,omitempty"`
}

ListAgentGrantsParams defines parameters for ListAgentGrants.

type ListAgentGrantsRequestObject added in v2.5.0

type ListAgentGrantsRequestObject struct {
	Params ListAgentGrantsParams
}

type ListAgentGrantsResponseObject added in v2.5.0

type ListAgentGrantsResponseObject interface {
	VisitListAgentGrantsResponse(w http.ResponseWriter) error
}

type ListChangeSets200JSONResponse added in v2.7.0

type ListChangeSets200JSONResponse []ChangeSet

func (ListChangeSets200JSONResponse) VisitListChangeSetsResponse added in v2.7.0

func (response ListChangeSets200JSONResponse) VisitListChangeSetsResponse(w http.ResponseWriter) error

type ListChangeSets401JSONResponse added in v2.7.0

type ListChangeSets401JSONResponse struct{ UnauthenticatedJSONResponse }

func (ListChangeSets401JSONResponse) VisitListChangeSetsResponse added in v2.7.0

func (response ListChangeSets401JSONResponse) VisitListChangeSetsResponse(w http.ResponseWriter) error

type ListChangeSets403JSONResponse added in v2.7.0

type ListChangeSets403JSONResponse struct{ ForbiddenJSONResponse }

func (ListChangeSets403JSONResponse) VisitListChangeSetsResponse added in v2.7.0

func (response ListChangeSets403JSONResponse) VisitListChangeSetsResponse(w http.ResponseWriter) error

type ListChangeSetsParams added in v2.7.0

type ListChangeSetsParams struct {
	Status   *ListChangeSetsParamsStatus `form:"status,omitempty" json:"status,omitempty"`
	Everyone *bool                       `form:"everyone,omitempty" json:"everyone,omitempty"`
}

ListChangeSetsParams defines parameters for ListChangeSets.

type ListChangeSetsParamsStatus added in v2.7.0

type ListChangeSetsParamsStatus string

ListChangeSetsParamsStatus defines parameters for ListChangeSets.

const (
	ListChangeSetsParamsStatusClosed   ListChangeSetsParamsStatus = "closed"
	ListChangeSetsParamsStatusMerged   ListChangeSetsParamsStatus = "merged"
	ListChangeSetsParamsStatusMerging  ListChangeSetsParamsStatus = "merging"
	ListChangeSetsParamsStatusOpen     ListChangeSetsParamsStatus = "open"
	ListChangeSetsParamsStatusProposed ListChangeSetsParamsStatus = "proposed"
)

Defines values for ListChangeSetsParamsStatus.

func (ListChangeSetsParamsStatus) Valid added in v2.7.0

func (e ListChangeSetsParamsStatus) Valid() bool

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

type ListChangeSetsRequestObject added in v2.7.0

type ListChangeSetsRequestObject struct {
	Params ListChangeSetsParams
}

type ListChangeSetsResponseObject added in v2.7.0

type ListChangeSetsResponseObject interface {
	VisitListChangeSetsResponse(w http.ResponseWriter) 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 {
	// ChangeSet Read as if this change set were accepted (docs/adr/0024): its drafts stand in for the records they change, and the records it creates are there too, each marked proposed. For reviewing a change set in the ordinary screens.
	ChangeSet *PreviewParam `form:"changeSet,omitempty" json:"changeSet,omitempty"`

	// 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 ListPeople200JSONResponse added in v2.2.0

type ListPeople200JSONResponse struct {
	People []Person `json:"people"`
}

func (ListPeople200JSONResponse) VisitListPeopleResponse added in v2.2.0

func (response ListPeople200JSONResponse) VisitListPeopleResponse(w http.ResponseWriter) error

type ListPeople401JSONResponse added in v2.2.0

type ListPeople401JSONResponse struct{ UnauthenticatedJSONResponse }

func (ListPeople401JSONResponse) VisitListPeopleResponse added in v2.2.0

func (response ListPeople401JSONResponse) VisitListPeopleResponse(w http.ResponseWriter) error

type ListPeople403JSONResponse added in v2.2.0

type ListPeople403JSONResponse struct{ ForbiddenJSONResponse }

func (ListPeople403JSONResponse) VisitListPeopleResponse added in v2.2.0

func (response ListPeople403JSONResponse) VisitListPeopleResponse(w http.ResponseWriter) error

type ListPeople404JSONResponse added in v2.2.0

type ListPeople404JSONResponse struct{ NotFoundJSONResponse }

func (ListPeople404JSONResponse) VisitListPeopleResponse added in v2.2.0

func (response ListPeople404JSONResponse) VisitListPeopleResponse(w http.ResponseWriter) error

type ListPeopleRequestObject added in v2.2.0

type ListPeopleRequestObject struct {
}

type ListPeopleResponseObject added in v2.2.0

type ListPeopleResponseObject interface {
	VisitListPeopleResponse(w http.ResponseWriter) error
}

type ListProposals200JSONResponse added in v2.5.0

type ListProposals200JSONResponse []Proposal

func (ListProposals200JSONResponse) VisitListProposalsResponse added in v2.5.0

func (response ListProposals200JSONResponse) VisitListProposalsResponse(w http.ResponseWriter) error

type ListProposals401JSONResponse added in v2.5.0

type ListProposals401JSONResponse struct{ UnauthenticatedJSONResponse }

func (ListProposals401JSONResponse) VisitListProposalsResponse added in v2.5.0

func (response ListProposals401JSONResponse) VisitListProposalsResponse(w http.ResponseWriter) error

type ListProposals403JSONResponse added in v2.5.0

type ListProposals403JSONResponse struct{ ForbiddenJSONResponse }

func (ListProposals403JSONResponse) VisitListProposalsResponse added in v2.5.0

func (response ListProposals403JSONResponse) VisitListProposalsResponse(w http.ResponseWriter) error

type ListProposalsParams added in v2.5.0

type ListProposalsParams struct {
	Kind *string `form:"kind,omitempty" json:"kind,omitempty"`
	Id   *string `form:"id,omitempty" json:"id,omitempty"`

	// Status open (the default), accepted, declined, or all.
	Status *ListProposalsParamsStatus `form:"status,omitempty" json:"status,omitempty"`
}

ListProposalsParams defines parameters for ListProposals.

type ListProposalsParamsStatus added in v2.5.0

type ListProposalsParamsStatus string

ListProposalsParamsStatus defines parameters for ListProposals.

const (
	ListProposalsParamsStatusAccepted ListProposalsParamsStatus = "accepted"
	ListProposalsParamsStatusAll      ListProposalsParamsStatus = "all"
	ListProposalsParamsStatusDeclined ListProposalsParamsStatus = "declined"
	ListProposalsParamsStatusOpen     ListProposalsParamsStatus = "open"
)

Defines values for ListProposalsParamsStatus.

func (ListProposalsParamsStatus) Valid added in v2.5.0

func (e ListProposalsParamsStatus) Valid() bool

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

type ListProposalsRequestObject added in v2.5.0

type ListProposalsRequestObject struct {
	Params ListProposalsParams
}

type ListProposalsResponseObject added in v2.5.0

type ListProposalsResponseObject interface {
	VisitListProposalsResponse(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 ListVersionsRequestObject

type ListVersionsRequestObject struct {
	Kind KindParam `json:"kind"`
	Id   IdParam   `json:"id"`
}

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 {
		Alias  *string            `json:"alias,omitempty"`
		Id     string             `json:"id"`
		Labels *map[string]string `json:"labels,omitempty"`
		Name   string             `json:"name"`

		// Pending References not made yet (TAXONOMY.md D31), as stored. An edit made from this copy keeps them.
		Pending *[]Pending `json:"pending,omitempty"`
	} `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 ManifestCheck added in v2.6.0

type ManifestCheck struct {
	Id      string `json:"id"`
	Message string `json:"message"`

	// Path The field it is about, as a JSON pointer, where it is one field: what the record must have before it can be merged.
	Path *string `json:"path,omitempty"`

	// Section The editor's section where it is fixed.
	Section *string            `json:"section,omitempty"`
	State   ManifestCheckState `json:"state"`
}

ManifestCheck One thing a manifest still needs, as every kind reports it: met (ok), advice (warn), or a block on a handoff (block).

type ManifestCheckState added in v2.6.0

type ManifestCheckState string

ManifestCheckState defines model for ManifestCheck.State.

const (
	ManifestCheckStateBlock ManifestCheckState = "block"
	ManifestCheckStateOk    ManifestCheckState = "ok"
	ManifestCheckStateWarn  ManifestCheckState = "warn"
)

Defines values for ManifestCheckState.

func (ManifestCheckState) Valid added in v2.6.0

func (e ManifestCheckState) Valid() bool

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

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"`

	// Proposed Present when read with changeSet and the change set creates this record (new) or changes it (changed); absent otherwise.
	Proposed *Proposed `json:"proposed,omitempty"`
	Version  Version   `json:"version"`
	Yaml     string    `json:"yaml"`
}

ManifestView defines model for ManifestView.

type Match added in v2.9.0

type Match struct {
	// By Whether the decision model judged it, or the words the two share.
	By MatchBy `json:"by"`

	// Detail What the record says, beside its name.
	Detail *string `json:"detail,omitempty"`
	Id     string  `json:"id"`
	Kind   string  `json:"kind"`
	Level  *string `json:"level,omitempty"`

	// Likelihood How likely it is to say the same thing, from 0 to 1.
	Likelihood float64 `json:"likelihood"`
	Name       string  `json:"name"`
}

Match defines model for Match.

type MatchBy added in v2.9.0

type MatchBy string

MatchBy Whether the decision model judged it, or the words the two share.

const (
	Model MatchBy = "model"
	Words MatchBy = "words"
)

Defines values for MatchBy.

func (MatchBy) Valid added in v2.9.0

func (e MatchBy) Valid() bool

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

type MatchExisting200JSONResponse added in v2.9.0

type MatchExisting200JSONResponse []Match

func (MatchExisting200JSONResponse) VisitMatchExistingResponse added in v2.9.0

func (response MatchExisting200JSONResponse) VisitMatchExistingResponse(w http.ResponseWriter) error

type MatchExisting401JSONResponse added in v2.9.0

type MatchExisting401JSONResponse struct{ UnauthenticatedJSONResponse }

func (MatchExisting401JSONResponse) VisitMatchExistingResponse added in v2.9.0

func (response MatchExisting401JSONResponse) VisitMatchExistingResponse(w http.ResponseWriter) error

type MatchExisting403JSONResponse added in v2.9.0

type MatchExisting403JSONResponse struct{ ForbiddenJSONResponse }

func (MatchExisting403JSONResponse) VisitMatchExistingResponse added in v2.9.0

func (response MatchExisting403JSONResponse) VisitMatchExistingResponse(w http.ResponseWriter) error

type MatchExistingJSONBody added in v2.9.0

type MatchExistingJSONBody struct {
	Kind  string  `json:"kind"`
	Level *string `json:"level,omitempty"`
	Text  string  `json:"text"`
}

MatchExistingJSONBody defines parameters for MatchExisting.

type MatchExistingJSONRequestBody added in v2.9.0

type MatchExistingJSONRequestBody MatchExistingJSONBody

MatchExistingJSONRequestBody defines body for MatchExisting for application/json ContentType.

type MatchExistingRequestObject added in v2.9.0

type MatchExistingRequestObject struct {
	Body *MatchExistingJSONRequestBody
}

type MatchExistingResponseObject added in v2.9.0

type MatchExistingResponseObject interface {
	VisitMatchExistingResponse(w http.ResponseWriter) error
}

type MiddlewareFunc

type MiddlewareFunc func(http.Handler) http.Handler

type MoveInChangeSet204Response added in v2.9.0

type MoveInChangeSet204Response struct {
}

func (MoveInChangeSet204Response) VisitMoveInChangeSetResponse added in v2.9.0

func (response MoveInChangeSet204Response) VisitMoveInChangeSetResponse(w http.ResponseWriter) error

type MoveInChangeSet401JSONResponse added in v2.9.0

type MoveInChangeSet401JSONResponse struct{ UnauthenticatedJSONResponse }

func (MoveInChangeSet401JSONResponse) VisitMoveInChangeSetResponse added in v2.9.0

func (response MoveInChangeSet401JSONResponse) VisitMoveInChangeSetResponse(w http.ResponseWriter) error

type MoveInChangeSet403JSONResponse added in v2.9.0

type MoveInChangeSet403JSONResponse struct{ ForbiddenJSONResponse }

func (MoveInChangeSet403JSONResponse) VisitMoveInChangeSetResponse added in v2.9.0

func (response MoveInChangeSet403JSONResponse) VisitMoveInChangeSetResponse(w http.ResponseWriter) error

type MoveInChangeSet404JSONResponse added in v2.9.0

type MoveInChangeSet404JSONResponse struct{ NotFoundJSONResponse }

func (MoveInChangeSet404JSONResponse) VisitMoveInChangeSetResponse added in v2.9.0

func (response MoveInChangeSet404JSONResponse) VisitMoveInChangeSetResponse(w http.ResponseWriter) error

type MoveInChangeSetJSONBody added in v2.9.0

type MoveInChangeSetJSONBody struct {
	// State The state to move to, as ProjectState names them.
	State string `json:"state"`
}

MoveInChangeSetJSONBody defines parameters for MoveInChangeSet.

type MoveInChangeSetJSONRequestBody added in v2.9.0

type MoveInChangeSetJSONRequestBody MoveInChangeSetJSONBody

MoveInChangeSetJSONRequestBody defines body for MoveInChangeSet for application/json ContentType.

type MoveInChangeSetRequestObject added in v2.9.0

type MoveInChangeSetRequestObject struct {
	Set  ChangeSetParam `json:"set"`
	Id   IdParam        `json:"id"`
	Body *MoveInChangeSetJSONRequestBody
}

type MoveInChangeSetResponseObject added in v2.9.0

type MoveInChangeSetResponseObject interface {
	VisitMoveInChangeSetResponse(w http.ResponseWriter) error
}

type NotFound

type NotFound = ProblemList

NotFound defines model for NotFound.

type NotFoundJSONResponse

type NotFoundJSONResponse ProblemList

type Order added in v2.7.0

type Order struct {
	// Next The key of the stage to write now; absent once every stage a plan needs has a record.
	Next *string `json:"next,omitempty"`

	// Registers The root kinds, each with how many records it has.
	Registers []KindCount  `json:"registers"`
	Stages    []OrderStage `json:"stages"`
}

Order defines model for Order.

type OrderStage added in v2.7.0

type OrderStage struct {
	// After The stages that need a record before this one can be written well.
	After *[]string `json:"after,omitempty"`
	Count int       `json:"count"`
	Key   string    `json:"key"`
	Kind  string    `json:"kind"`

	// Level For a Goal, the level the stage writes.
	Level *string `json:"level,omitempty"`

	// Optional A stage a workspace may leave empty.
	Optional *bool `json:"optional,omitempty"`

	// State done when it has a record; next for the stage to write now; ready when what it names is there; waiting while a stage before it has no record.
	State OrderStageState `json:"state"`

	// Waiting The stages it waits on, while it waits.
	Waiting *[]string `json:"waiting,omitempty"`
}

OrderStage defines model for OrderStage.

type OrderStageState added in v2.7.0

type OrderStageState string

OrderStageState done when it has a record; next for the stage to write now; ready when what it names is there; waiting while a stage before it has no record.

const (
	Done    OrderStageState = "done"
	Next    OrderStageState = "next"
	Ready   OrderStageState = "ready"
	Waiting OrderStageState = "waiting"
)

Defines values for OrderStageState.

func (OrderStageState) Valid added in v2.7.0

func (e OrderStageState) Valid() bool

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

type Pending added in v2.9.0

type Pending struct {
	Kind string  `json:"kind"`
	Name string  `json:"name"`
	Note *string `json:"note,omitempty"`
	Path string  `json:"path"`
}

Pending One placeholder, mirroring common.schema.json Metadata.pending.

type Person added in v2.2.0

type Person struct {
	// AddedBy Who listed them, or "directory" when a sign-in enrolled them.
	AddedBy string    `json:"addedBy"`
	AddedOn time.Time `json:"addedOn"`

	// AgentsOff An administrator turned this person's agents off.
	AgentsOff *bool `json:"agentsOff,omitempty"`

	// DirectoryRoles The roles the person's directory groups gave at their last sign-in.
	DirectoryRoles []Role `json:"directoryRoles"`

	// DirectoryTeams The teams the person's directory groups gave at their last sign-in, by id.
	DirectoryTeams []string `json:"directoryTeams"`
	Email          string   `json:"email"`

	// LastSignedIn Absent until the first sign-in.
	LastSignedIn *time.Time `json:"lastSignedIn,omitempty"`

	// Name The display name from the directory; empty until the first sign-in.
	Name string `json:"name"`

	// Roles The roles an administrator granted.
	Roles []Role `json:"roles"`

	// Teams The teams an administrator granted, by id.
	Teams []string `json:"teams"`
}

Person One entry on the access list: someone who may sign in, never a manifest (TAXONOMY.md D27).

type PersonGrant added in v2.2.0

type PersonGrant struct {
	// AgentsOff Turn this person's agents off whatever their roles allow (docs/adr/0016). False when left out.
	AgentsOff *bool  `json:"agentsOff,omitempty"`
	Roles     []Role `json:"roles"`

	// Teams Team ids.
	Teams []string `json:"teams"`
}

PersonGrant defines model for PersonGrant.

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 PostSnapshot409JSONResponse added in v2.9.0

type PostSnapshot409JSONResponse struct{ ChangeSetRequiredJSONResponse }

func (PostSnapshot409JSONResponse) VisitPostSnapshotResponse added in v2.9.0

func (response PostSnapshot409JSONResponse) 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 PreviewParam added in v2.9.0

type PreviewParam = string

PreviewParam defines model for PreviewParam.

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 Proposal added in v2.5.0

type Proposal struct {
	// Agent The agent that proposed it, as it names itself.
	Agent string    `json:"agent"`
	At    time.Time `json:"at"`

	// Base The manifest's latest version when it was proposed.
	Base      int        `json:"base"`
	DecidedAt *time.Time `json:"decidedAt,omitempty"`
	DecidedBy *string    `json:"decidedBy,omitempty"`

	// For The person it acts for, who alone may accept it.
	For  string                  `json:"for"`
	Id   string                  `json:"id"`
	Item *map[string]interface{} `json:"item,omitempty"`
	Kind string                  `json:"kind"`

	// Manifest The proposed manifest, for save.
	Manifest   *map[string]interface{} `json:"manifest,omitempty"`
	ManifestId string                  `json:"manifestId"`

	// Op save commits the proposed manifest; append records one item of a series (series, item); state moves a project (state).
	Op     ProposalOp `json:"op"`
	Reason string     `json:"reason"`
	Series *string    `json:"series,omitempty"`

	// Set The set this proposal belongs to, whose proposals are accepted or declined together; absent for one on its own.
	Set    *string        `json:"set,omitempty"`
	State  *string        `json:"state,omitempty"`
	Status ProposalStatus `json:"status"`

	// Version The version accepting it made, when it made one.
	Version *int `json:"version,omitempty"`

	// Waivers The checks the agent left open, each with why. An agent may propose only what meets every check, or what names each check it leaves open.
	Waivers *[]Waiver `json:"waivers,omitempty"`
}

Proposal Something an agent proposed for its person to confirm (docs/adr/0016).

type ProposalDecision added in v2.5.0

type ProposalDecision struct {
	// Reason Why, recorded with the decision.
	Reason *string `json:"reason,omitempty"`
}

ProposalDecision defines model for ProposalDecision.

type ProposalOp added in v2.5.0

type ProposalOp string

ProposalOp save commits the proposed manifest; append records one item of a series (series, item); state moves a project (state).

const (
	ProposalOpAppend ProposalOp = "append"
	ProposalOpSave   ProposalOp = "save"
	ProposalOpState  ProposalOp = "state"
)

Defines values for ProposalOp.

func (ProposalOp) Valid added in v2.5.0

func (e ProposalOp) Valid() bool

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

type ProposalParam added in v2.5.0

type ProposalParam = string

ProposalParam defines model for ProposalParam.

type ProposalPart added in v2.6.0

type ProposalPart struct {
	// Changes What saving it would change, against the base version (everything, for a new manifest).
	Changes []Change        `json:"changes"`
	Checks  []ManifestCheck `json:"checks"`

	// Proposal Something an agent proposed for its person to confirm (docs/adr/0016).
	Proposal Proposal `json:"proposal"`
}

ProposalPart defines model for ProposalPart.

type ProposalReview added in v2.6.0

type ProposalReview struct {
	Parts []ProposalPart `json:"parts"`

	// Proposal Something an agent proposed for its person to confirm (docs/adr/0016).
	Proposal Proposal `json:"proposal"`
}

ProposalReview A proposal as its person reviews it: every part, in the order they would be saved. A proposal on its own has one part; a set (a KPI, the gap it measures and the outcome that closes it) has one per manifest, accepted or declined together.

type ProposalStatus added in v2.5.0

type ProposalStatus string

ProposalStatus defines model for Proposal.Status.

const (
	ProposalStatusAccepted ProposalStatus = "accepted"
	ProposalStatusDeclined ProposalStatus = "declined"
	ProposalStatusOpen     ProposalStatus = "open"
)

Defines values for ProposalStatus.

func (ProposalStatus) Valid added in v2.5.0

func (e ProposalStatus) Valid() bool

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

type ProposeChangeSet200JSONResponse added in v2.7.0

type ProposeChangeSet200JSONResponse ChangeSet

func (ProposeChangeSet200JSONResponse) VisitProposeChangeSetResponse added in v2.7.0

func (response ProposeChangeSet200JSONResponse) VisitProposeChangeSetResponse(w http.ResponseWriter) error

type ProposeChangeSet401JSONResponse added in v2.7.0

type ProposeChangeSet401JSONResponse struct{ UnauthenticatedJSONResponse }

func (ProposeChangeSet401JSONResponse) VisitProposeChangeSetResponse added in v2.7.0

func (response ProposeChangeSet401JSONResponse) VisitProposeChangeSetResponse(w http.ResponseWriter) error

type ProposeChangeSet403JSONResponse added in v2.7.0

type ProposeChangeSet403JSONResponse struct{ ForbiddenJSONResponse }

func (ProposeChangeSet403JSONResponse) VisitProposeChangeSetResponse added in v2.7.0

func (response ProposeChangeSet403JSONResponse) VisitProposeChangeSetResponse(w http.ResponseWriter) error

type ProposeChangeSet404JSONResponse added in v2.7.0

type ProposeChangeSet404JSONResponse struct{ NotFoundJSONResponse }

func (ProposeChangeSet404JSONResponse) VisitProposeChangeSetResponse added in v2.7.0

func (response ProposeChangeSet404JSONResponse) VisitProposeChangeSetResponse(w http.ResponseWriter) error

type ProposeChangeSet409JSONResponse added in v2.7.0

type ProposeChangeSet409JSONResponse ProblemList

func (ProposeChangeSet409JSONResponse) VisitProposeChangeSetResponse added in v2.7.0

func (response ProposeChangeSet409JSONResponse) VisitProposeChangeSetResponse(w http.ResponseWriter) error

type ProposeChangeSet422JSONResponse added in v2.7.0

type ProposeChangeSet422JSONResponse struct{ UnprocessableJSONResponse }

func (ProposeChangeSet422JSONResponse) VisitProposeChangeSetResponse added in v2.7.0

func (response ProposeChangeSet422JSONResponse) VisitProposeChangeSetResponse(w http.ResponseWriter) error

type ProposeChangeSetJSONRequestBody added in v2.7.0

type ProposeChangeSetJSONRequestBody = ChangeSetProposal

ProposeChangeSetJSONRequestBody defines body for ProposeChangeSet for application/json ContentType.

type ProposeChangeSetRequestObject added in v2.7.0

type ProposeChangeSetRequestObject struct {
	Set  ChangeSetParam `json:"set"`
	Body *ProposeChangeSetJSONRequestBody
}

type ProposeChangeSetResponseObject added in v2.7.0

type ProposeChangeSetResponseObject interface {
	VisitProposeChangeSetResponse(w http.ResponseWriter) error
}

type Proposed added in v2.9.0

type Proposed string

Proposed Present when read with changeSet and the change set creates this record (new) or changes it (changed); absent otherwise.

const (
	Changed Proposed = "changed"
	New     Proposed = "new"
)

Defines values for Proposed.

func (Proposed) Valid added in v2.9.0

func (e Proposed) Valid() bool

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

type PutChangeSetItem200JSONResponse added in v2.7.0

type PutChangeSetItem200JSONResponse ChangeSetDraft

func (PutChangeSetItem200JSONResponse) VisitPutChangeSetItemResponse added in v2.7.0

func (response PutChangeSetItem200JSONResponse) VisitPutChangeSetItemResponse(w http.ResponseWriter) error

type PutChangeSetItem401JSONResponse added in v2.7.0

type PutChangeSetItem401JSONResponse struct{ UnauthenticatedJSONResponse }

func (PutChangeSetItem401JSONResponse) VisitPutChangeSetItemResponse added in v2.7.0

func (response PutChangeSetItem401JSONResponse) VisitPutChangeSetItemResponse(w http.ResponseWriter) error

type PutChangeSetItem403JSONResponse added in v2.7.0

type PutChangeSetItem403JSONResponse struct{ ForbiddenJSONResponse }

func (PutChangeSetItem403JSONResponse) VisitPutChangeSetItemResponse added in v2.7.0

func (response PutChangeSetItem403JSONResponse) VisitPutChangeSetItemResponse(w http.ResponseWriter) error

type PutChangeSetItem404JSONResponse added in v2.7.0

type PutChangeSetItem404JSONResponse struct{ NotFoundJSONResponse }

func (PutChangeSetItem404JSONResponse) VisitPutChangeSetItemResponse added in v2.7.0

func (response PutChangeSetItem404JSONResponse) VisitPutChangeSetItemResponse(w http.ResponseWriter) error

type PutChangeSetItem409JSONResponse added in v2.7.0

type PutChangeSetItem409JSONResponse ProblemList

func (PutChangeSetItem409JSONResponse) VisitPutChangeSetItemResponse added in v2.7.0

func (response PutChangeSetItem409JSONResponse) VisitPutChangeSetItemResponse(w http.ResponseWriter) error

type PutChangeSetItem422JSONResponse added in v2.7.0

type PutChangeSetItem422JSONResponse struct{ UnprocessableJSONResponse }

func (PutChangeSetItem422JSONResponse) VisitPutChangeSetItemResponse added in v2.7.0

func (response PutChangeSetItem422JSONResponse) VisitPutChangeSetItemResponse(w http.ResponseWriter) error

type PutChangeSetItemJSONRequestBody added in v2.7.0

type PutChangeSetItemJSONRequestBody = ChangeSetEdit

PutChangeSetItemJSONRequestBody defines body for PutChangeSetItem for application/json ContentType.

type PutChangeSetItemRequestObject added in v2.7.0

type PutChangeSetItemRequestObject struct {
	Set  ChangeSetParam `json:"set"`
	Kind KindParam      `json:"kind"`
	Id   IdParam        `json:"id"`
	Body *PutChangeSetItemJSONRequestBody
}

type PutChangeSetItemResponseObject added in v2.7.0

type PutChangeSetItemResponseObject interface {
	VisitPutChangeSetItemResponse(w http.ResponseWriter) error
}

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

type References struct {
	Incoming []Summary `json:"incoming"`
	Outgoing []Ref     `json:"outgoing"`

	// Uses Every incoming reference with where it sits in the manifest that makes it, and what that place means for this one: a governance body or a role confirms a success criterion, receives an escalation or decided a mandate (TAXONOMY.md D43).
	Uses *[]Use `json:"uses,omitempty"`
}

References defines model for References.

type Relevance added in v2.9.0

type Relevance struct {
	// Available False when no decision model answered; the ranking is then by shared words.
	Available bool    `json:"available"`
	Matches   []Match `json:"matches"`
}

Relevance defines model for Relevance.

type Relevant200JSONResponse added in v2.9.0

type Relevant200JSONResponse Relevance

func (Relevant200JSONResponse) VisitRelevantResponse added in v2.9.0

func (response Relevant200JSONResponse) VisitRelevantResponse(w http.ResponseWriter) error

type Relevant401JSONResponse added in v2.9.0

type Relevant401JSONResponse struct{ UnauthenticatedJSONResponse }

func (Relevant401JSONResponse) VisitRelevantResponse added in v2.9.0

func (response Relevant401JSONResponse) VisitRelevantResponse(w http.ResponseWriter) error

type Relevant403JSONResponse added in v2.9.0

type Relevant403JSONResponse struct{ ForbiddenJSONResponse }

func (Relevant403JSONResponse) VisitRelevantResponse added in v2.9.0

func (response Relevant403JSONResponse) VisitRelevantResponse(w http.ResponseWriter) error

type RelevantJSONBody added in v2.9.0

type RelevantJSONBody struct {
	Kinds *[]string `json:"kinds,omitempty"`

	// Level For Goal, the level to rank among.
	Level *string `json:"level,omitempty"`

	// Limit How many of each kind, 3 when left out.
	Limit *int `json:"limit,omitempty"`

	// Text What the work is about, and as much of what has been written of it as helps.
	Text string `json:"text"`
}

RelevantJSONBody defines parameters for Relevant.

type RelevantJSONRequestBody added in v2.9.0

type RelevantJSONRequestBody RelevantJSONBody

RelevantJSONRequestBody defines body for Relevant for application/json ContentType.

type RelevantRequestObject added in v2.9.0

type RelevantRequestObject struct {
	Body *RelevantJSONRequestBody
}

type RelevantResponseObject added in v2.9.0

type RelevantResponseObject interface {
	VisitRelevantResponse(w http.ResponseWriter) error
}

type RemoveInChangeSet204Response added in v2.9.0

type RemoveInChangeSet204Response struct {
}

func (RemoveInChangeSet204Response) VisitRemoveInChangeSetResponse added in v2.9.0

func (response RemoveInChangeSet204Response) VisitRemoveInChangeSetResponse(w http.ResponseWriter) error

type RemoveInChangeSet401JSONResponse added in v2.9.0

type RemoveInChangeSet401JSONResponse struct{ UnauthenticatedJSONResponse }

func (RemoveInChangeSet401JSONResponse) VisitRemoveInChangeSetResponse added in v2.9.0

func (response RemoveInChangeSet401JSONResponse) VisitRemoveInChangeSetResponse(w http.ResponseWriter) error

type RemoveInChangeSet403JSONResponse added in v2.9.0

type RemoveInChangeSet403JSONResponse struct{ ForbiddenJSONResponse }

func (RemoveInChangeSet403JSONResponse) VisitRemoveInChangeSetResponse added in v2.9.0

func (response RemoveInChangeSet403JSONResponse) VisitRemoveInChangeSetResponse(w http.ResponseWriter) error

type RemoveInChangeSet404JSONResponse added in v2.9.0

type RemoveInChangeSet404JSONResponse struct{ NotFoundJSONResponse }

func (RemoveInChangeSet404JSONResponse) VisitRemoveInChangeSetResponse added in v2.9.0

func (response RemoveInChangeSet404JSONResponse) VisitRemoveInChangeSetResponse(w http.ResponseWriter) error

type RemoveInChangeSetRequestObject added in v2.9.0

type RemoveInChangeSetRequestObject struct {
	Set  ChangeSetParam `json:"set"`
	Kind KindParam      `json:"kind"`
	Id   IdParam        `json:"id"`
}

type RemoveInChangeSetResponseObject added in v2.9.0

type RemoveInChangeSetResponseObject interface {
	VisitRemoveInChangeSetResponse(w http.ResponseWriter) error
}

type RemovePerson204Response added in v2.2.0

type RemovePerson204Response struct {
}

func (RemovePerson204Response) VisitRemovePersonResponse added in v2.2.0

func (response RemovePerson204Response) VisitRemovePersonResponse(w http.ResponseWriter) error

type RemovePerson401JSONResponse added in v2.2.0

type RemovePerson401JSONResponse struct{ UnauthenticatedJSONResponse }

func (RemovePerson401JSONResponse) VisitRemovePersonResponse added in v2.2.0

func (response RemovePerson401JSONResponse) VisitRemovePersonResponse(w http.ResponseWriter) error

type RemovePerson403JSONResponse added in v2.2.0

type RemovePerson403JSONResponse struct{ ForbiddenJSONResponse }

func (RemovePerson403JSONResponse) VisitRemovePersonResponse added in v2.2.0

func (response RemovePerson403JSONResponse) VisitRemovePersonResponse(w http.ResponseWriter) error

type RemovePerson404JSONResponse added in v2.2.0

type RemovePerson404JSONResponse struct{ NotFoundJSONResponse }

func (RemovePerson404JSONResponse) VisitRemovePersonResponse added in v2.2.0

func (response RemovePerson404JSONResponse) VisitRemovePersonResponse(w http.ResponseWriter) error

type RemovePerson409JSONResponse added in v2.2.0

type RemovePerson409JSONResponse ProblemList

func (RemovePerson409JSONResponse) VisitRemovePersonResponse added in v2.2.0

func (response RemovePerson409JSONResponse) VisitRemovePersonResponse(w http.ResponseWriter) error

type RemovePersonRequestObject added in v2.2.0

type RemovePersonRequestObject struct {
	Email string `json:"email"`
}

type RemovePersonResponseObject added in v2.2.0

type RemovePersonResponseObject interface {
	VisitRemovePersonResponse(w http.ResponseWriter) error
}

type ReopenChangeSet200JSONResponse added in v2.7.0

type ReopenChangeSet200JSONResponse ChangeSet

func (ReopenChangeSet200JSONResponse) VisitReopenChangeSetResponse added in v2.7.0

func (response ReopenChangeSet200JSONResponse) VisitReopenChangeSetResponse(w http.ResponseWriter) error

type ReopenChangeSet401JSONResponse added in v2.7.0

type ReopenChangeSet401JSONResponse struct{ UnauthenticatedJSONResponse }

func (ReopenChangeSet401JSONResponse) VisitReopenChangeSetResponse added in v2.7.0

func (response ReopenChangeSet401JSONResponse) VisitReopenChangeSetResponse(w http.ResponseWriter) error

type ReopenChangeSet403JSONResponse added in v2.7.0

type ReopenChangeSet403JSONResponse struct{ ForbiddenJSONResponse }

func (ReopenChangeSet403JSONResponse) VisitReopenChangeSetResponse added in v2.7.0

func (response ReopenChangeSet403JSONResponse) VisitReopenChangeSetResponse(w http.ResponseWriter) error

type ReopenChangeSet404JSONResponse added in v2.7.0

type ReopenChangeSet404JSONResponse struct{ NotFoundJSONResponse }

func (ReopenChangeSet404JSONResponse) VisitReopenChangeSetResponse added in v2.7.0

func (response ReopenChangeSet404JSONResponse) VisitReopenChangeSetResponse(w http.ResponseWriter) error

type ReopenChangeSet409JSONResponse added in v2.7.0

type ReopenChangeSet409JSONResponse ProblemList

func (ReopenChangeSet409JSONResponse) VisitReopenChangeSetResponse added in v2.7.0

func (response ReopenChangeSet409JSONResponse) VisitReopenChangeSetResponse(w http.ResponseWriter) error

type ReopenChangeSetJSONRequestBody added in v2.7.0

type ReopenChangeSetJSONRequestBody = ProposalDecision

ReopenChangeSetJSONRequestBody defines body for ReopenChangeSet for application/json ContentType.

type ReopenChangeSetRequestObject added in v2.7.0

type ReopenChangeSetRequestObject struct {
	Set  ChangeSetParam `json:"set"`
	Body *ReopenChangeSetJSONRequestBody
}

type ReopenChangeSetResponseObject added in v2.7.0

type ReopenChangeSetResponseObject interface {
	VisitReopenChangeSetResponse(w http.ResponseWriter) error
}

type Report added in v2.3.0

type Report struct {
	Columns []string `json:"columns"`
	Name    string   `json:"name"`

	// Rows One array per row, its values in the order of columns.
	Rows [][]interface{} `json:"rows"`
}

Report defines model for Report.

type RequiredHeaderError

type RequiredHeaderError struct {
	ParamName string
	Err       error
}

func (*RequiredHeaderError) Error

func (e *RequiredHeaderError) Error() string

func (*RequiredHeaderError) Unwrap

func (e *RequiredHeaderError) Unwrap() error

type RequiredParamError

type RequiredParamError struct {
	ParamName string
}

func (*RequiredParamError) Error

func (e *RequiredParamError) Error() string

type RetitleChangeSet200JSONResponse added in v2.7.0

type RetitleChangeSet200JSONResponse ChangeSet

func (RetitleChangeSet200JSONResponse) VisitRetitleChangeSetResponse added in v2.7.0

func (response RetitleChangeSet200JSONResponse) VisitRetitleChangeSetResponse(w http.ResponseWriter) error

type RetitleChangeSet401JSONResponse added in v2.7.0

type RetitleChangeSet401JSONResponse struct{ UnauthenticatedJSONResponse }

func (RetitleChangeSet401JSONResponse) VisitRetitleChangeSetResponse added in v2.7.0

func (response RetitleChangeSet401JSONResponse) VisitRetitleChangeSetResponse(w http.ResponseWriter) error

type RetitleChangeSet403JSONResponse added in v2.7.0

type RetitleChangeSet403JSONResponse struct{ ForbiddenJSONResponse }

func (RetitleChangeSet403JSONResponse) VisitRetitleChangeSetResponse added in v2.7.0

func (response RetitleChangeSet403JSONResponse) VisitRetitleChangeSetResponse(w http.ResponseWriter) error

type RetitleChangeSet404JSONResponse added in v2.7.0

type RetitleChangeSet404JSONResponse struct{ NotFoundJSONResponse }

func (RetitleChangeSet404JSONResponse) VisitRetitleChangeSetResponse added in v2.7.0

func (response RetitleChangeSet404JSONResponse) VisitRetitleChangeSetResponse(w http.ResponseWriter) error

type RetitleChangeSet409JSONResponse added in v2.7.0

type RetitleChangeSet409JSONResponse ProblemList

func (RetitleChangeSet409JSONResponse) VisitRetitleChangeSetResponse added in v2.7.0

func (response RetitleChangeSet409JSONResponse) VisitRetitleChangeSetResponse(w http.ResponseWriter) error

type RetitleChangeSetJSONRequestBody added in v2.7.0

type RetitleChangeSetJSONRequestBody = ChangeSetTitle

RetitleChangeSetJSONRequestBody defines body for RetitleChangeSet for application/json ContentType.

type RetitleChangeSetRequestObject added in v2.7.0

type RetitleChangeSetRequestObject struct {
	Set  ChangeSetParam `json:"set"`
	Body *RetitleChangeSetJSONRequestBody
}

type RetitleChangeSetResponseObject added in v2.7.0

type RetitleChangeSetResponseObject interface {
	VisitRetitleChangeSetResponse(w http.ResponseWriter) error
}

type RevokeAgentGrant204Response added in v2.5.0

type RevokeAgentGrant204Response struct {
}

func (RevokeAgentGrant204Response) VisitRevokeAgentGrantResponse added in v2.5.0

func (response RevokeAgentGrant204Response) VisitRevokeAgentGrantResponse(w http.ResponseWriter) error

type RevokeAgentGrant401JSONResponse added in v2.5.0

type RevokeAgentGrant401JSONResponse struct{ UnauthenticatedJSONResponse }

func (RevokeAgentGrant401JSONResponse) VisitRevokeAgentGrantResponse added in v2.5.0

func (response RevokeAgentGrant401JSONResponse) VisitRevokeAgentGrantResponse(w http.ResponseWriter) error

type RevokeAgentGrant403JSONResponse added in v2.5.0

type RevokeAgentGrant403JSONResponse struct{ ForbiddenJSONResponse }

func (RevokeAgentGrant403JSONResponse) VisitRevokeAgentGrantResponse added in v2.5.0

func (response RevokeAgentGrant403JSONResponse) VisitRevokeAgentGrantResponse(w http.ResponseWriter) error

type RevokeAgentGrant404JSONResponse added in v2.5.0

type RevokeAgentGrant404JSONResponse struct{ NotFoundJSONResponse }

func (RevokeAgentGrant404JSONResponse) VisitRevokeAgentGrantResponse added in v2.5.0

func (response RevokeAgentGrant404JSONResponse) VisitRevokeAgentGrantResponse(w http.ResponseWriter) error

type RevokeAgentGrantRequestObject added in v2.5.0

type RevokeAgentGrantRequestObject struct {
	Grant GrantParam `json:"grant"`
}

type RevokeAgentGrantResponseObject added in v2.5.0

type RevokeAgentGrantResponseObject interface {
	VisitRevokeAgentGrantResponse(w http.ResponseWriter) error
}

type Role added in v2.2.0

type Role string

Role A role on the access list (TAXONOMY.md D27). A reader sees everything and changes nothing; a contributor changes the work of their teams and the teams beneath them and keeps the shared registers; a strategy editor shapes the goals and the vision and mission; an administrator does everything, for every team, and manages access.

const (
	Administrator  Role = "administrator"
	Contributor    Role = "contributor"
	Reader         Role = "reader"
	StrategyEditor Role = "strategyEditor"
)

Defines values for Role.

func (Role) Valid added in v2.2.0

func (e Role) Valid() bool

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

type Route added in v2.9.0

type Route struct {
	// Key The stage of the order of work (GET /order).
	Key        string  `json:"key"`
	Kind       string  `json:"kind"`
	Level      *string `json:"level,omitempty"`
	Likelihood float32 `json:"likelihood"`
}

Route defines model for Route.

type ScheduleItem added in v2.9.0

type ScheduleItem struct {
	Critical bool              `json:"critical"`
	Form     *ScheduleItemForm `json:"form,omitempty"`
	Id       string            `json:"id"`
	Late     bool              `json:"late"`

	// Month The month it falls in as far as its timing says, YYYY-MM.
	Month     *string `json:"month,omitempty"`
	Name      string  `json:"name"`
	NotAfter  *string `json:"notAfter,omitempty"`
	NotBefore *string `json:"notBefore,omitempty"`
	Pending   bool    `json:"pending"`

	// Unplaced It follows something outside the project, or a loop, so no month can be worked out.
	Unplaced bool `json:"unplaced"`

	// WaitsOn The ids of the milestones it waits on.
	WaitsOn []string `json:"waitsOn"`
}

ScheduleItem defines model for ScheduleItem.

type ScheduleItemForm added in v2.9.0

type ScheduleItemForm string

ScheduleItemForm defines model for ScheduleItem.Form.

const (
	ScheduleItemFormAfter  ScheduleItemForm = "after"
	ScheduleItemFormDate   ScheduleItemForm = "date"
	ScheduleItemFormWhen   ScheduleItemForm = "when"
	ScheduleItemFormWindow ScheduleItemForm = "window"
)

Defines values for ScheduleItemForm.

func (ScheduleItemForm) Valid added in v2.9.0

func (e ScheduleItemForm) Valid() bool

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

type SemanticExport added in v2.10.0

type SemanticExport struct {
	Files []struct {
		Content string `json:"content"`
		Path    string `json:"path"`
	} `json:"files"`
	Format  string   `json:"format"`
	Formats []string `json:"formats"`
	Notes   []string `json:"notes"`
}

SemanticExport defines model for SemanticExport.

type SeriesAppend added in v2.3.0

type SeriesAppend struct {
	// Item The item, as the series' schema has it: for a reading, period and value, and provisional and note when they apply.
	Item   map[string]interface{} `json:"item"`
	Reason string                 `json:"reason"`
}

SeriesAppend defines model for SeriesAppend.

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 {
	// ListPeople The access list
	// (GET /access/people)
	ListPeople(w http.ResponseWriter, r *http.Request)
	// RemovePerson Take a person off the access list
	// (DELETE /access/people/{email})
	RemovePerson(w http.ResponseWriter, r *http.Request, email string)
	// GrantPerson List a person, or change what an administrator grants them
	// (PUT /access/people/{email})
	GrantPerson(w http.ResponseWriter, r *http.Request, email string)
	// ListAgentGrants The agents people let act for them (docs/adr/0016): the caller's own, or, for an administrator, one person's (person) or everyone's (person=*). Empty where no grants are kept, as when the deployment's own stack authorizes agents.
	// (GET /agents)
	ListAgentGrants(w http.ResponseWriter, r *http.Request, params ListAgentGrantsParams)
	// CreateAgentToken Lets an agent act for the caller by a token to paste into its client, for a client that cannot sign in through the browser. The token is shown once. Only where Cartograph is the authorization server for agents (CARTOGRAPH_MCP_AUTH=cartograph).
	// (POST /agents)
	CreateAgentToken(w http.ResponseWriter, r *http.Request)
	// GetAgentFeed The document a person's agents announce their steps on, to follow them (docs/adr/0018): what each read, drafted, checked and proposed, as presence (contract/schemas/presence.schema.json, agent). The caller's own, or, for an administrator, one person's. Only they may open it on the sync socket; nothing is stored.
	// (GET /agents/feed)
	GetAgentFeed(w http.ResponseWriter, r *http.Request, params GetAgentFeedParams)
	// RevokeAgentGrant Disconnects an agent at once: the caller's own, or anyone's for an administrator.
	// (DELETE /agents/{grant})
	RevokeAgentGrant(w http.ResponseWriter, r *http.Request, grant GrantParam)
	// ListChangeSets Change sets (docs/adr/0022): the caller's own and their agents', newest first; everyone's for an administrator who asks.
	// (GET /changesets)
	ListChangeSets(w http.ResponseWriter, r *http.Request, params ListChangeSetsParams)
	// StartChangeSet Open a change set for the caller to work in, apart from the record and the shared drafts.
	// (POST /changesets)
	StartChangeSet(w http.ResponseWriter, r *http.Request)
	// GetChangeSet A change set as its person reviews it: every item, what it changes against the version it started from, its checks with the rest of the change set, and whether the record has moved on since.
	// (GET /changesets/{set})
	GetChangeSet(w http.ResponseWriter, r *http.Request, set ChangeSetParam)
	// RetitleChangeSet Change what a change set says it is.
	// (PATCH /changesets/{set})
	RetitleChangeSet(w http.ResponseWriter, r *http.Request, set ChangeSetParam)
	// AcceptChangeSet Accept a proposed change set as the person it is for: every included item saved as a version, in one transaction. Trimmed items stay, and the change set is open again with them. Refused with 409 when a manifest in it has changed since it started.
	// (POST /changesets/{set}/accept)
	AcceptChangeSet(w http.ResponseWriter, r *http.Request, set ChangeSetParam)
	// CloseChangeSet End a change set without saving it.
	// (POST /changesets/{set}/close)
	CloseChangeSet(w http.ResponseWriter, r *http.Request, set ChangeSetParam)
	// MoveInChangeSet Make the change set move this project to another state when it is rolled in (docs/adr/0024): after its saves and deletes, checked as a direct state change is. A hand-off renders the charter then.
	// (PUT /changesets/{set}/items/Project/{id}/state)
	MoveInChangeSet(w http.ResponseWriter, r *http.Request, set ChangeSetParam, id IdParam)
	// DropChangeSetItem Take an item out of a change set altogether.
	// (DELETE /changesets/{set}/items/{kind}/{id})
	DropChangeSetItem(w http.ResponseWriter, r *http.Request, set ChangeSetParam, kind KindParam, id IdParam)
	// GetChangeSetItem A manifest as it stands in a change set, its draft there, else the record.
	// (GET /changesets/{set}/items/{kind}/{id})
	GetChangeSetItem(w http.ResponseWriter, r *http.Request, set ChangeSetParam, kind KindParam, id IdParam)
	// IncludeChangeSetItem Include an item in the change set's next acceptance, or trim it from it, keeping it as a draft for later.
	// (PATCH /changesets/{set}/items/{kind}/{id})
	IncludeChangeSetItem(w http.ResponseWriter, r *http.Request, set ChangeSetParam, kind KindParam, id IdParam)
	// PutChangeSetItem Keep a manifest's draft in a change set. With previous (the text the editor last had), only the fields that changed since are applied, so what someone else changed in other fields meanwhile is kept.
	// (PUT /changesets/{set}/items/{kind}/{id})
	PutChangeSetItem(w http.ResponseWriter, r *http.Request, set ChangeSetParam, kind KindParam, id IdParam)
	// GetChangeSetDocument A change set's live draft of a manifest, as an Automerge document id
	// (GET /changesets/{set}/items/{kind}/{id}/document)
	GetChangeSetDocument(w http.ResponseWriter, r *http.Request, set ChangeSetParam, kind KindParam, id IdParam)
	// RemoveInChangeSet Make the change set delete this record when it is rolled in (docs/adr/0024). The item starts from the record as it stands; rolling in deletes it after the change set's saves, refused then if something still references it. Dropping the item takes the delete back.
	// (PUT /changesets/{set}/items/{kind}/{id}/removal)
	RemoveInChangeSet(w http.ResponseWriter, r *http.Request, set ChangeSetParam, kind KindParam, id IdParam)
	// ProposeChangeSet Put a change set up for its person to accept: every included item is checked with the others, open checks refused unless each is left open with a reason.
	// (POST /changesets/{set}/propose)
	ProposeChangeSet(w http.ResponseWriter, r *http.Request, set ChangeSetParam)
	// ReopenChangeSet Take a proposed change set back to work, to ask for changes or to withdraw it.
	// (POST /changesets/{set}/reopen)
	ReopenChangeSet(w http.ResponseWriter, r *http.Request, set ChangeSetParam)
	// GetComponents Every project and programme, what each depends on, and what follows
	// (GET /components)
	GetComponents(w http.ResponseWriter, r *http.Request, params GetComponentsParams)
	// GetDecisionModel Whether a decision model is configured, and answering now
	// (GET /decision-model)
	GetDecisionModel(w http.ResponseWriter, r *http.Request)
	// 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)
	// FromIdea The sentence of a rough idea that answers each question a walk asks
	// (POST /from-idea)
	FromIdea(w http.ResponseWriter, r *http.Request)
	// GetGlossary Every word of the taxonomy, defined as a dictionary defines it, in the order of work
	// (GET /glossary)
	GetGlossary(w http.ResponseWriter, r *http.Request, params GetGlossaryParams)
	// GetGoalTree The goal tree, computed from every Goal manifest and the reference index
	// (GET /goals/tree)
	GetGoalTree(w http.ResponseWriter, r *http.Request, params GetGoalTreeParams)
	// GetGraph Every manifest and every reference between them, for the workspace graph
	// (GET /graph)
	GetGraph(w http.ResponseWriter, r *http.Request, params GetGraphParams)
	// GetGuide How to define a kind well, for one level, in one language: what it is, every step and field in order with right and wrong examples, the checks each answers and how to meet them, the links to make on other kinds, and the organisation's records to reuse for each reference and link. Agents read the same guide over MCP.
	// (GET /guides/{kind})
	GetGuide(w http.ResponseWriter, r *http.Request, kind KindParam, params GetGuideParams)
	// 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)
	// GetLineage A project's data lineage, placed for drawing
	// (POST /lineage)
	GetLineage(w http.ResponseWriter, r *http.Request, params GetLineageParams)
	// GetLinkCandidates What a link may join from one record, and why not the rest
	// (GET /links/{link}/candidates)
	GetLinkCandidates(w http.ResponseWriter, r *http.Request, link LinkKind, params GetLinkCandidatesParams)
	// 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, params GetGapChecksParams)
	// 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, params GetGoalChecksParams)
	// GetKPIControlChart A KPI's readings as a control chart, with its capability
	// (GET /manifests/KPI/{id}/control)
	GetKPIControlChart(w http.ResponseWriter, r *http.Request, id IdParam, params GetKPIControlChartParams)
	// 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, params GetOperationCharterHtmlParams)
	// 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, params GetOperationChecksParams)
	// GetPortfolioChecks Whether a portfolio can make the decisions a portfolio exists for: what it is prioritised against, what it holds, and whether each of those has a decision (TAXONOMY.md D32). Advisory only, in the programme's shape, because each is read from other manifests.
	// (GET /manifests/Portfolio/{id}/checks)
	GetPortfolioChecks(w http.ResponseWriter, r *http.Request, id IdParam, params GetPortfolioChecksParams)
	// 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, params GetProgrammeCharterHtmlParams)
	// 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, params GetProgrammeChecksParams)
	// 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, params GetProjectChecksParams)
	// GetProjectDMAIC Whether a project can be taken through DMAIC, phase by phase
	// (GET /manifests/Project/{id}/dmaic)
	GetProjectDMAIC(w http.ResponseWriter, r *http.Request, id IdParam, params GetProjectDMAICParams)
	// GetProjectSchedule A project's milestones placed on time
	// (GET /manifests/Project/{id}/schedule)
	GetProjectSchedule(w http.ResponseWriter, r *http.Request, id IdParam, params GetProjectScheduleParams)
	// 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)
	// GetCyclePeriods A reporting cycle's periods that overlap two months, derived from the cycle and never stored (TAXONOMY.md D8, D40): equal periods from its start month, or its named periods (terms each year, survey waves once). Each is keyed by the month it ends, which is what a reading is filed under, with its label and the day its reading is due. Derived in one place so every interface lays out a KPI's readings the same way.
	// (GET /manifests/ReportingCycle/{id}/periods)
	GetCyclePeriods(w http.ResponseWriter, r *http.Request, id IdParam, params GetCyclePeriodsParams)
	// 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, params GetManifestParams)
	// 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)
	// GetSharedDocument The shared draft of a manifest, as an Automerge document id
	// (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)
	// AppendSeriesItem Record one item of a series (an array the kind's schema marks x-cartograph-series, such as a KPI's readings) and commit the manifest with it: a new key is added in key order, an existing key's item is replaced, which is how a provisional reading is restated. The item is the only thing sent, so recording costs the same however long the series is. Builds on the latest committed version, never on a working copy, and validates the whole manifest as a save does.
	// (POST /manifests/{kind}/{id}/series/{series})
	AppendSeriesItem(w http.ResponseWriter, r *http.Request, kind KindParam, id IdParam, series string)
	// 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)
	// MatchExisting The existing records of a kind that say what a text says
	// (POST /match)
	MatchExisting(w http.ResponseWriter, r *http.Request)
	// GetOrder The order of work, and how far the workspace has got along it
	// (GET /order)
	GetOrder(w http.ResponseWriter, r *http.Request, params GetOrderParams)
	// GetPresenceDocument The document that carries presence, for a record or for every other screen
	// (GET /presence)
	GetPresenceDocument(w http.ResponseWriter, r *http.Request, params GetPresenceDocumentParams)
	// ListProposals What agents have proposed (docs/adr/0016). An agent reads and edits drafts, and proposes what makes the record (a version, a reading, a state change); the person it acts for accepts or declines. By default, the open proposals made for the caller; with kind and id, every proposal on that manifest, for everyone who may read it.
	// (GET /proposals)
	ListProposals(w http.ResponseWriter, r *http.Request, params ListProposalsParams)
	// GetProposal One proposal as its person reviews it: what it would change against the manifest's latest version, field by field, and the checks on what it proposes. Read by whoever may read its manifest.
	// (GET /proposals/{proposal})
	GetProposal(w http.ResponseWriter, r *http.Request, proposal ProposalParam)
	// AcceptProposal Accept a proposal and make the record as the caller: commit its manifest, record its reading, or move its project. Only the person the proposal was made for may accept it, never an agent. Refused with 409 when the manifest has changed since the agent proposed, so the person reviews it again.
	// (POST /proposals/{proposal}/accept)
	AcceptProposal(w http.ResponseWriter, r *http.Request, proposal ProposalParam)
	// DeclineProposal Decline a proposal. Only the person it was made for may.
	// (POST /proposals/{proposal}/decline)
	DeclineProposal(w http.ResponseWriter, r *http.Request, proposal ProposalParam)
	// Relevant What in the workspace is relevant to a piece of work
	// (POST /relevant)
	Relevant(w http.ResponseWriter, r *http.Request)
	// GetReport A report over the current record, answered by the deployment's reporter (docs/adr/0014): projects (with team, state and the goals they serve), kpi-readings (every reading in force, with who recorded it and when), alignment (what serves each goal) and teams (each team with every team above it). Every reporter gives the same columns and rows. 404 when the deployment turned reporting off. Every listed person reads every report.
	// (GET /reports/{name})
	GetReport(w http.ResponseWriter, r *http.Request, name GetReportParamsName, params GetReportParams)
	// GetSchema The JSON Schema document for a kind
	// (GET /schemas/{kind})
	GetSchema(w http.ResponseWriter, r *http.Request, kind KindParam)
	// ExportSemanticLayer The KPIs as a semantic layer, in a tool's syntax
	// (GET /semantic-layer)
	ExportSemanticLayer(w http.ResponseWriter, r *http.Request, params ExportSemanticLayerParams)
	// 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)
	// StructureQuestions The questions that decide what each piece of work is
	// (GET /structure)
	StructureQuestions(w http.ResponseWriter, r *http.Request)
	// ClassifyStructure What each piece of work is, where it goes, and the order to write it in
	// (POST /structure)
	ClassifyStructure(w http.ResponseWriter, r *http.Request)
	// Sync The sync socket (automerge-repo network protocol, version 1)
	// (GET /sync)
	Sync(w http.ResponseWriter, r *http.Request)
	// Understand Which existing record says what a text a person typed says, and which flows may define it
	// (POST /understand)
	Understand(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) AcceptChangeSet added in v2.7.0

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

AcceptChangeSet operation middleware

func (*ServerInterfaceWrapper) AcceptProposal added in v2.5.0

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

AcceptProposal operation middleware

func (*ServerInterfaceWrapper) AppendSeriesItem added in v2.3.0

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

AppendSeriesItem operation middleware

func (*ServerInterfaceWrapper) ApplyRef

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

ApplyRef operation middleware

func (*ServerInterfaceWrapper) ClassifyStructure added in v2.10.0

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

ClassifyStructure operation middleware

func (*ServerInterfaceWrapper) CloseChangeSet added in v2.7.0

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

CloseChangeSet operation middleware

func (*ServerInterfaceWrapper) CreateAgentToken added in v2.5.0

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

CreateAgentToken operation middleware

func (*ServerInterfaceWrapper) DeclineProposal added in v2.5.0

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

DeclineProposal 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) DropChangeSetItem added in v2.7.0

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

DropChangeSetItem operation middleware

func (*ServerInterfaceWrapper) ExportSemanticLayer added in v2.10.0

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

ExportSemanticLayer operation middleware

func (*ServerInterfaceWrapper) FromIdea added in v2.9.0

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

FromIdea operation middleware

func (*ServerInterfaceWrapper) GetAgentFeed added in v2.6.0

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

GetAgentFeed operation middleware

func (*ServerInterfaceWrapper) GetChangeSet added in v2.7.0

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

GetChangeSet operation middleware

func (*ServerInterfaceWrapper) GetChangeSetDocument added in v2.9.0

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

GetChangeSetDocument operation middleware

func (*ServerInterfaceWrapper) GetChangeSetItem added in v2.7.0

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

GetChangeSetItem operation middleware

func (*ServerInterfaceWrapper) GetCharterPdf

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

GetCharterPdf operation middleware

func (*ServerInterfaceWrapper) GetComponents added in v2.9.0

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

GetComponents operation middleware

func (*ServerInterfaceWrapper) GetCyclePeriods added in v2.9.0

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

GetCyclePeriods operation middleware

func (*ServerInterfaceWrapper) GetDecisionModel added in v2.9.0

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

GetDecisionModel operation middleware

func (*ServerInterfaceWrapper) GetFlow

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) GetGlossary added in v2.7.0

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

GetGlossary 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) GetGraph added in v2.7.0

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

GetGraph operation middleware

func (*ServerInterfaceWrapper) GetGuide added in v2.6.0

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

GetGuide operation middleware

func (*ServerInterfaceWrapper) GetHealth

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

GetHealth operation middleware

func (*ServerInterfaceWrapper) GetKPIControlChart added in v2.10.0

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

GetKPIControlChart operation middleware

func (*ServerInterfaceWrapper) GetLineage added in v2.10.0

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

GetLineage operation middleware

func (*ServerInterfaceWrapper) GetLinkCandidates added in v2.9.0

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

GetLinkCandidates 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) GetOrder added in v2.7.0

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

GetOrder operation middleware

func (*ServerInterfaceWrapper) GetPortfolioChecks added in v2.9.0

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

GetPortfolioChecks 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) GetProjectDMAIC added in v2.10.0

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

GetProjectDMAIC operation middleware

func (*ServerInterfaceWrapper) GetProjectSchedule added in v2.9.0

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

GetProjectSchedule operation middleware

func (*ServerInterfaceWrapper) GetProjectState

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

GetProjectState operation middleware

func (*ServerInterfaceWrapper) GetProposal added in v2.6.0

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

GetProposal operation middleware

func (*ServerInterfaceWrapper) GetReferences

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

GetReferences operation middleware

func (*ServerInterfaceWrapper) GetReport added in v2.3.0

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

GetReport 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) GrantPerson added in v2.2.0

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

GrantPerson operation middleware

func (*ServerInterfaceWrapper) IncludeChangeSetItem added in v2.7.0

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

IncludeChangeSetItem operation middleware

func (*ServerInterfaceWrapper) ListAgentGrants added in v2.5.0

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

ListAgentGrants operation middleware

func (*ServerInterfaceWrapper) ListChangeSets added in v2.7.0

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

ListChangeSets 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) ListPeople added in v2.2.0

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

ListPeople operation middleware

func (*ServerInterfaceWrapper) ListProposals added in v2.5.0

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

ListProposals 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) MatchExisting added in v2.9.0

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

MatchExisting operation middleware

func (*ServerInterfaceWrapper) MoveInChangeSet added in v2.9.0

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

MoveInChangeSet operation middleware

func (*ServerInterfaceWrapper) PostSnapshot

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

PostSnapshot operation middleware

func (*ServerInterfaceWrapper) ProposeChangeSet added in v2.7.0

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

ProposeChangeSet operation middleware

func (*ServerInterfaceWrapper) PutChangeSetItem added in v2.7.0

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

PutChangeSetItem 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) Relevant added in v2.9.0

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

Relevant operation middleware

func (*ServerInterfaceWrapper) RemoveInChangeSet added in v2.9.0

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

RemoveInChangeSet operation middleware

func (*ServerInterfaceWrapper) RemovePerson added in v2.2.0

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

RemovePerson operation middleware

func (*ServerInterfaceWrapper) ReopenChangeSet added in v2.7.0

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

ReopenChangeSet operation middleware

func (*ServerInterfaceWrapper) RetitleChangeSet added in v2.7.0

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

RetitleChangeSet operation middleware

func (*ServerInterfaceWrapper) RevokeAgentGrant added in v2.5.0

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

RevokeAgentGrant operation middleware

func (*ServerInterfaceWrapper) StartChangeSet added in v2.7.0

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

StartChangeSet operation middleware

func (*ServerInterfaceWrapper) StructureQuestions added in v2.10.0

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

StructureQuestions operation middleware

func (*ServerInterfaceWrapper) Sync

Sync operation middleware

func (*ServerInterfaceWrapper) TransitionProjectState

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

TransitionProjectState operation middleware

func (*ServerInterfaceWrapper) Understand added in v2.9.0

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

Understand operation middleware

func (*ServerInterfaceWrapper) ValidateManifest

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

ValidateManifest operation middleware

type Session

type Session struct {
	// Access What the access list gives the principal (docs/adr/0011), present when the deployment keeps one. An interface offers editing from it; the engine decides again on every write.
	Access *SessionAccess `json:"access,omitempty"`

	// Actor The principal as the engine records it on versions and state.
	Actor string `json:"actor"`

	// Agents Whether agents may act for this principal here: the deployment serves MCP and, with an access list, the principal's roles allow one. An interface shows Proposals when it is true.
	Agents *bool `json:"agents,omitempty"`

	// CanWrite Whether the authorizer allows this principal to write.
	CanWrite bool `json:"canWrite"`

	// Email The organisation address, where the authenticator has one.
	Email *string `json:"email,omitempty"`

	// Name A display name, where the authenticator has one; otherwise absent.
	Name *string `json:"name,omitempty"`
}

Session defines model for Session.

type SessionAccess added in v2.2.0

type SessionAccess struct {
	// Agents Whether the principal may act through an agent over MCP (docs/adr/0016): their roles allow it and an administrator has not turned theirs off.
	Agents *bool `json:"agents,omitempty"`

	// Listed Whether the principal is on the access list. Someone who is not may sign in to the proxy but sees nothing.
	Listed bool `json:"listed"`

	// Reach The principal's teams and every team beneath them, by id: whose projects, programmes, operations and data sources they may change where their scope for the kind is teams.
	Reach []string `json:"reach"`
	Roles []Role   `json:"roles"`

	// Scopes For each kind, how much of it the principal may write.
	Scopes map[string]SessionAccessScopes `json:"scopes"`

	// Teams The teams the principal acts for, by id.
	Teams []string `json:"teams"`
}

SessionAccess What the access list gives the principal (docs/adr/0011), present when the deployment keeps one. An interface offers editing from it; the engine decides again on every write.

type SessionAccessScopes added in v2.2.0

type SessionAccessScopes string

SessionAccessScopes defines model for SessionAccess.Scopes.

const (
	SessionAccessScopesAll   SessionAccessScopes = "all"
	SessionAccessScopesNone  SessionAccessScopes = "none"
	SessionAccessScopesTeams SessionAccessScopes = "teams"
)

Defines values for SessionAccessScopes.

func (SessionAccessScopes) Valid added in v2.2.0

func (e SessionAccessScopes) Valid() bool

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

type Settings

type Settings struct {
	// ChangeControl How the record may change (docs/adr/0024). Absent or false, every write path works as before.
	ChangeControl *ChangeControl `json:"changeControl,omitempty"`

	// 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), and the organisation's name (D37).
	Purpose *struct {
		// Logo The organisation's logo as a data URL (TAXONOMY.md D37).
		Logo         *string `json:"logo,omitempty"`
		Mission      *string `json:"mission,omitempty"`
		Organisation *string `json:"organisation,omitempty"`
		Source       *string `json:"source,omitempty"`
		Vision       *string `json:"vision,omitempty"`
	} `json:"purpose,omitempty"`
}

Settings defines model for Settings.

type SharedDocument

type SharedDocument struct {
	// DocumentId The automerge-repo document id (base58check).
	DocumentId string `json:"documentId"`

	// Url The same id as an automerge URL, `automerge:<documentId>`.
	Url string `json:"url"`
}

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 StartChangeSet200JSONResponse added in v2.7.0

type StartChangeSet200JSONResponse ChangeSet

func (StartChangeSet200JSONResponse) VisitStartChangeSetResponse added in v2.7.0

func (response StartChangeSet200JSONResponse) VisitStartChangeSetResponse(w http.ResponseWriter) error

type StartChangeSet401JSONResponse added in v2.7.0

type StartChangeSet401JSONResponse struct{ UnauthenticatedJSONResponse }

func (StartChangeSet401JSONResponse) VisitStartChangeSetResponse added in v2.7.0

func (response StartChangeSet401JSONResponse) VisitStartChangeSetResponse(w http.ResponseWriter) error

type StartChangeSet403JSONResponse added in v2.7.0

type StartChangeSet403JSONResponse struct{ ForbiddenJSONResponse }

func (StartChangeSet403JSONResponse) VisitStartChangeSetResponse added in v2.7.0

func (response StartChangeSet403JSONResponse) VisitStartChangeSetResponse(w http.ResponseWriter) error

type StartChangeSetJSONRequestBody added in v2.7.0

type StartChangeSetJSONRequestBody = ChangeSetTitle

StartChangeSetJSONRequestBody defines body for StartChangeSet for application/json ContentType.

type StartChangeSetRequestObject added in v2.7.0

type StartChangeSetRequestObject struct {
	Body *StartChangeSetJSONRequestBody
}

type StartChangeSetResponseObject added in v2.7.0

type StartChangeSetResponseObject interface {
	VisitStartChangeSetResponse(w http.ResponseWriter) error
}

type StdHTTPServerOptions

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

type StrictHTTPServerOptions

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

type StrictHandlerFunc

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

type StrictMiddlewareFunc

type StrictMiddlewareFunc func(f StrictHandlerFunc, operationID string) StrictHandlerFunc

type StrictServerInterface

type StrictServerInterface interface {
	// ListPeople The access list
	// (GET /access/people)
	ListPeople(ctx context.Context, request ListPeopleRequestObject) (ListPeopleResponseObject, error)
	// RemovePerson Take a person off the access list
	// (DELETE /access/people/{email})
	RemovePerson(ctx context.Context, request RemovePersonRequestObject) (RemovePersonResponseObject, error)
	// GrantPerson List a person, or change what an administrator grants them
	// (PUT /access/people/{email})
	GrantPerson(ctx context.Context, request GrantPersonRequestObject) (GrantPersonResponseObject, error)
	// ListAgentGrants The agents people let act for them (docs/adr/0016): the caller's own, or, for an administrator, one person's (person) or everyone's (person=*). Empty where no grants are kept, as when the deployment's own stack authorizes agents.
	// (GET /agents)
	ListAgentGrants(ctx context.Context, request ListAgentGrantsRequestObject) (ListAgentGrantsResponseObject, error)
	// CreateAgentToken Lets an agent act for the caller by a token to paste into its client, for a client that cannot sign in through the browser. The token is shown once. Only where Cartograph is the authorization server for agents (CARTOGRAPH_MCP_AUTH=cartograph).
	// (POST /agents)
	CreateAgentToken(ctx context.Context, request CreateAgentTokenRequestObject) (CreateAgentTokenResponseObject, error)
	// GetAgentFeed The document a person's agents announce their steps on, to follow them (docs/adr/0018): what each read, drafted, checked and proposed, as presence (contract/schemas/presence.schema.json, agent). The caller's own, or, for an administrator, one person's. Only they may open it on the sync socket; nothing is stored.
	// (GET /agents/feed)
	GetAgentFeed(ctx context.Context, request GetAgentFeedRequestObject) (GetAgentFeedResponseObject, error)
	// RevokeAgentGrant Disconnects an agent at once: the caller's own, or anyone's for an administrator.
	// (DELETE /agents/{grant})
	RevokeAgentGrant(ctx context.Context, request RevokeAgentGrantRequestObject) (RevokeAgentGrantResponseObject, error)
	// ListChangeSets Change sets (docs/adr/0022): the caller's own and their agents', newest first; everyone's for an administrator who asks.
	// (GET /changesets)
	ListChangeSets(ctx context.Context, request ListChangeSetsRequestObject) (ListChangeSetsResponseObject, error)
	// StartChangeSet Open a change set for the caller to work in, apart from the record and the shared drafts.
	// (POST /changesets)
	StartChangeSet(ctx context.Context, request StartChangeSetRequestObject) (StartChangeSetResponseObject, error)
	// GetChangeSet A change set as its person reviews it: every item, what it changes against the version it started from, its checks with the rest of the change set, and whether the record has moved on since.
	// (GET /changesets/{set})
	GetChangeSet(ctx context.Context, request GetChangeSetRequestObject) (GetChangeSetResponseObject, error)
	// RetitleChangeSet Change what a change set says it is.
	// (PATCH /changesets/{set})
	RetitleChangeSet(ctx context.Context, request RetitleChangeSetRequestObject) (RetitleChangeSetResponseObject, error)
	// AcceptChangeSet Accept a proposed change set as the person it is for: every included item saved as a version, in one transaction. Trimmed items stay, and the change set is open again with them. Refused with 409 when a manifest in it has changed since it started.
	// (POST /changesets/{set}/accept)
	AcceptChangeSet(ctx context.Context, request AcceptChangeSetRequestObject) (AcceptChangeSetResponseObject, error)
	// CloseChangeSet End a change set without saving it.
	// (POST /changesets/{set}/close)
	CloseChangeSet(ctx context.Context, request CloseChangeSetRequestObject) (CloseChangeSetResponseObject, error)
	// MoveInChangeSet Make the change set move this project to another state when it is rolled in (docs/adr/0024): after its saves and deletes, checked as a direct state change is. A hand-off renders the charter then.
	// (PUT /changesets/{set}/items/Project/{id}/state)
	MoveInChangeSet(ctx context.Context, request MoveInChangeSetRequestObject) (MoveInChangeSetResponseObject, error)
	// DropChangeSetItem Take an item out of a change set altogether.
	// (DELETE /changesets/{set}/items/{kind}/{id})
	DropChangeSetItem(ctx context.Context, request DropChangeSetItemRequestObject) (DropChangeSetItemResponseObject, error)
	// GetChangeSetItem A manifest as it stands in a change set, its draft there, else the record.
	// (GET /changesets/{set}/items/{kind}/{id})
	GetChangeSetItem(ctx context.Context, request GetChangeSetItemRequestObject) (GetChangeSetItemResponseObject, error)
	// IncludeChangeSetItem Include an item in the change set's next acceptance, or trim it from it, keeping it as a draft for later.
	// (PATCH /changesets/{set}/items/{kind}/{id})
	IncludeChangeSetItem(ctx context.Context, request IncludeChangeSetItemRequestObject) (IncludeChangeSetItemResponseObject, error)
	// PutChangeSetItem Keep a manifest's draft in a change set. With previous (the text the editor last had), only the fields that changed since are applied, so what someone else changed in other fields meanwhile is kept.
	// (PUT /changesets/{set}/items/{kind}/{id})
	PutChangeSetItem(ctx context.Context, request PutChangeSetItemRequestObject) (PutChangeSetItemResponseObject, error)
	// GetChangeSetDocument A change set's live draft of a manifest, as an Automerge document id
	// (GET /changesets/{set}/items/{kind}/{id}/document)
	GetChangeSetDocument(ctx context.Context, request GetChangeSetDocumentRequestObject) (GetChangeSetDocumentResponseObject, error)
	// RemoveInChangeSet Make the change set delete this record when it is rolled in (docs/adr/0024). The item starts from the record as it stands; rolling in deletes it after the change set's saves, refused then if something still references it. Dropping the item takes the delete back.
	// (PUT /changesets/{set}/items/{kind}/{id}/removal)
	RemoveInChangeSet(ctx context.Context, request RemoveInChangeSetRequestObject) (RemoveInChangeSetResponseObject, error)
	// ProposeChangeSet Put a change set up for its person to accept: every included item is checked with the others, open checks refused unless each is left open with a reason.
	// (POST /changesets/{set}/propose)
	ProposeChangeSet(ctx context.Context, request ProposeChangeSetRequestObject) (ProposeChangeSetResponseObject, error)
	// ReopenChangeSet Take a proposed change set back to work, to ask for changes or to withdraw it.
	// (POST /changesets/{set}/reopen)
	ReopenChangeSet(ctx context.Context, request ReopenChangeSetRequestObject) (ReopenChangeSetResponseObject, error)
	// GetComponents Every project and programme, what each depends on, and what follows
	// (GET /components)
	GetComponents(ctx context.Context, request GetComponentsRequestObject) (GetComponentsResponseObject, error)
	// GetDecisionModel Whether a decision model is configured, and answering now
	// (GET /decision-model)
	GetDecisionModel(ctx context.Context, request GetDecisionModelRequestObject) (GetDecisionModelResponseObject, error)
	// 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)
	// FromIdea The sentence of a rough idea that answers each question a walk asks
	// (POST /from-idea)
	FromIdea(ctx context.Context, request FromIdeaRequestObject) (FromIdeaResponseObject, error)
	// GetGlossary Every word of the taxonomy, defined as a dictionary defines it, in the order of work
	// (GET /glossary)
	GetGlossary(ctx context.Context, request GetGlossaryRequestObject) (GetGlossaryResponseObject, 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)
	// GetGraph Every manifest and every reference between them, for the workspace graph
	// (GET /graph)
	GetGraph(ctx context.Context, request GetGraphRequestObject) (GetGraphResponseObject, error)
	// GetGuide How to define a kind well, for one level, in one language: what it is, every step and field in order with right and wrong examples, the checks each answers and how to meet them, the links to make on other kinds, and the organisation's records to reuse for each reference and link. Agents read the same guide over MCP.
	// (GET /guides/{kind})
	GetGuide(ctx context.Context, request GetGuideRequestObject) (GetGuideResponseObject, 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)
	// GetLineage A project's data lineage, placed for drawing
	// (POST /lineage)
	GetLineage(ctx context.Context, request GetLineageRequestObject) (GetLineageResponseObject, error)
	// GetLinkCandidates What a link may join from one record, and why not the rest
	// (GET /links/{link}/candidates)
	GetLinkCandidates(ctx context.Context, request GetLinkCandidatesRequestObject) (GetLinkCandidatesResponseObject, 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)
	// GetKPIControlChart A KPI's readings as a control chart, with its capability
	// (GET /manifests/KPI/{id}/control)
	GetKPIControlChart(ctx context.Context, request GetKPIControlChartRequestObject) (GetKPIControlChartResponseObject, 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)
	// GetPortfolioChecks Whether a portfolio can make the decisions a portfolio exists for: what it is prioritised against, what it holds, and whether each of those has a decision (TAXONOMY.md D32). Advisory only, in the programme's shape, because each is read from other manifests.
	// (GET /manifests/Portfolio/{id}/checks)
	GetPortfolioChecks(ctx context.Context, request GetPortfolioChecksRequestObject) (GetPortfolioChecksResponseObject, 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)
	// GetProjectDMAIC Whether a project can be taken through DMAIC, phase by phase
	// (GET /manifests/Project/{id}/dmaic)
	GetProjectDMAIC(ctx context.Context, request GetProjectDMAICRequestObject) (GetProjectDMAICResponseObject, error)
	// GetProjectSchedule A project's milestones placed on time
	// (GET /manifests/Project/{id}/schedule)
	GetProjectSchedule(ctx context.Context, request GetProjectScheduleRequestObject) (GetProjectScheduleResponseObject, 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)
	// GetCyclePeriods A reporting cycle's periods that overlap two months, derived from the cycle and never stored (TAXONOMY.md D8, D40): equal periods from its start month, or its named periods (terms each year, survey waves once). Each is keyed by the month it ends, which is what a reading is filed under, with its label and the day its reading is due. Derived in one place so every interface lays out a KPI's readings the same way.
	// (GET /manifests/ReportingCycle/{id}/periods)
	GetCyclePeriods(ctx context.Context, request GetCyclePeriodsRequestObject) (GetCyclePeriodsResponseObject, 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)
	// GetSharedDocument The shared draft of a manifest, as an Automerge document id
	// (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)
	// AppendSeriesItem Record one item of a series (an array the kind's schema marks x-cartograph-series, such as a KPI's readings) and commit the manifest with it: a new key is added in key order, an existing key's item is replaced, which is how a provisional reading is restated. The item is the only thing sent, so recording costs the same however long the series is. Builds on the latest committed version, never on a working copy, and validates the whole manifest as a save does.
	// (POST /manifests/{kind}/{id}/series/{series})
	AppendSeriesItem(ctx context.Context, request AppendSeriesItemRequestObject) (AppendSeriesItemResponseObject, 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)
	// MatchExisting The existing records of a kind that say what a text says
	// (POST /match)
	MatchExisting(ctx context.Context, request MatchExistingRequestObject) (MatchExistingResponseObject, error)
	// GetOrder The order of work, and how far the workspace has got along it
	// (GET /order)
	GetOrder(ctx context.Context, request GetOrderRequestObject) (GetOrderResponseObject, error)
	// GetPresenceDocument The document that carries presence, for a record or for every other screen
	// (GET /presence)
	GetPresenceDocument(ctx context.Context, request GetPresenceDocumentRequestObject) (GetPresenceDocumentResponseObject, error)
	// ListProposals What agents have proposed (docs/adr/0016). An agent reads and edits drafts, and proposes what makes the record (a version, a reading, a state change); the person it acts for accepts or declines. By default, the open proposals made for the caller; with kind and id, every proposal on that manifest, for everyone who may read it.
	// (GET /proposals)
	ListProposals(ctx context.Context, request ListProposalsRequestObject) (ListProposalsResponseObject, error)
	// GetProposal One proposal as its person reviews it: what it would change against the manifest's latest version, field by field, and the checks on what it proposes. Read by whoever may read its manifest.
	// (GET /proposals/{proposal})
	GetProposal(ctx context.Context, request GetProposalRequestObject) (GetProposalResponseObject, error)
	// AcceptProposal Accept a proposal and make the record as the caller: commit its manifest, record its reading, or move its project. Only the person the proposal was made for may accept it, never an agent. Refused with 409 when the manifest has changed since the agent proposed, so the person reviews it again.
	// (POST /proposals/{proposal}/accept)
	AcceptProposal(ctx context.Context, request AcceptProposalRequestObject) (AcceptProposalResponseObject, error)
	// DeclineProposal Decline a proposal. Only the person it was made for may.
	// (POST /proposals/{proposal}/decline)
	DeclineProposal(ctx context.Context, request DeclineProposalRequestObject) (DeclineProposalResponseObject, error)
	// Relevant What in the workspace is relevant to a piece of work
	// (POST /relevant)
	Relevant(ctx context.Context, request RelevantRequestObject) (RelevantResponseObject, error)
	// GetReport A report over the current record, answered by the deployment's reporter (docs/adr/0014): projects (with team, state and the goals they serve), kpi-readings (every reading in force, with who recorded it and when), alignment (what serves each goal) and teams (each team with every team above it). Every reporter gives the same columns and rows. 404 when the deployment turned reporting off. Every listed person reads every report.
	// (GET /reports/{name})
	GetReport(ctx context.Context, request GetReportRequestObject) (GetReportResponseObject, error)
	// GetSchema The JSON Schema document for a kind
	// (GET /schemas/{kind})
	GetSchema(ctx context.Context, request GetSchemaRequestObject) (GetSchemaResponseObject, error)
	// ExportSemanticLayer The KPIs as a semantic layer, in a tool's syntax
	// (GET /semantic-layer)
	ExportSemanticLayer(ctx context.Context, request ExportSemanticLayerRequestObject) (ExportSemanticLayerResponseObject, 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)
	// StructureQuestions The questions that decide what each piece of work is
	// (GET /structure)
	StructureQuestions(ctx context.Context, request StructureQuestionsRequestObject) (StructureQuestionsResponseObject, error)
	// ClassifyStructure What each piece of work is, where it goes, and the order to write it in
	// (POST /structure)
	ClassifyStructure(ctx context.Context, request ClassifyStructureRequestObject) (ClassifyStructureResponseObject, error)
	// Sync The sync socket (automerge-repo network protocol, version 1)
	// (GET /sync)
	Sync(ctx context.Context, request SyncRequestObject) (SyncResponseObject, error)
	// Understand Which existing record says what a text a person typed says, and which flows may define it
	// (POST /understand)
	Understand(ctx context.Context, request UnderstandRequestObject) (UnderstandResponseObject, 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 Structure added in v2.10.0

type Structure struct {
	Next     string            `json:"next"`
	Order    []string          `json:"order"`
	Pieces   []StructuredPiece `json:"pieces"`
	Problems *[]string         `json:"problems,omitempty"`

	// Work Every record to write, as Kind/id, in the order to write them.
	Work *[]string `json:"work,omitempty"`
}

Structure defines model for Structure.

type StructurePiece added in v2.10.0

type StructurePiece struct {
	// Change For a change of its own, what it changes that the work depending on it needs; required with changeOfItsOwn.
	Change              *string   `json:"change,omitempty"`
	ChangeOfItsOwn      *bool     `json:"changeOfItsOwn,omitempty"`
	CoordinatesProjects *bool     `json:"coordinatesProjects,omitempty"`
	DependedOnBy        *[]string `json:"dependedOnBy,omitempty"`
	GroupsForFunding    *bool     `json:"groupsForFunding,omitempty"`
	Name                string    `json:"name"`

	// None Every question was asked and none is yes. A piece says it, or answers; among several, a piece with neither is a problem.
	None       *bool   `json:"none,omitempty"`
	Ongoing    *bool   `json:"ongoing,omitempty"`
	OutOfScope *bool   `json:"outOfScope,omitempty"`
	OutputOf   *string `json:"outputOf,omitempty"`
	Policy     *bool   `json:"policy,omitempty"`
	RunsToday  *bool   `json:"runsToday,omitempty"`
}

StructurePiece defines model for StructurePiece.

type StructureQuestion added in v2.10.0

type StructureQuestion struct {
	// Field The answer this question sets on a StructurePiece; empty for the last, which applies when none does.
	Field    string `json:"field"`
	Question string `json:"question"`
	Then     string `json:"then"`
}

StructureQuestion defines model for StructureQuestion.

type StructureQuestions200JSONResponse added in v2.10.0

type StructureQuestions200JSONResponse struct {
	Questions []StructureQuestion `json:"questions"`
}

func (StructureQuestions200JSONResponse) VisitStructureQuestionsResponse added in v2.10.0

func (response StructureQuestions200JSONResponse) VisitStructureQuestionsResponse(w http.ResponseWriter) error

type StructureQuestions401JSONResponse added in v2.10.0

type StructureQuestions401JSONResponse struct{ UnauthenticatedJSONResponse }

func (StructureQuestions401JSONResponse) VisitStructureQuestionsResponse added in v2.10.0

func (response StructureQuestions401JSONResponse) VisitStructureQuestionsResponse(w http.ResponseWriter) error

type StructureQuestionsRequestObject added in v2.10.0

type StructureQuestionsRequestObject struct {
}

type StructureQuestionsResponseObject added in v2.10.0

type StructureQuestionsResponseObject interface {
	VisitStructureQuestionsResponse(w http.ResponseWriter) error
}

type StructuredPiece added in v2.10.0

type StructuredPiece struct {
	// Kind Goal, Operation, Portfolio, Programme, Project, Deliverable or ScopeOut.
	Kind string    `json:"kind"`
	Name string    `json:"name"`
	Of   *[]string `json:"of,omitempty"`

	// Record Kind/id, with a generated id, for a piece that is a record of its own.
	Record *string `json:"record,omitempty"`
	Where  string  `json:"where"`
}

StructuredPiece defines model for StructuredPiece.

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"`

	// Proposed Present when read with changeSet and the change set creates this record (new) or changes it (changed); absent otherwise.
	Proposed *Proposed `json:"proposed,omitempty"`

	// 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

type TooManyValuesForParamError struct {
	ParamName string
	Count     int
}

func (*TooManyValuesForParamError) Error

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 TransitionProjectState409JSONResponse added in v2.9.0

type TransitionProjectState409JSONResponse struct{ ChangeSetRequiredJSONResponse }

func (TransitionProjectState409JSONResponse) VisitTransitionProjectStateResponse added in v2.9.0

func (response TransitionProjectState409JSONResponse) 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 Understand200JSONResponse added in v2.9.0

type Understand200JSONResponse Understanding

func (Understand200JSONResponse) VisitUnderstandResponse added in v2.9.0

func (response Understand200JSONResponse) VisitUnderstandResponse(w http.ResponseWriter) error

type Understand401JSONResponse added in v2.9.0

type Understand401JSONResponse struct{ UnauthenticatedJSONResponse }

func (Understand401JSONResponse) VisitUnderstandResponse added in v2.9.0

func (response Understand401JSONResponse) VisitUnderstandResponse(w http.ResponseWriter) error

type Understand403JSONResponse added in v2.9.0

type Understand403JSONResponse struct{ ForbiddenJSONResponse }

func (Understand403JSONResponse) VisitUnderstandResponse added in v2.9.0

func (response Understand403JSONResponse) VisitUnderstandResponse(w http.ResponseWriter) error

type UnderstandJSONBody added in v2.9.0

type UnderstandJSONBody struct {
	Locale *string `json:"locale,omitempty"`
	Text   string  `json:"text"`
}

UnderstandJSONBody defines parameters for Understand.

type UnderstandJSONRequestBody added in v2.9.0

type UnderstandJSONRequestBody UnderstandJSONBody

UnderstandJSONRequestBody defines body for Understand for application/json ContentType.

type UnderstandRequestObject added in v2.9.0

type UnderstandRequestObject struct {
	Body *UnderstandJSONRequestBody
}

type UnderstandResponseObject added in v2.9.0

type UnderstandResponseObject interface {
	VisitUnderstandResponse(w http.ResponseWriter) error
}

type Understanding added in v2.9.0

type Understanding struct {
	// Available False when no decision model answered; matches are then by the words they share, and there are no routes.
	Available bool    `json:"available"`
	Matches   []Match `json:"matches"`

	// Routes The flows likeliest to define the text, likeliest first, one per kind: offered to the person, who chooses. Measured, the first was right half the time and the right one was among the three nine times in ten (docs/adr/0023).
	Routes []Route `json:"routes"`
}

Understanding defines model for Understanding.

type UnescapedCookieParamError

type UnescapedCookieParamError struct {
	ParamName string
	Err       error
}

func (*UnescapedCookieParamError) Error

func (e *UnescapedCookieParamError) Error() string

func (*UnescapedCookieParamError) Unwrap

func (e *UnescapedCookieParamError) Unwrap() error

type UnmarshalingParamError

type UnmarshalingParamError struct {
	ParamName string
	Err       error
}

func (*UnmarshalingParamError) Error

func (e *UnmarshalingParamError) Error() string

func (*UnmarshalingParamError) Unwrap

func (e *UnmarshalingParamError) Unwrap() error

type Unprocessable

type Unprocessable = ProblemList

Unprocessable defines model for Unprocessable.

type UnprocessableJSONResponse

type UnprocessableJSONResponse ProblemList

type Use added in v2.9.0

type Use struct {
	// As What the place means for the target; absent for any other place.
	As   *UseAs `json:"as,omitempty"`
	Id   string `json:"id"`
	Kind string `json:"kind"`
	Name string `json:"name"`

	// Path Where the reference sits in the manifest that makes it.
	Path string `json:"path"`
}

Use defines model for Use.

type UseAs added in v2.9.0

type UseAs string

UseAs What the place means for the target; absent for any other place.

const (
	Confirms UseAs = "confirms"
	Decided  UseAs = "decided"
	Receives UseAs = "receives"
)

Defines values for UseAs.

func (UseAs) Valid added in v2.9.0

func (e UseAs) Valid() bool

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

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 Waiver added in v2.6.0

type Waiver struct {
	Check string `json:"check"`

	// Message What the check said.
	Message string `json:"message"`

	// On The manifest it is on, as Kind/id, in a change set.
	On *string `json:"on,omitempty"`

	// Reason Why the agent left it open.
	Reason string `json:"reason"`
}

Waiver defines model for Waiver.

type WorkRef added in v2.9.0

type WorkRef struct {
	Id   string      `json:"id"`
	Kind WorkRefKind `json:"kind"`
}

WorkRef defines model for WorkRef.

type WorkRefKind added in v2.9.0

type WorkRefKind string

WorkRefKind defines model for WorkRef.Kind.

const (
	WorkRefKindProgramme WorkRefKind = "Programme"
	WorkRefKindProject   WorkRefKind = "Project"
)

Defines values for WorkRefKind.

func (WorkRefKind) Valid added in v2.9.0

func (e WorkRefKind) Valid() bool

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

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.

Jump to

Keyboard shortcuts

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