Skip to content
This repository was archived by the owner on Aug 5, 2026. It is now read-only.

docs: document status projection + apiRef .api source - #10

Merged
braghettos merged 1 commit into
mainfrom
docs/apiref-status-projection
Jun 21, 2026
Merged

docs: document status projection + apiRef .api source#10
braghettos merged 1 commit into
mainfrom
docs/apiref-status-projection

Conversation

@braghettos

Copy link
Copy Markdown
Collaborator

Documents the status-projection + apiRef .api source feature (shipped in CDC 1.1.0) that was missing from the README.

What's added

  • Status Projection section: the declarative ${ jq } statusDataTemplate (env COMPOSITION_CONTROLLER_STATUS_DATA_TEMPLATE), the self/spec/status/helm/api source root, status.observedGeneration stamping, and the degrade-only / skip-while-paused behavior.
  • apiRef .api source subsection: the authn-JWT → snowplow RESTAction resolution chain (internal/authn, internal/snowplow, internal/composition/apiresolver.go), including per-instance compositionName/compositionNamespace/compositionId extras layered over static apiRef.extras.
  • Configuration table of the (optional) env vars, plus a pointer to hack/apiref-e2e/.

Grounded against main.go, internal/composition/, internal/authn/, internal/snowplow/, and the statusprojection engine. No invented flags/behavior; kept proportional to the README's existing depth.

🤖 Generated with Claude Code

Cover the declarative status projection (statusDataTemplate over the
self/spec/status/helm/api source root, observedGeneration, degrade-only
and paused behavior) and the apiRef .api source resolved via the
authn-JWT -> snowplow RESTAction chain, with the env-driven config.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@braghettos
braghettos merged commit 43c4e04 into main Jun 21, 2026
3 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant