encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-01-24 16:24:18 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fix OpenAPI path generation with common prefixes.

Browse Source 
Closes #6675. Closes #6823.
This commit is contained in:
Carlton Gibson 2019-07-20 21:01:00 +02:00 committed by Carlton Gibson
parent 30a21a98dc
commit e309a4f0b8
2 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
rest_framework/schemas/openapi.py
View File

@ -1,4 +1,5 @@
import warnings import warnings
from urllib.parse import urljoin
from django.core.validators import ( from django.core.validators import (
DecimalValidator, EmailValidator, MaxLengthValidator, MaxValueValidator, DecimalValidator, EmailValidator, MaxLengthValidator, MaxValueValidator,
@ -39,17 +40,18 @@ class SchemaGenerator(BaseSchemaGenerator):
# Only generate the path prefix for paths that will be included # Only generate the path prefix for paths that will be included
if not paths: if not paths:
return None return None
prefix = self.determine_path_prefix(paths)
if prefix == '/': # no prefix
prefix = ''
for path, method, view in view_endpoints: for path, method, view in view_endpoints:
if not self.has_view_permissions(path, method, view): if not self.has_view_permissions(path, method, view):
continue continue
operation = view.schema.get_operation(path, method) operation = view.schema.get_operation(path, method)
subpath = path[len(prefix):] # Normalise path for any provided mount url.
result.setdefault(subpath, {}) if path.startswith('/'):
result[subpath][method.lower()] = operation path = path[1:]
path = urljoin(self.url or '/', path)
result.setdefault(path, {})
result[path][method.lower()] = operation
return result return result

2
tests/schemas/test_openapi.py
View File

@ -247,7 +247,7 @@ class TestGenerator(TestCase):
url(r'^example/?$', views.ExampleListView.as_view()), url(r'^example/?$', views.ExampleListView.as_view()),
url(r'^example/{pk}/?$', views.ExampleDetailView.as_view()), url(r'^example/{pk}/?$', views.ExampleDetailView.as_view()),
] ]
generator = SchemaGenerator(patterns=patterns, url='/api/') generator = SchemaGenerator(patterns=patterns, url='/api')
generator._initialise_endpoints() generator._initialise_endpoints()
paths = generator.get_paths() paths = generator.get_paths()