Skip to content

docs: add API deprecation policy foundation (1%) - #1084

Open
coderolisa wants to merge 1 commit into
Core-Foundry:mainfrom
coderolisa:deprecation-policy-foundation
Open

coderolisa wants to merge 1 commit into
Core-Foundry:mainfrom
coderolisa:deprecation-policy-foundation

Conversation

@coderolisa

Copy link
Copy Markdown
Contributor
  • Created initial API_DEPRECATION_POLICY.md document
  • Defined deprecation response header structure
  • Specified X-API-Deprecation header format with version, sunset date, and migration link
  • Foundation for complete deprecation lifecycle management

Overview

Related Issue

Closes #993

Changes

Verification

# e.g.
cd dashboard && npm test
cd listener && npm run typecheck && npm test
cd contract/contracts/hello-world && cargo test

How to Test

Checklist

  • Branch is up to date with main
  • Tests added/updated and all pass locally
  • cargo fmt --all run (if Rust changes)
  • npm run lint passes (if TypeScript changes)
  • Documentation updated if behavior changed

- Created initial API_DEPRECATION_POLICY.md document
- Defined deprecation response header structure
- Specified X-API-Deprecation header format with version, sunset date, and migration link
- Foundation for complete deprecation lifecycle management
@drips-wave

drips-wave Bot commented Oct 17, 2026

Copy link
Copy Markdown

@coderolisa Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add an API Deprecation Policy and Sunset Metadata

1 participant