From 7cbb3a3e8ed7386d5b9620e695b8b8cd05375ae1 Mon Sep 17 00:00:00 2001
From: shamoon <4887959+shamoon@users.noreply.github.com>
Date: Mon, 27 Jan 2025 00:13:17 -0800
Subject: [PATCH] Add api deprecation policy

---
 docs/api.md               | 6 ++++++
 src/paperless/settings.py | 2 +-
 2 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/docs/api.md b/docs/api.md
index 536418844..050443c19 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -541,6 +541,12 @@ server, the following procedure should be performed:
 2.  Determine whether the client is compatible with this server based on
     the presence/absence of these headers and their values if present.
 
+### API Version Deprecation Policy
+
+Older API versions are guaranteed to be supported for at least one year
+after the release of a new API version. After that, support for older
+API versions may be (but is not guaranteed to be) dropped.
+
 ### API Changelog
 
 #### Version 1
diff --git a/src/paperless/settings.py b/src/paperless/settings.py
index dcfdc020d..a817abd70 100644
--- a/src/paperless/settings.py
+++ b/src/paperless/settings.py
@@ -343,7 +343,7 @@ REST_FRAMEWORK = {
     "DEFAULT_VERSIONING_CLASS": "rest_framework.versioning.AcceptHeaderVersioning",
     "DEFAULT_VERSION": "7",
     # Make sure these are ordered and that the most recent version appears
-    # last
+    # last. See api.md#api-versioning when adding new versions.
     "ALLOWED_VERSIONS": ["1", "2", "3", "4", "5", "6", "7"],
 }