Commit c016b8b

authored

Document how to override DRF generateschema generator_class. (#1084)

* Document how to override DRF generateschema generator_class. * changelog

1 parent c8511a0 commit c016b8bCopy full SHA for c016b8b

File tree

-3

lines changed

-3

lines changed

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,10 @@ any parts of the framework not mentioned in the documentation should generally b`
`21`	`21`	`* Added support for Django 4.1.`
`22`	`22`	* Expanded JSONParser API with `parse_data` method
`23`	`23`
	`24`	`+### Changed`
	`25`	`+`
	`26`	+* Improved documentation of how to override DRF's generateschema `--generator_class` to generate a proper DJA OAS schema.
	`27`	`+`
`24`	`28`	`### Removed`
`25`	`29`
`26`	`30`	`* Removed support for Django 2.2.`

Lines changed: 2 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -1085,11 +1085,10 @@ class MySchemaGenerator(JSONAPISchemaGenerator):`
`1085`	`1085`	`### Generate a Static Schema on Command Line`
`1086`	`1086`
`1087`	`1087`	`See [DRF documentation for generateschema](https://www.django-rest-framework.org/api-guide/schemas/#generating-a-static-schema-with-the-generateschema-management-command)`
`1088`		`-To generate an OAS schema document, use something like:`
	`1088`	+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:
`1089`	`1089`
`1090`	`1090`	```text
`1091`		`-$ django-admin generateschema --settings=example.settings \`
`1092`		`- --generator_class myapp.views.MySchemaGenerator >myschema.yaml`
	`1091`	`+$ ./manage.py generateschema --generator_class rest_framework_json_api.schemas.openapi.SchemaGenerator`
`1093`	`1092`	```
`1094`	`1093`
`1095`	`1094`	`You can then use any number of OAS tools such as`

Comments

(0)