aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-guide/settings.md
diff options
context:
space:
mode:
authorTom Christie2014-12-17 12:54:31 +0000
committerTom Christie2014-12-17 12:54:31 +0000
commit47fe6977077ae33dfe2f8b6d04d81083b9b9f4d7 (patch)
tree58488ee2e6533032d942dc65f038bbbc43462a87 /docs/api-guide/settings.md
parentb6ee784240b3c7f6cd62af5b6fe6d1014d7bf6d4 (diff)
parent05a6eaec8aebdca2248b9e1069a15769fd85a480 (diff)
downloaddjango-rest-framework-47fe6977077ae33dfe2f8b6d04d81083b9b9f4d7.tar.bz2
Merge pull request #2285 from tomchristie/versioning
Versioning
Diffstat (limited to 'docs/api-guide/settings.md')
-rw-r--r--docs/api-guide/settings.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/api-guide/settings.md b/docs/api-guide/settings.md
index 9efeda7f..5af429d1 100644
--- a/docs/api-guide/settings.md
+++ b/docs/api-guide/settings.md
@@ -166,6 +166,28 @@ Default: `ordering`
---
+## Versioning settings
+
+#### DEFAULT_VERSION
+
+The value that should be used for `request.version` when no versioning information is present.
+
+Default: `None`
+
+#### ALLOWED_VERSIONS
+
+If set, this value will restrict the set of versions that may be returned by the versioning scheme, and will raise an error if the provided version if not in this set.
+
+Default: `None`
+
+#### VERSION_PARAMETER
+
+The string that should used for any versioning parameters, such as in the media type or URL query parameters.
+
+Default: `'version'`
+
+---
+
## Authentication settings
*The following settings control the behavior of unauthenticated requests.*