OpenAPI Schema Generation #223

dhaval-mehta · 2020-03-15T20:30:24Z

Hi @auvipy,

This fixes: #219, #237

You requested to wait for 3.12 Release. I will write code in such a way that it will be compatible will 3.12 Release.

This will close: #186 and #219

auvipy · 2020-03-16T07:54:43Z

OK

dhaval-mehta · 2020-03-19T06:05:16Z

Hi, @auvipy Whenever you are free time, please review code quality.
Now, I will work on Testcases and Documentation.

I do not know how to generate schema for models.GeometryField & models.GeometryCollectionField. Please provide guidance for the schema generation for these fields.

auvipy · 2020-03-19T06:20:59Z

@sir-sigurd would you mind sharing your insight on this? I saw you contribute a lot on geodjango front :)

compacq · 2020-04-04T20:44:05Z

#````````

_{Sent with GitHawk}

tests/django_restframework_gis_tests/test_schema_generation.py

rest_framework_gis/schema.py

dhaval-mehta · 2020-11-23T04:19:52Z

why?

These commits are no longer required. #248 fixes PostgreSQL integration problem.

dhaval-mehta · 2020-12-24T19:47:06Z

@auvipy Gentle reminder. I have merged the latest master.

nemesifier

Great progress @dhaval-mehta!

I left some comments below.

Anyone else here using/testing this who would like to leave feedback? @jayvdb @auvipy

README.rst

tests/settings.py

tox.ini

README.rst

Co-authored-by: Federico Capoano <[email protected]>

nemesifier

I guess the only way to get feedback on this feature is to publish it and see what happens, @dhaval-mehta will you stick around to help us maintain it?

dhaval-mehta · 2021-01-10T12:32:35Z

I guess the only way to get feedback on this feature is to publish it and see what happens, @dhaval-mehta will you stick around to help us maintain it?

Sure. It will be my pleasure to maintain this project.

nemesifier · 2021-01-25T00:26:27Z

@dhaval-mehta your work is now released! I expect feedback from users of this library in the coming months.
I sent you an invite to have write access to this repository in the hope that you can help us maintain this feature as feedback from users comes in.

Pushes to master are restricted to admins, but pushes to other branches are allowed 👍.

dhaval-mehta · 2021-01-25T19:03:14Z

I will ask my network to test this as well. It will help us to improve the schema generation quickly.

dhaval-mehta · 2021-01-25T19:05:46Z

@dhaval-mehta your work is now released! I expect feedback from users of this library in the coming months.
I sent you an invite to have write access to this repository in the hope that you can help us maintain this feature as feedback from users comes in.

Pushes to master are restricted to admins, but pushes to other branches are allowed 👍.

Thank you so much for providing me this opportunity. It would be my pleasure to contribute to this repo.

christiaan-dockbite · 2021-09-22T21:40:36Z

Requiring users to set REST_FRAMEWORK.DEFAULT_SCHEMA_CLASS to a custom GIS specific class will limit the utility of this. The default DRF schema generator is rarely used for serious projects because there are so many unsolved problems in it. Most medium to large projects will use drf-yasg, or similar (including drf-spectacular which is new but quite good), and they use their own mechanism, either requiring that DEFAULT_SCHEMA_CLASS is set to their own class, or they ignore DEFAULT_SCHEMA_CLASS altogether. And many projects need to sub-class DRF's AutoSchema to add their own behaviour. I've tried to do a WIP for drf-spectacular to use the standard AutoSchema inheritance at tfranzel/drf-spectacular#46 , but it has has some curly problems.

Keeping GeoFeatureAutoSchema is ok, but it would be better as a thin wrapper only, using functionality that exists outside of the class.

i.e. the schemas and functions that are embedded here inside this class should be in the module namespace, so they can be used with other generators. The code in this custom AutoSchema only uses self. to reference the new code below -- it doesnt rely on any of the inner workings of DRF AutoSchema.

@dhaval-mehta Is there any way now that the schema generation is compatible with other schema generators, such as drf-spectacular? If not, is there a way we can make it compatible?

dhaval-mehta · 2021-09-24T14:26:41Z

