Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
coderolisa wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions docs/API_DEPRECATION_POLICY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# API Deprecation Policy

## Overview

This document defines how deprecated endpoints and fields are announced and eventually removed from the Notify-Chain API.

## Deprecation Metadata

### Response Headers

Deprecated endpoints and fields will include the following response header:

```
Deprecation: true
```

Additional metadata will be provided in a custom header:

```
X-API-Deprecation: version=2.0.0; sunset=2027-04-17; link="https://github.com/coderolisa/Notify-Chain/blob/main/docs/API_MIGRATION_GUIDES.md"
```

**Header Fields:**
- `version`: The API version where the deprecation was introduced
- `sunset`: The date when the endpoint/field will be removed (RFC 3339 format)
- `link`: URL to migration documentation

## Status

🚧 **Work in Progress** - This is a foundational document (1% complete)

---

*Last updated: 2026-10-17*
Loading