api

package

Go to main page

Versions in this module

v2

v2.11.0

Oct 15, 2026

Changes in this version

type Server

+ func (s *Server) AddComment(ctx context.Context, req apigen.AddCommentRequestObject) (apigen.AddCommentResponseObject, error)

+ func (s *Server) GetChangeSetCharter(ctx context.Context, req apigen.GetChangeSetCharterRequestObject) (apigen.GetChangeSetCharterResponseObject, error)

+ func (s *Server) GetCharterPartsStyle(_ context.Context, _ apigen.GetCharterPartsStyleRequestObject) (apigen.GetCharterPartsStyleResponseObject, error)

+ func (s *Server) GetProjectCharterParts(ctx context.Context, req apigen.GetProjectCharterPartsRequestObject) (apigen.GetProjectCharterPartsResponseObject, error)

+ func (s *Server) GetProjectConstraints(ctx context.Context, req apigen.GetProjectConstraintsRequestObject) (apigen.GetProjectConstraintsResponseObject, error)

+ func (s *Server) GetProjectRound(ctx context.Context, req apigen.GetProjectRoundRequestObject) (apigen.GetProjectRoundResponseObject, error)

+ func (s *Server) GetProjectWaits(ctx context.Context, req apigen.GetProjectWaitsRequestObject) (apigen.GetProjectWaitsResponseObject, error)

+ func (s *Server) GetWhatATriggerReaches(ctx context.Context, req apigen.GetWhatATriggerReachesRequestObject) (apigen.GetWhatATriggerReachesResponseObject, error)

+ func (s *Server) ListComments(ctx context.Context, req apigen.ListCommentsRequestObject) (apigen.ListCommentsResponseObject, error)

+ func (s *Server) ListMentionables(ctx context.Context, req apigen.ListMentionablesRequestObject) (apigen.ListMentionablesResponseObject, error)

+ func (s *Server) ListMyMentions(ctx context.Context, _ apigen.ListMyMentionsRequestObject) (apigen.ListMyMentionsResponseObject, error)

+ func (s *Server) MatchWhatHappened(ctx context.Context, req apigen.MatchWhatHappenedRequestObject) (apigen.MatchWhatHappenedResponseObject, error)

+ func (s *Server) ReadAggregation(_ context.Context, req apigen.ReadAggregationRequestObject) (apigen.ReadAggregationResponseObject, error)

+ func (s *Server) RecordEvents(ctx context.Context, req apigen.RecordEventsRequestObject) (apigen.RecordEventsResponseObject, error)

+ func (s *Server) ResolveComment(ctx context.Context, req apigen.ResolveCommentRequestObject) (apigen.ResolveCommentResponseObject, error)

v2.10.1

Oct 9, 2026

v2.10.0

Oct 9, 2026

Changes in this version

type Server

+ func (s *Server) ClassifyStructure(_ context.Context, req apigen.ClassifyStructureRequestObject) (apigen.ClassifyStructureResponseObject, error)

+ func (s *Server) ExportSemanticLayer(ctx context.Context, req apigen.ExportSemanticLayerRequestObject) (apigen.ExportSemanticLayerResponseObject, 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) GetProjectDMAIC(ctx context.Context, req apigen.GetProjectDMAICRequestObject) (apigen.GetProjectDMAICResponseObject, error)

+ func (s *Server) StructureQuestions(_ context.Context, _ apigen.StructureQuestionsRequestObject) (apigen.StructureQuestionsResponseObject, error)

v2.9.0

Oct 7, 2026

Changes in this version

type Server

+ func (s *Server) FromIdea(ctx context.Context, req apigen.FromIdeaRequestObject) (apigen.FromIdeaResponseObject, error)

+ func (s *Server) GetChangeSetDocument(ctx context.Context, req apigen.GetChangeSetDocumentRequestObject) (apigen.GetChangeSetDocumentResponseObject, 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) GetLinkCandidates(ctx context.Context, req apigen.GetLinkCandidatesRequestObject) (apigen.GetLinkCandidatesResponseObject, error)

+ func (s *Server) GetPortfolioChecks(ctx context.Context, req apigen.GetPortfolioChecksRequestObject) (apigen.GetPortfolioChecksResponseObject, error)

+ func (s *Server) GetProjectSchedule(ctx context.Context, req apigen.GetProjectScheduleRequestObject) (apigen.GetProjectScheduleResponseObject, 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) 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) Understand(ctx context.Context, req apigen.UnderstandRequestObject) (apigen.UnderstandResponseObject, error)

v2.8.0

Oct 4, 2026

v2.7.0

Oct 4, 2026

Changes in this version

type Server

+ func (s *Server) AcceptChangeSet(ctx context.Context, req apigen.AcceptChangeSetRequestObject) (apigen.AcceptChangeSetResponseObject, error)

+ func (s *Server) CloseChangeSet(ctx context.Context, req apigen.CloseChangeSetRequestObject) (apigen.CloseChangeSetResponseObject, error)

+ func (s *Server) DropChangeSetItem(ctx context.Context, req apigen.DropChangeSetItemRequestObject) (apigen.DropChangeSetItemResponseObject, error)

+ func (s *Server) GetChangeSet(ctx context.Context, req apigen.GetChangeSetRequestObject) (apigen.GetChangeSetResponseObject, error)

+ func (s *Server) GetChangeSetItem(ctx context.Context, req apigen.GetChangeSetItemRequestObject) (apigen.GetChangeSetItemResponseObject, error)

+ func (s *Server) GetGlossary(_ context.Context, req apigen.GetGlossaryRequestObject) (apigen.GetGlossaryResponseObject, error)

