From f1ede7b245560fdff8f4a78a8f5fde64cb324fdf Mon Sep 17 00:00:00 2001 From: Notify-Chain Bot Date: Sat, 17 Oct 2026 18:50:43 +0100 Subject: [PATCH] docs: add API deprecation policy foundation (1%) - 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 --- docs/API_DEPRECATION_POLICY.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 docs/API_DEPRECATION_POLICY.md diff --git a/docs/API_DEPRECATION_POLICY.md b/docs/API_DEPRECATION_POLICY.md new file mode 100644 index 00000000..21e0cae9 --- /dev/null +++ b/docs/API_DEPRECATION_POLICY.md @@ -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*