diff options
| author | Tom Christie | 2014-12-17 12:41:46 +0000 |
|---|---|---|
| committer | Tom Christie | 2014-12-17 12:41:46 +0000 |
| commit | 05a6eaec8aebdca2248b9e1069a15769fd85a480 (patch) | |
| tree | 58488ee2e6533032d942dc65f038bbbc43462a87 /docs/api-guide/settings.md | |
| parent | 70bd3a32f7cf57543e8ec08fddf001a718e40c7f (diff) | |
| download | django-rest-framework-05a6eaec8aebdca2248b9e1069a15769fd85a480.tar.bz2 | |
More docs, plus 'ALLOWED_VERSIONS' setting.
Diffstat (limited to 'docs/api-guide/settings.md')
| -rw-r--r-- | docs/api-guide/settings.md | 22 |
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.* |
