Files
git.stella-ops.org/docs/modules/orchestrator/prep/2025-11-20-oas-63-001-prep.md
master d519782a8f
Some checks failed
Docs CI / lint-and-preview (push) Has been cancelled
prep docs and service updates
2025-11-21 06:56:36 +00:00

1.0 KiB

Orchestrator OAS Deprecations Prep — PREP-ORCH-OAS-63-001-DEPENDS-ON-62-001

Status: Draft (2025-11-20) Owners: Orchestrator Service Guild · API Governance Guild Scope: Define deprecation headers/docs for legacy orchestrator endpoints once OAS 61/62 are finalized.

Dependencies

  • Final OAS base (61-001) and discovery (62-001).
  • List of endpoints to deprecate and replacement mapping.

Proposed contract

  • Add Deprecation header and Link rel="alternate" to new endpoints.
  • Update OAS with deprecated: true and description of replacement.
  • Include changelog section and example responses showing headers.

Acceptance

  • Replacement map documented in this file and in docs/modules/orchestrator/api.md once OAS is regenerated.
  • Sample response with deprecation headers under docs/modules/orchestrator/samples/orch-deprecation@draft.json.

Handoff

Use this prep doc to satisfy PREP-ORCH-OAS-63-001-DEPENDS-ON-62-001. Update after 61/62 freeze; then mark task DONE and proceed with implementation.