Documentation
¶
Overview ¶
Package api is the thin driving adapter between the generated strict HTTP server (package apigen) and the engine. Every handler follows the same shape: convert the request, call exactly one engine method, convert the result or classify the error into a Problem-shaped response. No business logic lives here.
Index ¶
- func Handler(e *engine.Engine) http.Handler
- func New(e *engine.Engine, deps Deps) http.Handler
- func ReportCSV(t reporting.Table) ([]byte, error)
- type AgentTokens
- type Deps
- type Server
- func (s *Server) AcceptChangeSet(ctx context.Context, req apigen.AcceptChangeSetRequestObject) (apigen.AcceptChangeSetResponseObject, error)
- func (s *Server) AcceptProposal(ctx context.Context, req apigen.AcceptProposalRequestObject) (apigen.AcceptProposalResponseObject, error)
- func (s *Server) AppendSeriesItem(ctx context.Context, req apigen.AppendSeriesItemRequestObject) (apigen.AppendSeriesItemResponseObject, error)
- func (s *Server) ApplyRef(ctx context.Context, request apigen.ApplyRefRequestObject) (apigen.ApplyRefResponseObject, error)
- func (s *Server) ClassifyStructure(_ context.Context, req apigen.ClassifyStructureRequestObject) (apigen.ClassifyStructureResponseObject, error)
- func (s *Server) CloseChangeSet(ctx context.Context, req apigen.CloseChangeSetRequestObject) (apigen.CloseChangeSetResponseObject, error)
- func (s *Server) CreateAgentToken(ctx context.Context, req apigen.CreateAgentTokenRequestObject) (apigen.CreateAgentTokenResponseObject, error)
- func (s *Server) DeclineProposal(ctx context.Context, req apigen.DeclineProposalRequestObject) (apigen.DeclineProposalResponseObject, error)
- func (s *Server) DeleteGoal(ctx context.Context, req apigen.DeleteGoalRequestObject) (apigen.DeleteGoalResponseObject, error)
- func (s *Server) DeleteManifest(ctx context.Context, req apigen.DeleteManifestRequestObject) (apigen.DeleteManifestResponseObject, error)
- func (s *Server) DiffManifest(ctx context.Context, req apigen.DiffManifestRequestObject) (apigen.DiffManifestResponseObject, error)
- func (s *Server) DiscardWorking(ctx context.Context, req apigen.DiscardWorkingRequestObject) (apigen.DiscardWorkingResponseObject, error)
- func (s *Server) DropChangeSetItem(ctx context.Context, req apigen.DropChangeSetItemRequestObject) (apigen.DropChangeSetItemResponseObject, error)
- func (s *Server) ExportSemanticLayer(ctx context.Context, req apigen.ExportSemanticLayerRequestObject) (apigen.ExportSemanticLayerResponseObject, error)
- func (s *Server) FromIdea(ctx context.Context, req apigen.FromIdeaRequestObject) (apigen.FromIdeaResponseObject, error)
- func (s *Server) GetAgentFeed(ctx context.Context, req apigen.GetAgentFeedRequestObject) (apigen.GetAgentFeedResponseObject, error)
- func (s *Server) GetChangeSet(ctx context.Context, req apigen.GetChangeSetRequestObject) (apigen.GetChangeSetResponseObject, error)
- func (s *Server) GetChangeSetDocument(ctx context.Context, req apigen.GetChangeSetDocumentRequestObject) (apigen.GetChangeSetDocumentResponseObject, error)
- func (s *Server) GetChangeSetItem(ctx context.Context, req apigen.GetChangeSetItemRequestObject) (apigen.GetChangeSetItemResponseObject, error)
- func (s *Server) GetCharterPdf(ctx context.Context, req apigen.GetCharterPdfRequestObject) (apigen.GetCharterPdfResponseObject, error)
- func (s *Server) GetComponents(ctx context.Context, req apigen.GetComponentsRequestObject) (apigen.GetComponentsResponseObject, error)
- func (s *Server) GetCyclePeriods(ctx context.Context, req apigen.GetCyclePeriodsRequestObject) (apigen.GetCyclePeriodsResponseObject, error)
- func (s *Server) GetDecisionModel(ctx context.Context, _ apigen.GetDecisionModelRequestObject) (apigen.GetDecisionModelResponseObject, error)
- func (s *Server) GetFlow(_ context.Context, req apigen.GetFlowRequestObject) (apigen.GetFlowResponseObject, error)
- func (s *Server) GetGapChecks(ctx context.Context, req apigen.GetGapChecksRequestObject) (apigen.GetGapChecksResponseObject, error)
- func (s *Server) GetGapCoverage(ctx context.Context, req apigen.GetGapCoverageRequestObject) (apigen.GetGapCoverageResponseObject, error)
- func (s *Server) GetGlossary(_ context.Context, req apigen.GetGlossaryRequestObject) (apigen.GetGlossaryResponseObject, error)
- func (s *Server) GetGoalChecks(ctx context.Context, req apigen.GetGoalChecksRequestObject) (apigen.GetGoalChecksResponseObject, error)
- func (s *Server) GetGoalTree(ctx context.Context, req apigen.GetGoalTreeRequestObject) (apigen.GetGoalTreeResponseObject, error)
- func (s *Server) GetGraph(ctx context.Context, req apigen.GetGraphRequestObject) (apigen.GetGraphResponseObject, error)
- func (s *Server) GetGuide(ctx context.Context, req apigen.GetGuideRequestObject) (apigen.GetGuideResponseObject, error)
- func (s *Server) GetHealth(_ context.Context, _ apigen.GetHealthRequestObject) (apigen.GetHealthResponseObject, error)
- func (s *Server) GetKPIControlChart(ctx context.Context, req apigen.GetKPIControlChartRequestObject) (apigen.GetKPIControlChartResponseObject, error)
- func (s *Server) GetLineage(ctx context.Context, req apigen.GetLineageRequestObject) (apigen.GetLineageResponseObject, error)
- func (s *Server) GetLinkCandidates(ctx context.Context, req apigen.GetLinkCandidatesRequestObject) (apigen.GetLinkCandidatesResponseObject, error)
- func (s *Server) GetManifest(ctx context.Context, req apigen.GetManifestRequestObject) (apigen.GetManifestResponseObject, error)
- func (s *Server) GetOperationCharterHtml(ctx context.Context, req apigen.GetOperationCharterHtmlRequestObject) (apigen.GetOperationCharterHtmlResponseObject, error)
- func (s *Server) GetOperationChecks(ctx context.Context, req apigen.GetOperationChecksRequestObject) (apigen.GetOperationChecksResponseObject, error)
- func (s *Server) GetOrder(ctx context.Context, req apigen.GetOrderRequestObject) (apigen.GetOrderResponseObject, error)
- func (s *Server) GetPortfolioChecks(ctx context.Context, req apigen.GetPortfolioChecksRequestObject) (apigen.GetPortfolioChecksResponseObject, error)
- func (s *Server) GetPresenceDocument(ctx context.Context, req apigen.GetPresenceDocumentRequestObject) (apigen.GetPresenceDocumentResponseObject, error)
- func (s *Server) GetProgrammeCharterHtml(ctx context.Context, req apigen.GetProgrammeCharterHtmlRequestObject) (apigen.GetProgrammeCharterHtmlResponseObject, error)
- func (s *Server) GetProgrammeChecks(ctx context.Context, req apigen.GetProgrammeChecksRequestObject) (apigen.GetProgrammeChecksResponseObject, error)
- func (s *Server) GetProjectCharterHtml(ctx context.Context, req apigen.GetProjectCharterHtmlRequestObject) (apigen.GetProjectCharterHtmlResponseObject, error)
- func (s *Server) GetProjectChecks(ctx context.Context, req apigen.GetProjectChecksRequestObject) (apigen.GetProjectChecksResponseObject, error)
- func (s *Server) GetProjectDMAIC(ctx context.Context, req apigen.GetProjectDMAICRequestObject) (apigen.GetProjectDMAICResponseObject, error)
- func (s *Server) GetProjectSchedule(ctx context.Context, req apigen.GetProjectScheduleRequestObject) (apigen.GetProjectScheduleResponseObject, error)
- func (s *Server) GetProjectState(ctx context.Context, req apigen.GetProjectStateRequestObject) (apigen.GetProjectStateResponseObject, error)
- func (s *Server) GetProposal(ctx context.Context, req apigen.GetProposalRequestObject) (apigen.GetProposalResponseObject, error)
- func (s *Server) GetReferences(ctx context.Context, req apigen.GetReferencesRequestObject) (apigen.GetReferencesResponseObject, error)
- func (s *Server) GetReport(ctx context.Context, req apigen.GetReportRequestObject) (apigen.GetReportResponseObject, error)
- func (s *Server) GetSchema(_ context.Context, req apigen.GetSchemaRequestObject) (apigen.GetSchemaResponseObject, error)
- func (s *Server) GetSession(ctx context.Context, _ apigen.GetSessionRequestObject) (apigen.GetSessionResponseObject, error)
- func (s *Server) GetSettings(ctx context.Context, _ apigen.GetSettingsRequestObject) (apigen.GetSettingsResponseObject, error)
- func (s *Server) GetSharedDocument(ctx context.Context, req apigen.GetSharedDocumentRequestObject) (apigen.GetSharedDocumentResponseObject, error)
- func (s *Server) GetVault(ctx context.Context, _ apigen.GetVaultRequestObject) (apigen.GetVaultResponseObject, error)
- func (s *Server) GetVersion(ctx context.Context, req apigen.GetVersionRequestObject) (apigen.GetVersionResponseObject, error)
- func (s *Server) GetWorking(ctx context.Context, req apigen.GetWorkingRequestObject) (apigen.GetWorkingResponseObject, error)
- func (s *Server) GrantPerson(ctx context.Context, req apigen.GrantPersonRequestObject) (apigen.GrantPersonResponseObject, error)
- func (s *Server) IncludeChangeSetItem(ctx context.Context, req apigen.IncludeChangeSetItemRequestObject) (apigen.IncludeChangeSetItemResponseObject, error)
- func (s *Server) ListAgentGrants(ctx context.Context, req apigen.ListAgentGrantsRequestObject) (apigen.ListAgentGrantsResponseObject, error)
- func (s *Server) ListChangeSets(ctx context.Context, req apigen.ListChangeSetsRequestObject) (apigen.ListChangeSetsResponseObject, error)
- func (s *Server) ListExcluded(ctx context.Context, _ apigen.ListExcludedRequestObject) (apigen.ListExcludedResponseObject, error)
- func (s *Server) ListFlows(context.Context, apigen.ListFlowsRequestObject) (apigen.ListFlowsResponseObject, error)
- func (s *Server) ListKinds(_ context.Context, _ apigen.ListKindsRequestObject) (apigen.ListKindsResponseObject, error)
- func (s *Server) ListManifests(ctx context.Context, req apigen.ListManifestsRequestObject) (apigen.ListManifestsResponseObject, error)
- func (s *Server) ListPeople(ctx context.Context, _ apigen.ListPeopleRequestObject) (apigen.ListPeopleResponseObject, error)
- func (s *Server) ListProposals(ctx context.Context, req apigen.ListProposalsRequestObject) (apigen.ListProposalsResponseObject, error)
- func (s *Server) ListSnapshots(ctx context.Context, req apigen.ListSnapshotsRequestObject) (apigen.ListSnapshotsResponseObject, error)
- func (s *Server) ListUnapplied(ctx context.Context, _ apigen.ListUnappliedRequestObject) (apigen.ListUnappliedResponseObject, error)
- func (s *Server) ListVersions(ctx context.Context, req apigen.ListVersionsRequestObject) (apigen.ListVersionsResponseObject, error)
- func (s *Server) MatchExisting(ctx context.Context, req apigen.MatchExistingRequestObject) (apigen.MatchExistingResponseObject, error)
- func (s *Server) MoveInChangeSet(ctx context.Context, req apigen.MoveInChangeSetRequestObject) (apigen.MoveInChangeSetResponseObject, error)
- func (s *Server) PostSnapshot(ctx context.Context, req apigen.PostSnapshotRequestObject) (apigen.PostSnapshotResponseObject, error)
- func (s *Server) ProposeChangeSet(ctx context.Context, req apigen.ProposeChangeSetRequestObject) (apigen.ProposeChangeSetResponseObject, error)
- func (s *Server) PutChangeSetItem(ctx context.Context, req apigen.PutChangeSetItemRequestObject) (apigen.PutChangeSetItemResponseObject, error)
- func (s *Server) PutManifest(ctx context.Context, req apigen.PutManifestRequestObject) (apigen.PutManifestResponseObject, error)
- func (s *Server) PutWorking(ctx context.Context, req apigen.PutWorkingRequestObject) (apigen.PutWorkingResponseObject, error)
- func (s *Server) RecoverRef(ctx context.Context, request apigen.RecoverRefRequestObject) (apigen.RecoverRefResponseObject, error)
- func (s *Server) Relevant(ctx context.Context, req apigen.RelevantRequestObject) (apigen.RelevantResponseObject, error)
- func (s *Server) RemoveInChangeSet(ctx context.Context, req apigen.RemoveInChangeSetRequestObject) (apigen.RemoveInChangeSetResponseObject, error)
- func (s *Server) RemovePerson(ctx context.Context, req apigen.RemovePersonRequestObject) (apigen.RemovePersonResponseObject, error)
- func (s *Server) ReopenChangeSet(ctx context.Context, req apigen.ReopenChangeSetRequestObject) (apigen.ReopenChangeSetResponseObject, error)
- func (s *Server) RetitleChangeSet(ctx context.Context, req apigen.RetitleChangeSetRequestObject) (apigen.RetitleChangeSetResponseObject, error)
- func (s *Server) RevokeAgentGrant(ctx context.Context, req apigen.RevokeAgentGrantRequestObject) (apigen.RevokeAgentGrantResponseObject, error)
- func (s *Server) StartChangeSet(ctx context.Context, req apigen.StartChangeSetRequestObject) (apigen.StartChangeSetResponseObject, error)
- func (s *Server) StructureQuestions(_ context.Context, _ apigen.StructureQuestionsRequestObject) (apigen.StructureQuestionsResponseObject, error)
- func (s *Server) Sync(_ context.Context, _ apigen.SyncRequestObject) (apigen.SyncResponseObject, error)
- func (s *Server) TransitionProjectState(ctx context.Context, req apigen.TransitionProjectStateRequestObject) (apigen.TransitionProjectStateResponseObject, error)
- func (s *Server) Understand(ctx context.Context, req apigen.UnderstandRequestObject) (apigen.UnderstandResponseObject, error)
- func (s *Server) ValidateManifest(ctx context.Context, req apigen.ValidateManifestRequestObject) (apigen.ValidateManifestResponseObject, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Handler ¶
Handler returns the complete net/http handler for the API, mounted under no particular prefix (the caller mounts it at /api/v1), with no PDF printer.
Types ¶
type AgentTokens ¶ added in v2.5.0
type AgentTokens interface {
Mint(ctx context.Context, label string, ttl time.Duration) (string, store.AgentGrant, error)
}
AgentTokens is the port POST /agents mints through: the authorization server that issues agents' tokens, which grants the signed-in person's agent and returns a token that carries the grant (docs/adr/0016).
type Deps ¶
type Deps struct {
Printer printer.Printer
// Authorizer answers GET /session's canWrite; the middleware still
// decides every request. AllowAll when nil.
Authorizer auth.Authorizer
// Reports answers /reports. Nil turns reporting off: the reports
// answer 404.
Reports reporting.Reporter
// AgentTokens mints the tokens POST /agents returns: the authorization
// server's, when Cartograph is one. Nil answers 404.
AgentTokens AgentTokens
// AgentsOn says agents are served over MCP, for the session to say.
AgentsOn bool
}
Deps is what a Server needs beyond the engine.
type Server ¶
type Server struct {
Engine *engine.Engine
Printer printer.Printer
Authz auth.Authorizer
// Reports answers /reports; nil when the deployment turned
// reporting off (docs/adr/0014).
Reports reporting.Reporter
// AgentTokens mints pasteable agent tokens; nil where another stack
// authorizes agents.
AgentTokens AgentTokens
// AgentsOn is whether agents are served over MCP.
AgentsOn bool
}
Server implements apigen.StrictServerInterface over an *engine.Engine. Printer is the port a PDF goes through; nil means printer.None.
func (*Server) AcceptChangeSet ¶ added in v2.7.0
func (s *Server) AcceptChangeSet(ctx context.Context, req apigen.AcceptChangeSetRequestObject) (apigen.AcceptChangeSetResponseObject, error)
func (*Server) AcceptProposal ¶ added in v2.5.0
func (s *Server) AcceptProposal(ctx context.Context, req apigen.AcceptProposalRequestObject) (apigen.AcceptProposalResponseObject, error)
AcceptProposal makes the record a proposal proposed, as the caller.
func (*Server) AppendSeriesItem ¶ added in v2.3.0
func (s *Server) AppendSeriesItem(ctx context.Context, req apigen.AppendSeriesItemRequestObject) (apigen.AppendSeriesItemResponseObject, error)
AppendSeriesItem records one item of a series, such as a reading, and commits the manifest with it.
func (*Server) ApplyRef ¶
func (s *Server) ApplyRef(ctx context.Context, request apigen.ApplyRefRequestObject) (apigen.ApplyRefResponseObject, error)
ApplyRef includes one manifest, or many, in the live state. Many in one call, because one at a time was quadratic and felt it: the engine reloads and reindexes once for the batch.
func (*Server) ClassifyStructure ¶ added in v2.10.0
func (s *Server) ClassifyStructure(_ context.Context, req apigen.ClassifyStructureRequestObject) (apigen.ClassifyStructureResponseObject, error)
ClassifyStructure says what each piece is from its answers.
func (*Server) CloseChangeSet ¶ added in v2.7.0
func (s *Server) CloseChangeSet(ctx context.Context, req apigen.CloseChangeSetRequestObject) (apigen.CloseChangeSetResponseObject, error)
func (*Server) CreateAgentToken ¶ added in v2.5.0
func (s *Server) CreateAgentToken(ctx context.Context, req apigen.CreateAgentTokenRequestObject) (apigen.CreateAgentTokenResponseObject, error)
CreateAgentToken lets an agent act for the caller by a token they paste into its client.
func (*Server) DeclineProposal ¶ added in v2.5.0
func (s *Server) DeclineProposal(ctx context.Context, req apigen.DeclineProposalRequestObject) (apigen.DeclineProposalResponseObject, error)
DeclineProposal declines a proposal, as the caller.
func (*Server) DeleteGoal ¶
func (s *Server) DeleteGoal(ctx context.Context, req apigen.DeleteGoalRequestObject) (apigen.DeleteGoalResponseObject, error)
func (*Server) DeleteManifest ¶
func (s *Server) DeleteManifest(ctx context.Context, req apigen.DeleteManifestRequestObject) (apigen.DeleteManifestResponseObject, error)
DeleteManifest excludes a manifest from the live state (any kind).
func (*Server) DiffManifest ¶
func (s *Server) DiffManifest(ctx context.Context, req apigen.DiffManifestRequestObject) (apigen.DiffManifestResponseObject, error)
func (*Server) DiscardWorking ¶
func (s *Server) DiscardWorking(ctx context.Context, req apigen.DiscardWorkingRequestObject) (apigen.DiscardWorkingResponseObject, error)
PutWorking saves a manifest's working copy without creating a version (autosave). DiscardWorking throws away a staged draft. Nothing is returned: the caller reads the manifest back, and what comes back is whatever the vault holds — the saved file, or nothing if it was never saved.
func (*Server) DropChangeSetItem ¶ added in v2.7.0
func (s *Server) DropChangeSetItem(ctx context.Context, req apigen.DropChangeSetItemRequestObject) (apigen.DropChangeSetItemResponseObject, error)
func (*Server) ExportSemanticLayer ¶ added in v2.10.0
func (s *Server) ExportSemanticLayer(ctx context.Context, req apigen.ExportSemanticLayerRequestObject) (apigen.ExportSemanticLayerResponseObject, error)
ExportSemanticLayer writes the KPIs as a semantic layer in a syntax the deployment has an exporter for (TAXONOMY.md D57).
func (*Server) FromIdea ¶ added in v2.9.0
func (s *Server) FromIdea(ctx context.Context, req apigen.FromIdeaRequestObject) (apigen.FromIdeaResponseObject, error)
FromIdea is the sentence of an idea that answers each question a walk asks.
func (*Server) GetAgentFeed ¶ added in v2.6.0
func (s *Server) GetAgentFeed(ctx context.Context, req apigen.GetAgentFeedRequestObject) (apigen.GetAgentFeedResponseObject, error)
GetAgentFeed returns the document to follow a person's agents on.
func (*Server) GetChangeSet ¶ added in v2.7.0
func (s *Server) GetChangeSet(ctx context.Context, req apigen.GetChangeSetRequestObject) (apigen.GetChangeSetResponseObject, error)
func (*Server) GetChangeSetDocument ¶ added in v2.9.0
func (s *Server) GetChangeSetDocument(ctx context.Context, req apigen.GetChangeSetDocumentRequestObject) (apigen.GetChangeSetDocumentResponseObject, error)
GetChangeSetDocument names a change set's live draft of a manifest, creating it on first use (docs/adr/0024).
func (*Server) GetChangeSetItem ¶ added in v2.7.0
func (s *Server) GetChangeSetItem(ctx context.Context, req apigen.GetChangeSetItemRequestObject) (apigen.GetChangeSetItemResponseObject, error)
func (*Server) GetCharterPdf ¶
func (s *Server) GetCharterPdf(ctx context.Context, req apigen.GetCharterPdfRequestObject) (apigen.GetCharterPdfResponseObject, error)
GetCharterPdf prints the charter of a project, programme or operation to PDF. A project prints its working copy when asked, otherwise its latest version, and its working copy when it has no version yet: somebody exporting a draft wants the draft, not a refusal.
func (*Server) GetComponents ¶ added in v2.9.0
func (s *Server) GetComponents(ctx context.Context, req apigen.GetComponentsRequestObject) (apigen.GetComponentsResponseObject, error)
GetComponents is the graph of components across the workspace, read as the change set named would leave it.
func (*Server) GetCyclePeriods ¶ added in v2.9.0
func (s *Server) GetCyclePeriods(ctx context.Context, req apigen.GetCyclePeriodsRequestObject) (apigen.GetCyclePeriodsResponseObject, error)
GetCyclePeriods lays out a reporting cycle's periods between two months, as the engine derives them (TAXONOMY.md D40).
func (*Server) GetDecisionModel ¶ added in v2.9.0
func (s *Server) GetDecisionModel(ctx context.Context, _ apigen.GetDecisionModelRequestObject) (apigen.GetDecisionModelResponseObject, error)
GetDecisionModel is whether a decision model is configured and ready.
func (*Server) GetFlow ¶
func (s *Server) GetFlow(_ context.Context, req apigen.GetFlowRequestObject) (apigen.GetFlowResponseObject, error)
func (*Server) GetGapChecks ¶
func (s *Server) GetGapChecks(ctx context.Context, req apigen.GetGapChecksRequestObject) (apigen.GetGapChecksResponseObject, error)
GetProgrammeChecks mirrors the goal's shape rather than the project's: a flat list, no blocking count, because none of a programme's checks blocks anything.
func (*Server) GetGapCoverage ¶
func (s *Server) GetGapCoverage(ctx context.Context, req apigen.GetGapCoverageRequestObject) (apigen.GetGapCoverageResponseObject, error)
func (*Server) GetGlossary ¶ added in v2.7.0
func (s *Server) GetGlossary(_ context.Context, req apigen.GetGlossaryRequestObject) (apigen.GetGlossaryResponseObject, error)
GetGlossary is every word of the taxonomy, defined plainly, in the order of work.
func (*Server) GetGoalChecks ¶
func (s *Server) GetGoalChecks(ctx context.Context, req apigen.GetGoalChecksRequestObject) (apigen.GetGoalChecksResponseObject, error)
func (*Server) GetGoalTree ¶
func (s *Server) GetGoalTree(ctx context.Context, req apigen.GetGoalTreeRequestObject) (apigen.GetGoalTreeResponseObject, error)
func (*Server) GetGraph ¶ added in v2.7.0
func (s *Server) GetGraph(ctx context.Context, req apigen.GetGraphRequestObject) (apigen.GetGraphResponseObject, error)
func (*Server) GetGuide ¶ added in v2.6.0
func (s *Server) GetGuide(ctx context.Context, req apigen.GetGuideRequestObject) (apigen.GetGuideResponseObject, error)
GetGuide returns how to define a kind well, as agents read it over MCP. The engine's guide already has the contract's shape, field for field.
func (*Server) GetHealth ¶
func (s *Server) GetHealth(_ context.Context, _ apigen.GetHealthRequestObject) (apigen.GetHealthResponseObject, error)
func (*Server) GetKPIControlChart ¶ added in v2.10.0
func (s *Server) GetKPIControlChart(ctx context.Context, req apigen.GetKPIControlChartRequestObject) (apigen.GetKPIControlChartResponseObject, error)
GetKPIControlChart reads a KPI's readings as a control chart.
func (*Server) GetLineage ¶ added in v2.10.0
func (s *Server) GetLineage(ctx context.Context, req apigen.GetLineageRequestObject) (apigen.GetLineageResponseObject, error)
GetLineage draws a project's data lineage from its data as it is being edited and the workspace as the change set reads it.
func (*Server) GetLinkCandidates ¶ added in v2.9.0
func (s *Server) GetLinkCandidates(ctx context.Context, req apigen.GetLinkCandidatesRequestObject) (apigen.GetLinkCandidatesResponseObject, error)
GetLinkCandidates is what a link may join from one record, read as the change set named would leave the workspace.
func (*Server) GetManifest ¶
func (s *Server) GetManifest(ctx context.Context, req apigen.GetManifestRequestObject) (apigen.GetManifestResponseObject, error)
func (*Server) GetOperationCharterHtml ¶
func (s *Server) GetOperationCharterHtml( ctx context.Context, req apigen.GetOperationCharterHtmlRequestObject, ) (apigen.GetOperationCharterHtmlResponseObject, error)
GetOperationCharterHtml renders an operation as its service description.
func (*Server) GetOperationChecks ¶
func (s *Server) GetOperationChecks(ctx context.Context, req apigen.GetOperationChecksRequestObject) (apigen.GetOperationChecksResponseObject, error)
GetOperationChecks: the same flat, advisory shape as a programme's.
func (*Server) GetOrder ¶ added in v2.7.0
func (s *Server) GetOrder(ctx context.Context, req apigen.GetOrderRequestObject) (apigen.GetOrderResponseObject, error)
GetOrder is the order of work and how far the workspace has got.
func (*Server) GetPortfolioChecks ¶ added in v2.9.0
func (s *Server) GetPortfolioChecks(ctx context.Context, req apigen.GetPortfolioChecksRequestObject) (apigen.GetPortfolioChecksResponseObject, error)
GetPortfolioChecks answers in the programme's shape: every check is advice read from other manifests (TAXONOMY.md D32).
func (*Server) GetPresenceDocument ¶
func (s *Server) GetPresenceDocument(ctx context.Context, req apigen.GetPresenceDocumentRequestObject) (apigen.GetPresenceDocumentResponseObject, error)
GetPresenceDocument names the document that routes presence: a record's, or the one for screens not about one manifest.
func (*Server) GetProgrammeCharterHtml ¶
func (s *Server) GetProgrammeCharterHtml( ctx context.Context, req apigen.GetProgrammeCharterHtmlRequestObject, ) (apigen.GetProgrammeCharterHtmlResponseObject, error)
GetProgrammeCharterHtml renders a programme as a document.
func (*Server) GetProgrammeChecks ¶
func (s *Server) GetProgrammeChecks(ctx context.Context, req apigen.GetProgrammeChecksRequestObject) (apigen.GetProgrammeChecksResponseObject, error)
func (*Server) GetProjectCharterHtml ¶
func (s *Server) GetProjectCharterHtml(ctx context.Context, req apigen.GetProjectCharterHtmlRequestObject) (apigen.GetProjectCharterHtmlResponseObject, error)
func (*Server) GetProjectChecks ¶
func (s *Server) GetProjectChecks(ctx context.Context, req apigen.GetProjectChecksRequestObject) (apigen.GetProjectChecksResponseObject, error)
func (*Server) GetProjectDMAIC ¶ added in v2.10.0
func (s *Server) GetProjectDMAIC(ctx context.Context, req apigen.GetProjectDMAICRequestObject) (apigen.GetProjectDMAICResponseObject, error)
GetProjectDMAIC says whether a project can be taken through DMAIC (TAXONOMY.md D58).
func (*Server) GetProjectSchedule ¶ added in v2.9.0
func (s *Server) GetProjectSchedule(ctx context.Context, req apigen.GetProjectScheduleRequestObject) (apigen.GetProjectScheduleResponseObject, error)
GetProjectSchedule is a project's milestones placed on time, read as the change set named would leave it.
func (*Server) GetProjectState ¶
func (s *Server) GetProjectState(ctx context.Context, req apigen.GetProjectStateRequestObject) (apigen.GetProjectStateResponseObject, error)
func (*Server) GetProposal ¶ added in v2.6.0
func (s *Server) GetProposal(ctx context.Context, req apigen.GetProposalRequestObject) (apigen.GetProposalResponseObject, error)
GetProposal returns a proposal as its person reviews it.
func (*Server) GetReferences ¶
func (s *Server) GetReferences(ctx context.Context, req apigen.GetReferencesRequestObject) (apigen.GetReferencesResponseObject, error)
func (*Server) GetReport ¶ added in v2.3.0
func (s *Server) GetReport(ctx context.Context, req apigen.GetReportRequestObject) (apigen.GetReportResponseObject, error)
GetReport answers a report from the deployment's reporter, as JSON or as CSV; 404 when reporting is off.
func (*Server) GetSchema ¶
func (s *Server) GetSchema(_ context.Context, req apigen.GetSchemaRequestObject) (apigen.GetSchemaResponseObject, error)
func (*Server) GetSession ¶
func (s *Server) GetSession(ctx context.Context, _ apigen.GetSessionRequestObject) (apigen.GetSessionResponseObject, error)
GetSession says who this request acts as. canWrite is the authorizer's answer for a write with no particular manifest; the engine still decides every write on its own.
func (*Server) GetSettings ¶
func (s *Server) GetSettings(ctx context.Context, _ apigen.GetSettingsRequestObject) (apigen.GetSettingsResponseObject, error)
func (*Server) GetSharedDocument ¶
func (s *Server) GetSharedDocument(ctx context.Context, req apigen.GetSharedDocumentRequestObject) (apigen.GetSharedDocumentResponseObject, error)
GetSharedDocument names a manifest's shared draft, creating it on first use (docs/adr/0007).
func (*Server) GetVault ¶
func (s *Server) GetVault(ctx context.Context, _ apigen.GetVaultRequestObject) (apigen.GetVaultResponseObject, error)
GetVault returns the state manifest: what the live state includes.
func (*Server) GetVersion ¶
func (s *Server) GetVersion(ctx context.Context, req apigen.GetVersionRequestObject) (apigen.GetVersionResponseObject, error)
func (*Server) GetWorking ¶
func (s *Server) GetWorking(ctx context.Context, req apigen.GetWorkingRequestObject) (apigen.GetWorkingResponseObject, error)
GetWorking returns the working copy as last saved, decoded through the engine's codec, or 404 when the manifest has none.
func (*Server) GrantPerson ¶ added in v2.2.0
func (*Server) IncludeChangeSetItem ¶ added in v2.7.0
func (s *Server) IncludeChangeSetItem(ctx context.Context, req apigen.IncludeChangeSetItemRequestObject) (apigen.IncludeChangeSetItemResponseObject, error)
func (*Server) ListAgentGrants ¶ added in v2.5.0
func (s *Server) ListAgentGrants(ctx context.Context, req apigen.ListAgentGrantsRequestObject) (apigen.ListAgentGrantsResponseObject, error)
ListAgentGrants lists the agents people let act for them.
func (*Server) ListChangeSets ¶ added in v2.7.0
func (s *Server) ListChangeSets(ctx context.Context, req apigen.ListChangeSetsRequestObject) (apigen.ListChangeSetsResponseObject, error)
func (*Server) ListExcluded ¶
func (s *Server) ListExcluded(ctx context.Context, _ apigen.ListExcludedRequestObject) (apigen.ListExcludedResponseObject, error)
ListExcluded lists every excluded manifest, newest first.
func (*Server) ListFlows ¶
func (s *Server) ListFlows(context.Context, apigen.ListFlowsRequestObject) (apigen.ListFlowsResponseObject, error)
func (*Server) ListKinds ¶
func (s *Server) ListKinds(_ context.Context, _ apigen.ListKindsRequestObject) (apigen.ListKindsResponseObject, error)
func (*Server) ListManifests ¶
func (s *Server) ListManifests(ctx context.Context, req apigen.ListManifestsRequestObject) (apigen.ListManifestsResponseObject, error)
func (*Server) ListPeople ¶ added in v2.2.0
func (*Server) ListProposals ¶ added in v2.5.0
func (s *Server) ListProposals(ctx context.Context, req apigen.ListProposalsRequestObject) (apigen.ListProposalsResponseObject, error)
ListProposals lists what agents proposed (docs/adr/0016): the caller's open ones by default, or every proposal on one manifest.
func (*Server) ListSnapshots ¶
func (s *Server) ListSnapshots(ctx context.Context, req apigen.ListSnapshotsRequestObject) (apigen.ListSnapshotsResponseObject, error)
ListSnapshots returns every snapshot (version) across all kinds, newest first.
func (*Server) ListUnapplied ¶
func (s *Server) ListUnapplied(ctx context.Context, _ apigen.ListUnappliedRequestObject) (apigen.ListUnappliedResponseObject, error)
ListUnapplied lists manifests present but not in the live state.
func (*Server) ListVersions ¶
func (s *Server) ListVersions(ctx context.Context, req apigen.ListVersionsRequestObject) (apigen.ListVersionsResponseObject, error)
func (*Server) MatchExisting ¶ added in v2.9.0
func (s *Server) MatchExisting(ctx context.Context, req apigen.MatchExistingRequestObject) (apigen.MatchExistingResponseObject, error)
MatchExisting is the records of a kind that say what a text says.
func (*Server) MoveInChangeSet ¶ added in v2.9.0
func (s *Server) MoveInChangeSet(ctx context.Context, req apigen.MoveInChangeSetRequestObject) (apigen.MoveInChangeSetResponseObject, error)
func (*Server) PostSnapshot ¶
func (s *Server) PostSnapshot(ctx context.Context, req apigen.PostSnapshotRequestObject) (apigen.PostSnapshotResponseObject, error)
PostSnapshot records an explicit version of a manifest's current content with a reason. Snapshots the working copy if one exists, otherwise the current version. The author is from Settings.spec.operator.
func (*Server) ProposeChangeSet ¶ added in v2.7.0
func (s *Server) ProposeChangeSet(ctx context.Context, req apigen.ProposeChangeSetRequestObject) (apigen.ProposeChangeSetResponseObject, error)
func (*Server) PutChangeSetItem ¶ added in v2.7.0
func (s *Server) PutChangeSetItem(ctx context.Context, req apigen.PutChangeSetItemRequestObject) (apigen.PutChangeSetItemResponseObject, error)
func (*Server) PutManifest ¶
func (s *Server) PutManifest(ctx context.Context, req apigen.PutManifestRequestObject) (apigen.PutManifestResponseObject, error)
func (*Server) PutWorking ¶
func (s *Server) PutWorking(ctx context.Context, req apigen.PutWorkingRequestObject) (apigen.PutWorkingResponseObject, error)
func (*Server) RecoverRef ¶
func (s *Server) RecoverRef(ctx context.Context, request apigen.RecoverRefRequestObject) (apigen.RecoverRefResponseObject, error)
RecoverRef re-includes an excluded manifest in the live state.
func (*Server) Relevant ¶ added in v2.9.0
func (s *Server) Relevant(ctx context.Context, req apigen.RelevantRequestObject) (apigen.RelevantResponseObject, error)
Relevant is what in the workspace is relevant to a piece of work.
func (*Server) RemoveInChangeSet ¶ added in v2.9.0
func (s *Server) RemoveInChangeSet(ctx context.Context, req apigen.RemoveInChangeSetRequestObject) (apigen.RemoveInChangeSetResponseObject, error)
func (*Server) RemovePerson ¶ added in v2.2.0
func (*Server) ReopenChangeSet ¶ added in v2.7.0
func (s *Server) ReopenChangeSet(ctx context.Context, req apigen.ReopenChangeSetRequestObject) (apigen.ReopenChangeSetResponseObject, error)
func (*Server) RetitleChangeSet ¶ added in v2.7.0
func (s *Server) RetitleChangeSet(ctx context.Context, req apigen.RetitleChangeSetRequestObject) (apigen.RetitleChangeSetResponseObject, error)
func (*Server) RevokeAgentGrant ¶ added in v2.5.0
func (s *Server) RevokeAgentGrant(ctx context.Context, req apigen.RevokeAgentGrantRequestObject) (apigen.RevokeAgentGrantResponseObject, error)
RevokeAgentGrant disconnects an agent at once.
func (*Server) StartChangeSet ¶ added in v2.7.0
func (s *Server) StartChangeSet(ctx context.Context, req apigen.StartChangeSetRequestObject) (apigen.StartChangeSetResponseObject, error)
func (*Server) StructureQuestions ¶ added in v2.10.0
func (s *Server) StructureQuestions(_ context.Context, _ apigen.StructureQuestionsRequestObject) (apigen.StructureQuestionsResponseObject, error)
StructureQuestions lists the questions that decide what each piece of work is (TAXONOMY.md D56).
func (*Server) Sync ¶
func (s *Server) Sync(_ context.Context, _ apigen.SyncRequestObject) (apigen.SyncResponseObject, error)
Sync answers a request to the sync path that did not upgrade: the socket itself is served by the sync server, mounted ahead of this handler (cmd/cartograph).
func (*Server) TransitionProjectState ¶
func (s *Server) TransitionProjectState(ctx context.Context, req apigen.TransitionProjectStateRequestObject) (apigen.TransitionProjectStateResponseObject, error)
func (*Server) Understand ¶ added in v2.9.0
func (s *Server) Understand(ctx context.Context, req apigen.UnderstandRequestObject) (apigen.UnderstandResponseObject, error)
Understand is what a typed text reads as, and what already says it.
func (*Server) ValidateManifest ¶
func (s *Server) ValidateManifest(ctx context.Context, req apigen.ValidateManifestRequestObject) (apigen.ValidateManifestResponseObject, error)