Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document effective DRF settings #128

Merged
merged 1 commit into from
Jul 18, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion docs/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,27 @@ This can be done in the following way:
}
},
"SECURITY": [{"ApiKeyAuth": [], }],
}
}

Django Rest Framework settings
------------------------------

Some of the `Django Rest Framework settings <https://www.django-rest-framework.org/api-guide/settings/>`_
also impact the schema generation. Refer to the documentation for the version that you are using.

Settings which effect the processing of requests and data types of responses will usually be effective.

There is explicit use of these settings:

- `COERCE_DECIMAL_TO_STRING`
- `UPLOADED_FILES_USE_URL`

The following settings are ignored:

- `SCHEMA_COERCE_METHOD_NAMES`

The following are known to be effective:

- `SCHEMA_COERCE_PATH_PK`
- `FORMAT_SUFFIX_KWARG`
- `URL_FORMAT_OVERRIDE`