Skip to content

OpenAPI3 proposal for enhancements/fixes #7089

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 8 commits into from
Closed

OpenAPI3 proposal for enhancements/fixes #7089

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b135e0f
add options to generateschema & prevent yaml aliases
Dec 9, 2019
9486df8
refactor/extend/improve OpenApi3 spec generation
Dec 11, 2019
d24a15f
first fixes to openapi3 tests
Dec 13, 2019
1535ee2
improvement: add operationId override to @extend_schema; fix tags
Dec 13, 2019
d8c6821
integer primary key, doc, cleanup, lint, test
Dec 13, 2019
a8a90d9
fix test
Dec 14, 2019
ca99e0a
fix test list ordering
Dec 14, 2019
62cd77e
bugfix: proper subclass-save retrieval of perms and auth classes
Dec 16, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion rest_framework/management/commands/generateschema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,15 @@ def get_mode(self):
def add_arguments(self, parser):
parser.add_argument('--title', dest="title", default='', type=str)
parser.add_argument('--url', dest="url", default=None, type=str)
parser.add_argument('--api-version', dest="api_version", default=None, type=str)
parser.add_argument('--description', dest="description", default=None, type=str)
if self.get_mode() == COREAPI_MODE:
parser.add_argument('--format', dest="format", choices=['openapi', 'openapi-json', 'corejson'], default='openapi', type=str)
else:
parser.add_argument('--format', dest="format", choices=['openapi', 'openapi-json'], default='openapi', type=str)
parser.add_argument('--urlconf', dest="urlconf", default=None, type=str)
parser.add_argument('--generator_class', dest="generator_class", default=None, type=str)
parser.add_argument('--file', dest="file", default=None, type=str)

def handle(self, *args, **options):
if options['generator_class']:
Expand All @@ -36,11 +38,17 @@ def handle(self, *args, **options):
title=options['title'],
description=options['description'],
urlconf=options['urlconf'],
version=options['api_version'],
)
schema = generator.get_schema(request=None, public=True)
renderer = self.get_renderer(options['format'])
output = renderer.render(schema, renderer_context={})
self.stdout.write(output.decode())

if options['file']:
with open(options['file'], 'wb') as f:
f.write(output)
else:
self.stdout.write(output.decode())

def get_renderer(self, format):
if self.get_mode() == COREAPI_MODE:
Expand Down
2 changes: 2 additions & 0 deletions rest_framework/renderers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1053,6 +1053,8 @@ def __init__(self):
assert yaml, 'Using OpenAPIRenderer, but `pyyaml` is not installed.'

def render(self, data, media_type=None, renderer_context=None):
# prevent polluting the output with yaml references (aliases)
yaml.Dumper.ignore_aliases = lambda *args: True
return yaml.dump(data, default_flow_style=False, sort_keys=False).encode('utf-8')


Expand Down
Loading