DevOps / GitOps — APIs¶
Generated from the architecture model
This page is rendered from model/**/*.yaml by tools/docs_model during mkdocs build. Edit the YAML, not this page; hand-written design lives on the linked service, platform and plane pages.
DeliveryHost¶
REST (public endpoints need a scope; every call carries trusted tenant and project scope)
| Method | Path | Operation | Scope | Side effects | Idempotency | Gateway | Summary |
|---|---|---|---|---|---|---|---|
GET |
/delivery/health |
DeliveryHealth | factory.health.read |
read | natural | GW-01 | Liveness, readiness and dependency health (delivery store, connectors, artifact store, inbox lag). |
GET |
/delivery/meta/systems |
DeliverySystems | factory.meta.read |
read | natural | GW-03 | The source-control and CI systems of record configured per tenant (Azure DevOps, GitHub) through connectors. |
EnvironmentPromotionService¶
REST (public endpoints need a scope; every call carries trusted tenant and project scope)
| Method | Path | Operation | Scope | Side effects | Idempotency | Gateway | Summary |
|---|---|---|---|---|---|---|---|
GET |
/factory/delivery/promotions |
ListPromotions | factory.delivery.read |
read | natural | GW-03 | Promotions by environment, release and state with gates. |
GET |
/factory/delivery/promotions/{promotionId} |
GetPromotion | factory.delivery.read |
read | natural | GW-03 | One promotion with gates, approval, desired state, verification and rollback evidence. |
POST |
/factory/delivery/promotions |
RequestPromotion | factory.delivery.promote |
production | key-header | GW-03 | Promote a ready release into an environment (production class for production; called by the deploy-environment tool or an Operator). |
POST |
/factory/delivery/promotions/{promotionId}/rollback |
RollbackPromotion | factory.delivery.operate |
production | natural | GW-03 | Roll back to the previous release in that environment (Operator by role; evidence recorded). |
GET |
/factory/environments/{environmentId}/current-release |
GetCurrentRelease | factory.delivery.read |
read | natural | GW-03 | The release currently completed in an environment (fleet inventory and the Studio read it). |
gRPC (code-first, internal)
| gRPC service | Method | Streaming | Visibility | Side effects | Summary |
|---|---|---|---|---|---|
Promotions |
Request |
none | internal | production | Request a promotion from the deploy-environment tool with the run and receipt. |
PipelineExecutionService¶
REST (public endpoints need a scope; every call carries trusted tenant and project scope)
| Method | Path | Operation | Scope | Side effects | Idempotency | Gateway | Summary |
|---|---|---|---|---|---|---|---|
GET |
/factory/delivery/proposals |
ListChangeProposals | factory.delivery.read |
read | natural | GW-03 | Change proposals by project, run, repository and state with pull-request references. |
GET |
/factory/delivery/proposals/{proposalId} |
GetChangeProposal | factory.delivery.read |
read | natural | GW-03 | One proposal with commits, reviews, pipeline runs and provenance. |
POST |
/factory/delivery/proposals |
OpenChangeProposal | factory.delivery.propose |
shared-write | key-header | GW-03 | Push a change set as a branch and open a pull request in the system of record (shared-write class; called by the propose-change-set tool with its receipt). |
GET |
/factory/delivery/pipeline-runs |
ListPipelineRuns | factory.delivery.read |
read | natural | GW-03 | Pipeline runs by project, commit, proposal and state. |
GET |
/factory/delivery/pipeline-runs/{pipelineRunId} |
GetPipelineRun | factory.delivery.read |
read | natural | GW-03 | Stages and typed results with artifact references. |
POST |
/factory/delivery/pipeline-runs/{pipelineRunId}/reconcile |
ReconcilePipelineRun | factory.delivery.operate |
shared-write | natural | GW-03 | Re-read the run from the system of record when a delivery was missed (Operator). |
gRPC (code-first, internal)
| gRPC service | Method | Streaming | Visibility | Side effects | Summary |
|---|---|---|---|---|---|
Pipelines |
RecordProposal |
none | internal | shared-write | Record a proposal opened by the propose-change-set tool with its receipt. |
ReleaseService¶
REST (public endpoints need a scope; every call carries trusted tenant and project scope)
| Method | Path | Operation | Scope | Side effects | Idempotency | Gateway | Summary |
|---|---|---|---|---|---|---|---|
GET |
/factory/delivery/releases |
ListProductReleases | factory.delivery.read |
read | natural | GW-03 | Releases by product, version and state with components and provenance. |
GET |
/factory/delivery/releases/{releaseId} |
GetProductRelease | factory.delivery.read |
read | natural | GW-03 | One release with components, SBOM, attestations, pipeline run, proposals and generating assets. |
POST |
/factory/delivery/releases |
CreateProductRelease | factory.delivery.release |
shared-write | key-header | GW-03 | Assemble a release from a succeeded pipeline run (version, components from its results, provenance); Candidate until every component has publication evidence. |
POST |
/factory/delivery/releases/{releaseId}/withdraw |
WithdrawProductRelease | factory.delivery.release |
shared-write | natural | GW-03 | Withdraw a release with a reason (blocks promotion; revokes nothing already deployed). |
gRPC (code-first, internal)
| gRPC service | Method | Streaming | Visibility | Side effects | Summary |
|---|---|---|---|---|---|
Releases |
GetRelease |
none | internal | read | Resolve a release with digests and evidence for promotion and fleet inventory. |