paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-04-21 10:29:29 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add api deprecation policy

Browse Source
This commit is contained in:
shamoon 2025-01-27 00:13:17 -08:00
parent 2e956b0f13
commit 7cbb3a3e8e
2 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api.md
View File

@ -541,6 +541,12 @@ server, the following procedure should be performed:
2. Determine whether the client is compatible with this server based on 2. Determine whether the client is compatible with this server based on
the presence/absence of these headers and their values if present. 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 ### API Changelog
#### Version 1 #### Version 1

2
src/paperless/settings.py
View File

@ -343,7 +343,7 @@ REST_FRAMEWORK = {
"DEFAULT_VERSIONING_CLASS": "rest_framework.versioning.AcceptHeaderVersioning", "DEFAULT_VERSIONING_CLASS": "rest_framework.versioning.AcceptHeaderVersioning",
"DEFAULT_VERSION": "7", "DEFAULT_VERSION": "7",
# Make sure these are ordered and that the most recent version appears # 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"], "ALLOWED_VERSIONS": ["1", "2", "3", "4", "5", "6", "7"],
} }