+ func (s *Server) GetGraph(ctx context.Context, req apigen.GetGraphRequestObject) (apigen.GetGraphResponseObject, error)

+ func (s *Server) GetOrder(ctx context.Context, _ apigen.GetOrderRequestObject) (apigen.GetOrderResponseObject, error)

+ func (s *Server) IncludeChangeSetItem(ctx context.Context, req apigen.IncludeChangeSetItemRequestObject) (apigen.IncludeChangeSetItemResponseObject, error)

+ func (s *Server) ListChangeSets(ctx context.Context, req apigen.ListChangeSetsRequestObject) (apigen.ListChangeSetsResponseObject, 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) 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) StartChangeSet(ctx context.Context, req apigen.StartChangeSetRequestObject) (apigen.StartChangeSetResponseObject, error)

v2.6.0

Oct 2, 2026

Changes in this version

type Deps

+ AgentsOn bool

type Server

+ AgentsOn bool

+ func (s *Server) GetAgentFeed(ctx context.Context, req apigen.GetAgentFeedRequestObject) (apigen.GetAgentFeedResponseObject, error)

+ func (s *Server) GetGuide(ctx context.Context, req apigen.GetGuideRequestObject) (apigen.GetGuideResponseObject, error)

+ func (s *Server) GetProposal(ctx context.Context, req apigen.GetProposalRequestObject) (apigen.GetProposalResponseObject, error)

v2.5.0

Oct 2, 2026

Changes in this version

+ type AgentTokens interface

+ Mint func(ctx context.Context, label string, ttl time.Duration) (string, store.AgentGrant, error)

type Deps

+ AgentTokens AgentTokens

type Server

+ AgentTokens AgentTokens

+ func (s *Server) AcceptProposal(ctx context.Context, req apigen.AcceptProposalRequestObject) (apigen.AcceptProposalResponseObject, 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) ListAgentGrants(ctx context.Context, req apigen.ListAgentGrantsRequestObject) (apigen.ListAgentGrantsResponseObject, error)

+ func (s *Server) ListProposals(ctx context.Context, req apigen.ListProposalsRequestObject) (apigen.ListProposalsResponseObject, error)

+ func (s *Server) RevokeAgentGrant(ctx context.Context, req apigen.RevokeAgentGrantRequestObject) (apigen.RevokeAgentGrantResponseObject, error)

v2.4.0

Oct 2, 2026

v2.3.0

Oct 2, 2026

Changes in this version

+ func ReportCSV(t reporting.Table) ([]byte, error)

type Deps

+ Reports reporting.Reporter

type Server

+ Reports reporting.Reporter

+ func (s *Server) AppendSeriesItem(ctx context.Context, req apigen.AppendSeriesItemRequestObject) (apigen.AppendSeriesItemResponseObject, error)

+ func (s *Server) GetReport(ctx context.Context, req apigen.GetReportRequestObject) (apigen.GetReportResponseObject, error)

v2.2.1

Oct 2, 2026

v2.2.0

Oct 2, 2026

Changes in this version

type Server

+ func (s *Server) GrantPerson(ctx context.Context, req apigen.GrantPersonRequestObject) (apigen.GrantPersonResponseObject, error)

+ func (s *Server) ListPeople(ctx context.Context, _ apigen.ListPeopleRequestObject) (apigen.ListPeopleResponseObject, error)

+ func (s *Server) RemovePerson(ctx context.Context, req apigen.RemovePersonRequestObject) (apigen.RemovePersonResponseObject, error)

v2.1.0

Oct 1, 2026

v2.0.0

Oct 1, 2026

Changes in this version

+ func Handler(e *engine.Engine) http.Handler

+ func New(e *engine.Engine, deps Deps) http.Handler

+ type Deps struct

+ Authorizer auth.Authorizer

+ Printer printer.Printer

+ type Server struct

+ Authz auth.Authorizer

+ Engine *engine.Engine

+ Printer printer.Printer

+ func (s *Server) ApplyRef(ctx context.Context, request apigen.ApplyRefRequestObject) (apigen.ApplyRefResponseObject, 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) GetCharterPdf(ctx context.Context, req apigen.GetCharterPdfRequestObject) (apigen.GetCharterPdfResponseObject, 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) GetGoalChecks(ctx context.Context, req apigen.GetGoalChecksRequestObject) (apigen.GetGoalChecksResponseObject, error)

+ func (s *Server) GetGoalTree(ctx context.Context, _ apigen.GetGoalTreeRequestObject) (apigen.GetGoalTreeResponseObject, error)

+ func (s *Server) GetHealth(_ context.Context, _ apigen.GetHealthRequestObject) (apigen.GetHealthResponseObject, 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) GetPresenceDocument(ctx context.Context, _ 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) GetProjectState(ctx context.Context, req apigen.GetProjectStateRequestObject) (apigen.GetProjectStateResponseObject, error)

+ func (s *Server) GetReferences(ctx context.Context, req apigen.GetReferencesRequestObject) (apigen.GetReferencesResponseObject, 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) 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) 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) PostSnapshot(ctx context.Context, req apigen.PostSnapshotRequestObject) (apigen.PostSnapshotResponseObject, 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) Sync(_ context.Context, _ apigen.SyncRequestObject) (apigen.SyncResponseObject, error)

+ func (s *Server) TransitionProjectState(ctx context.Context, req apigen.TransitionProjectStateRequestObject) (apigen.TransitionProjectStateResponseObject, error)

+ func (s *Server) ValidateManifest(ctx context.Context, req apigen.ValidateManifestRequestObject) (apigen.ValidateManifestResponseObject, error)

Other modules containing this package

github.com/ProjectCartograph/cartograph-engine

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