1.0 KiB
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
Deprecationheader andLinkrel="alternate" to new endpoints. - Update OAS with
deprecated: trueand description of replacement. - Include changelog section and example responses showing headers.
Acceptance
- Replacement map documented in this file and in
docs/modules/orchestrator/api.mdonce 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.