Requiring users to set REST_FRAMEWORK.DEFAULT_SCHEMA_CLASS to a custom GIS specific class will limit the utility of this. The default DRF schema generator is rarely used for serious projects because there are so many unsolved problems in it. Most medium to large projects will use drf-yasg, or similar (including drf-spectacular which is new but quite good), and they use their own mechanism, either requiring that DEFAULT_SCHEMA_CLASS is set to their own class, or they ignore DEFAULT_SCHEMA_CLASS altogether. And many projects need to sub-class DRF's AutoSchema to add their own behaviour. I've tried to do a WIP for drf-spectacular to use the standard AutoSchema inheritance at tfranzel/drf-spectacular#46 , but it has has some curly problems.
Keeping GeoFeatureAutoSchema is ok, but it would be better as a thin wrapper only, using functionality that exists outside of the class.
i.e. the schemas and functions that are embedded here inside this class should be in the module namespace, so they can be used with other generators. The code in this custom AutoSchema only uses self. to reference the new code below -- it doesnt rely on any of the inner workings of DRF AutoSchema.

@dhaval-mehta Is there any way now that the schema generation is compatible with other schema generators, such as drf-spectacular? If not, is there a way we can make it compatible?

This implementation is compatible with all libraries which are compatible with DRF schema generation.
As per my knowledge, implementation of drf-spectacular is not compatible with DRF's schema generation. Hence I think, there is no way to make it compatible with drf-spectacular.

tfranzel/drf-spectacular#38 This PR is open. This can bring support for open API schema generation for drf-spectacular.

auvipy · 2021-09-25T07:02:06Z

drf-specticular need to upgrade its code to drf openAPI 3.0+

stefangeorg · 2022-12-12T13:54:41Z

rest_framework_gis/filters.py

+                "style": "form",
+                "explode": False,
+            }
+        )


This needs to return the params. It is throwing an error in drf spectacular

this implementation is not based on DRF spectacular btw

@auvipy yes but check all implementations of get_schema_operation_parameters, they all return data. This is the only one that does not. Settings params inside of get_schema_operation_parameters and then not returning it also does not make sense since no one can access these parameters, since they are not set on self or returned. It is a get function, which should return something. In this case the params.

are you up for making a contribution? I will review it

dhaval-mehta added 2 commits March 16, 2020 00:50

add openapi schema generation for filters

d8cf934

improve schema generation for filters

a448b13

add code to generate schema from serializer

0859877

rename some variables

bce22da

dhaval-mehta added 9 commits April 3, 2020 15:18

override schema of pagination

75343a0

handle GeometrySerializerMethodField

93b0f14

fix invalid schema for id field

9f94293

add test models

c7421e4

add test serializer

69bc672

add initial test case for schema generation

7b99c1e

add model migration

563ce0d

rename files

9df1f4f

fix handling of GeometrySerializerMethodField

b0ff15c

dhaval-mehta changed the title ~~OpenAPI Schema Generation For Filters~~ OpenAPI Schema Generation Apr 3, 2020

dhaval-mehta added 4 commits April 8, 2020 22:01

handle DRF version >= 3.12

99bf8cf

add DEFAULT_SCHEMA_CLASS

255f160

upgrade djangorestframework to 3.11

5598003

fix _map_serializer

b830a74

auvipy self-requested a review April 8, 2020 16:54

revert DRF version to 3.10

2b7f862

dhaval-mehta commented Apr 8, 2020

View reviewed changes

tests/django_restframework_gis_tests/test_schema_generation.py Outdated Show resolved Hide resolved

rest_framework_gis/schema.py Show resolved Hide resolved

dhaval-mehta added 5 commits April 8, 2020 23:23

fix schema for polygon

e3f1494

fix enum for polygon

540a7c4

add test cases for polygon

2a8d1b0

remove min items and change example generation logic

f9ab386

add test cases for multi polygon

60682e7

nemesifier added the enhancement label Nov 10, 2020

[Merge] Merge remote-tracking branch 'upstream/master'

c9ffd55

dhaval-mehta added 2 commits December 25, 2020 15:20

[ci] Fix .travis.yml

438527c

