Commit 3689f92

committed

openapi as optional feature

1 parent ca0319d commit 3689f92Copy full SHA for 3689f92

File tree

+11

-2

lines changed

+11

-2

lines changed

Lines changed: 5 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,11 @@ any parts of the framework not mentioned in the documentation should generally b`
`13`	`13`	`### Added`
`14`	`14`
`15`	`15`	* Added support for serializing nested serializers as attribute json value introducing setting `JSON_API_SERIALIZE_NESTED_SERIALIZERS_AS_ATTRIBUTE`
`16`		-* Add support openapi schema and for `generateschema` management command.
	`16`	`+* Add optional support for [openapi](https://www.openapis.org/) schema generation. Enable with:`
	`17`	+ ```
	`18`	`+ pip install djangorestframework-jsonapi['openapi']`
	`19`	+ ```
	`20`	`+`
`17`	`21`
`18`	`22`	`### Fixed`
`19`	`23`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -106,6 +106,7 @@ From PyPI`
`106`	`106`	`$ # for optional package integrations`
`107`	`107`	`$ pip install djangorestframework-jsonapi['django-filter']`
`108`	`108`	`$ pip install djangorestframework-jsonapi['django-polymorphic']`
	`109`	`+ $ pip install djangorestframework-jsonapi['openapi']`
`109`	`110`
`110`	`111`
`111`	`112`	`From Source`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -65,6 +65,7 @@ From PyPI`
`65`	`65`	`# for optional package integrations`
`66`	`66`	`pip install djangorestframework-jsonapi['django-filter']`
`67`	`67`	`pip install djangorestframework-jsonapi['django-polymorphic']`
	`68`	`+ pip install djangorestframework-jsonapi['openapi']`
`68`	`69`
`69`	`70`	`From Source`
`70`	`71`

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -986,6 +986,8 @@ initializer:`
`986`	`986`	```python
`987`	`987`	`from rest_framework_json_api.schemas.openapi import AutoSchema`
`988`	`988`
	`989`	`+TODO: resolve this with upstream changes:`
	`990`	`+`
`989`	`991`	`openapi_schema = {`
`990`	`992`	`'info': {`
`991`	`993`	`'version': '1.0',`

Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,8 @@ def get_package_data(package):`
`95`	`95`	`],`
`96`	`96`	`extras_require={`
`97`	`97`	`'django-polymorphic': ['django-polymorphic>=2.0'],`
`98`		`- 'django-filter': ['django-filter>=2.0']`
	`98`	`+ 'django-filter': ['django-filter>=2.0'],`
	`99`	`+ 'openapi': ['pyyaml>=5.3', 'uritemplate>=3.0.1']`
`99`	`100`	`},`
`100`	`101`	`setup_requires=wheel,`
`101`	`102`	`python_requires=">=3.5",`

Comments

(0)