From 23806ba9d101c68db71e18dbf036dbff64835365 Mon Sep 17 00:00:00 2001 From: Alan Crosswell Date: Sat, 20 Aug 2022 16:50:32 -0400 Subject: [PATCH 1/2] Document how to override DRF generateschema generator_class. --- docs/usage.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/usage.md b/docs/usage.md index 952fe80c..40bb0f27 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -1085,11 +1085,10 @@ class MySchemaGenerator(JSONAPISchemaGenerator): ### Generate a Static Schema on Command Line See [DRF documentation for generateschema](https://www.django-rest-framework.org/api-guide/schemas/#generating-a-static-schema-with-the-generateschema-management-command) -To generate an OAS schema document, use something like: +To generate a static OAS schema document, using the `generateschema` management command, you **must override DRF's default** `generator_class` with the DJA-specific version: ```text -$ django-admin generateschema --settings=example.settings \ - --generator_class myapp.views.MySchemaGenerator >myschema.yaml +$ ./manage.py generateschema --generator_class rest_framework_json_api.schemas.openapi.SchemaGenerator ``` You can then use any number of OAS tools such as From dfeb7bc310fa65cb2b75ce3e713f3fbac9b6d44b Mon Sep 17 00:00:00 2001 From: Alan Crosswell Date: Sat, 20 Aug 2022 16:54:05 -0400 Subject: [PATCH 2/2] changelog --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 41990d56..73a9a738 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,6 +21,10 @@ any parts of the framework not mentioned in the documentation should generally b * Added support for Django 4.1. * Expanded JSONParser API with `parse_data` method +### Changed + +* Improved documentation of how to override DRF's generateschema `--generator_class` to generate a proper DJA OAS schema. + ### Removed * Removed support for Django 2.2.