[code] Add support for GeometryField and GeometryCollectionField

f890c91

nemesifier requested changes Dec 30, 2020

View reviewed changes

README.rst Outdated Show resolved Hide resolved

tests/settings.py Outdated Show resolved Hide resolved

tox.ini Outdated Show resolved Hide resolved

nemesifier reviewed Dec 30, 2020

View reviewed changes

README.rst Outdated Show resolved Hide resolved

README.rst Outdated Show resolved Hide resolved

nemesifier reviewed Dec 30, 2020

View reviewed changes

README.rst Outdated Show resolved Hide resolved

README.rst Outdated Show resolved Hide resolved

README.rst Outdated Show resolved Hide resolved

nemesifier reviewed Dec 30, 2020

View reviewed changes

README.rst Outdated Show resolved Hide resolved

README.rst Outdated Show resolved Hide resolved

dhaval-mehta and others added 3 commits December 31, 2020 13:15

[docs] improve docs

d61949d

Co-authored-by: Federico Capoano <[email protected]>

[ci] Remove support for Django 2.1 and support for Python 3.9

88d0b12

[lint] Fix linting issues

d0f8848

auvipy approved these changes Jan 3, 2021

View reviewed changes

nemesifier reviewed Jan 10, 2021

View reviewed changes

auvipy merged commit 4be23ef into openwisp:master Jan 10, 2021

tfranzel mentioned this pull request Sep 16, 2021

django-rest-framework-gis tfranzel/drf-spectacular#31

Closed

Christiaanvv mentioned this pull request Sep 22, 2021

Using restframework-gis OpenAPI schema creation tfranzel/drf-spectacular#532

Closed

stefangeorg reviewed Dec 12, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

OpenAPI Schema Generation #223

OpenAPI Schema Generation #223

dhaval-mehta commented Mar 15, 2020 •

edited

Loading

auvipy commented Mar 16, 2020

dhaval-mehta commented Mar 19, 2020 •

edited

Loading

auvipy commented Mar 19, 2020

compacq commented Apr 4, 2020

dhaval-mehta commented Nov 23, 2020

dhaval-mehta commented Dec 24, 2020

nemesifier left a comment

nemesifier left a comment

dhaval-mehta commented Jan 10, 2021

nemesifier commented Jan 25, 2021

dhaval-mehta commented Jan 25, 2021

dhaval-mehta commented Jan 25, 2021

christiaan-dockbite commented Sep 22, 2021

dhaval-mehta commented Sep 24, 2021 •

edited

Loading

auvipy commented Sep 25, 2021

stefangeorg Dec 12, 2022

auvipy Dec 12, 2022

stefangeorg Dec 12, 2022

auvipy Dec 12, 2022

OpenAPI Schema Generation #223

OpenAPI Schema Generation #223

Conversation

dhaval-mehta commented Mar 15, 2020 • edited Loading

auvipy commented Mar 16, 2020

dhaval-mehta commented Mar 19, 2020 • edited Loading

auvipy commented Mar 19, 2020

compacq commented Apr 4, 2020

dhaval-mehta commented Nov 23, 2020

dhaval-mehta commented Dec 24, 2020

nemesifier left a comment

Choose a reason for hiding this comment

nemesifier left a comment

Choose a reason for hiding this comment

dhaval-mehta commented Jan 10, 2021

nemesifier commented Jan 25, 2021

dhaval-mehta commented Jan 25, 2021

dhaval-mehta commented Jan 25, 2021

christiaan-dockbite commented Sep 22, 2021

dhaval-mehta commented Sep 24, 2021 • edited Loading

auvipy commented Sep 25, 2021

stefangeorg Dec 12, 2022

Choose a reason for hiding this comment

auvipy Dec 12, 2022

Choose a reason for hiding this comment

stefangeorg Dec 12, 2022

Choose a reason for hiding this comment

auvipy Dec 12, 2022

Choose a reason for hiding this comment

dhaval-mehta commented Mar 15, 2020 •

edited

Loading

dhaval-mehta commented Mar 19, 2020 •

edited

Loading

dhaval-mehta commented Sep 24, 2021 •

edited

Loading