I found a mistake in the tox.ini/.travis changes -- commit coming soon as I finish testing locally.

@arielpontes I'd appreciate it if you could test this. Just add something like git+https://github.com/n2ygk/django-rest-framework-json-api.git@openapi_schema to your project's requirements.txt and then:

$ pip install -Ur requirements.txt
$ python manage.py generateschema >myschema.yaml

You can test the schema with something like swagger-ui-watcher:

$ npm install -g swagger-ui-watcher
$ swagger-ui-watcher myschema.yaml

Ignore the "DELETE operations cannot have a requestBody." messages.

@sliverc Thanks for the the feedback.

I had intended to implement OAS here first before moving portions of the implementation that are commonly useful (like securitySchemes and security objects) to DRF PRs as Tom has indicated he wants to wait to see what implementations happen before making too many more changes there. I can look at doing that now and, in general, shrinking this into a more manageable PR.

Thanks for the snapshottest pointer.

Removing DRF 3.9 support sounds good. Should we make a 3.0 feature branch here or just drop 3.9 from the master branch?

Let's simply drop DRF 3.9 support from master in another PR

Getting this when trying to run 'generateschema':

Traceback (most recent call last):
 File "./manage.py", line 24, in <module>
 execute_from_command_line(sys.argv)
 File "/code/.venv3/lib/python3.6/site-packages/django/core/management/__init__.py", line 381, in execute_from_command_line
 utility.execute()
 File "/code/.venv3/lib/python3.6/site-packages/django/core/management/__init__.py", line 375, in execute
 self.fetch_command(subcommand).run_from_argv(self.argv)
 File "/code/.venv3/lib/python3.6/site-packages/django/core/management/base.py", line 323, in run_from_argv
 self.execute(*args, **cmd_options)
 File "/code/.venv3/lib/python3.6/site-packages/django/core/management/base.py", line 364, in execute
 output = self.handle(*args, **options)
 File "/code/.venv3/lib/python3.6/site-packages/rest_framework/management/commands/generateschema.py", line 40, in handle
 schema = generator.get_schema(request=None, public=True)
 File "/code/.venv3/lib/python3.6/site-packages/rest_framework_json_api/schemas/openapi.py", line 290, in get_schema
 paths = self.get_paths(None if public else request)
 File "/code/.venv3/lib/python3.6/site-packages/rest_framework_json_api/schemas/openapi.py", line 340, in get_paths
 operation = view.schema.get_operation(path, method, action)
TypeError: get_operation() takes 3 positional arguments but 4 were given

Getting this when trying to run 'generateschema':

Traceback (most recent call last):
 File "./manage.py", line 24, in <module>
 execute_from_command_line(sys.argv)
 File "/code/.venv3/lib/python3.6/site-packages/django/core/management/__init__.py", line 381, in execute_from_command_line
 utility.execute()
 File "/code/.venv3/lib/python3.6/site-packages/django/core/management/__init__.py", line 375, in execute
 self.fetch_command(subcommand).run_from_argv(self.argv)
 File "/code/.venv3/lib/python3.6/site-packages/django/core/management/base.py", line 323, in run_from_argv
 self.execute(*args, **cmd_options)
 File "/code/.venv3/lib/python3.6/site-packages/django/core/management/base.py", line 364, in execute
 output = self.handle(*args, **options)
 File "/code/.venv3/lib/python3.6/site-packages/rest_framework/management/commands/generateschema.py", line 40, in handle
 schema = generator.get_schema(request=None, public=True)
 File "/code/.venv3/lib/python3.6/site-packages/rest_framework_json_api/schemas/openapi.py", line 290, in get_schema
 paths = self.get_paths(None if public else request)
 File "/code/.venv3/lib/python3.6/site-packages/rest_framework_json_api/schemas/openapi.py", line 340, in get_paths
 operation = view.schema.get_operation(path, method, action)
TypeError: get_operation() takes 3 positional arguments but 4 were given

Please share your INSTALLED_APPS from settings.py. I think this is because 'rest_framework_json_api' is not before 'rest_framework' per the updated documentation

Thanks for answering, but nope, my INSTALLED_APPS seem to be alright:

INSTALLED_APPS = [
 'django.contrib.admin',
 'django.contrib.auth',
 'django.contrib.contenttypes',
 'django.contrib.sessions',
 'django.contrib.messages',
 'django.contrib.staticfiles',
 'rest_framework_json_api',
 'rest_framework',
 # 'django_filters',
 # 'drf_yasg',
 'myapp'
]

If I put it in the wrong order, as you described, there's no error and it's just ignored. My REST_FRAMEWORK settings portion is straight from the linked docs, both serializers and views are imported from rest_framework_json_api.

@andrew-snek Sorry, I missed documenting a step. Now add here

Basically you need to make sure the DJA version of AutoSchema is used.

No need to be sorry, you're doing this for free and I'm grateful.

Now a question that technically goes beyond the scope of this pull request, but I think will be useful to many people: by chance, do you have any ideas how to make this work with drf-yasg - a package which autogenerates web ui for the schema? I see you've subclassed the schema generator in this PR, and now stuff like this fails with 403; permission_classes which allow everything seem to be ignored:

from rest_framework import permissions
from drf_yasg.views import get_schema_view
from drf_yasg import openapi
schema_view = get_schema_view(
 openapi.Info(
 title="My API",
 default_version='v1',
 ),
 public=True,
 permission_classes=(permissions.AllowAny,),
)
from rest_framework_json_api.renderers import JSONRenderer
from rest_framework_json_api.schemas.openapi import SchemaGenerator
class CustomSchemaView(schema_view):
 generator_class = SchemaGenerator
 renderer_classes = (JSONRenderer,)
 permission_classes = (permissions.AllowAny,)
url_patterns = [
 url(r'^swagger/$', CustomSchemaView.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
 #...
]

@andrew-snek Sorry, I didn't even know drf-yasg was a thing but I see it is limited to Swagger 2 (OAS 2.0): "Generate real Swagger/OpenAPI 2.0 specifications..."

This generateschema code generates OAS 3.0, specifically extending the support in DRF to document the JSON:API format for requests and responses.

See an example of using this stuff (in an early pre-release form) here. This looks to be doing the same thing as drf-yasg.

great work! it will be in v3.0?

@auvipy Still needs some more stuff cleaned up per @sliverc -- specifically pulling the security and securitySchemes out and submitting those to DRF where they belong.

@sliverc I've rebased. Can you take another look please?

Hi, sorry I disappeared. I'm trying to run generateschema now, I got some errors and reading the thread I fixed some of them, also some were in my code (getting stuff from self.request in some views was breaking, so I added some getattrs and it did the job. I'm still getting this, however:

Traceback (most recent call last):
 File "manage.py", line 30, in <module>
 execute_from_command_line(sys.argv)
 File "/usr/local/lib/python3.7/site-packages/django/core/management/__init__.py", line 381, in execute_from_command_line
 utility.execute()
 File "/usr/local/lib/python3.7/site-packages/django/core/management/__init__.py", line 375, in execute
 self.fetch_command(subcommand).run_from_argv(self.argv)
 File "/usr/local/lib/python3.7/site-packages/django/core/management/base.py", line 323, in run_from_argv
 self.execute(*args, **cmd_options)
 File "/usr/local/lib/python3.7/site-packages/django/core/management/base.py", line 364, in execute
 output = self.handle(*args, **options)
 File "/usr/local/lib/python3.7/site-packages/rest_framework/management/commands/generateschema.py", line 40, in handle
 schema = generator.get_schema(request=None, public=True)
 File "/usr/local/lib/python3.7/site-packages/rest_framework/schemas/openapi.py", line 64, in get_schema
 paths = self.get_paths(None if public else request)
 File "/usr/local/lib/python3.7/site-packages/rest_framework/schemas/openapi.py", line 47, in get_paths
 operation = view.schema.get_operation(path, method)
 File "/usr/local/lib/python3.7/site-packages/rest_framework_json_api/schemas/openapi.py", line 466, in get_operation
 parameters += self._get_filter_parameters(path, method)
 File "/usr/local/lib/python3.7/site-packages/rest_framework/schemas/openapi.py", line 187, in _get_filter_parameters
 parameters += filter_backend().get_schema_operation_parameters(self.view)
 File "/usr/local/lib/python3.7/site-packages/rest_framework_json_api/django_filters/backends.py", line 135, in get_schema_operation_parameters
 for res in super(DjangoFilterBackend, self).get_schema_operation_parameters(view):
AttributeError: 'super' object has no attribute 'get_schema_operation_parameters'

@n2ygk I've updated django-filters from 2.1.0 to 2.2.0 and made a few other changes and the generateschema command is now working :)

I'm still getting some errors in the Swagger UI though. This one appears multiple times:

😱 Could not render ParameterRow, see the console.

In the terminal where I ran the swagger-ui-watcher command, I don't see anything. In the UI page I see a red error section at the top of the page with a lot of error messages, too many to post here, but the first few look like this:

Errors
Hide
 
Schema error should NOT have additional properties
additionalProperty: Loading
Jump to line 0
Schema error at paths['/api/v1/user-profiles/'].put
should have required property 'responses'
missingProperty: responses
Jump to line 0
Schema error at paths['/api/v1/organizations/{organization_id}/members/{id}/'].put
should have required property 'responses'
missingProperty: responses
Jump to line 0
Schema error at paths['/api/v1/organizations/invites/{id}/'].put
should have required property 'responses'
missingProperty: responses
Jump to line 0
Schema error at paths['/api/v1/organizations/{id}/'].put
should have required property 'responses'
missingProperty: responses
Jump to line 0
Schema error at paths['/api/v1/documents/{id}/'].put
should have required property 'responses'
missingProperty: responses
Jump to line 0

Per #697 I'll be rebasing this to undo 29eb776 and d43f7ca.

hope to see this in soon

@n2ygk - Will you be able to address the issues raised by @sliverc ? If not, we need this, so happy to take over.

Please do take over!
...
On Thu, Feb 13, 2020 at 5:30 AM Kieran Evans @.***> wrote: @n2ygk <@n2ygk> - Will you be able to address the issues raised by @sliverc <@sliverc> ? If not, we need this, so happy to take over. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#689?email_source=notifications&email_token=ABBHS55K5XITFUFQV3WDTGTRCUONZA5CNFSM4ILE7AL2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOELUHBJQ#issuecomment-585658534>, or unsubscribe <github.com/notifications/unsubscribe-auth/ABBHS5ZOKDJHT4O2K3E2ZMTRCUONZANCNFSM4ILE7ALQ> .

Can do. Any notes to pass on?
The main issue I see with the output currently is that these don't resolve -

 - $ref: '#/components/parameters/include'
 - $ref: '#/components/parameters/fields'
 - $ref: '#/components/parameters/sort'

Will also need to bring things in line with the latest release of this lib.

Closing in favor of #772