Skip to Content
InternalDocsRunbooksAPI Release Notes Template

API Release Notes Template

Source: docs/runbooks/api-release-notes-template.md

# API Release Notes Template Date: YYYY-MM-DD Owner: <name> Plan ID: <id> ## Summary - - - ## Contract Artifacts Updated - OpenAPI artifact(s): - Contract docs: - Contract tests: ## API Breaking-Change Guard - Breaking changes in this release: `yes/no` - If `yes`, provide all of the following: - New API version identifier: - Deprecated endpoint/field list: - Replacement endpoint/field list: - Deprecation window end date (>= 90 days): - Migration steps: - Backward compatibility validation evidence (tests/canary): ## New Endpoints / Fields - ## Deprecated Endpoints / Fields - ## Error Taxonomy Changes - Added codes: - Removed codes: - Changed semantics: ## Operational Notes - Required environment/config changes: - Rollback plan: - Monitoring checks after deploy: ## Evidence Links - PR: - CI: - Dry-run/canary: