Skip to content

make get_reference public #7515

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

Merged
merged 2 commits into from
Jun 6, 2022
Merged

make get_reference public #7515

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3cff589
make get_reference public
n2ygk Sep 2, 2020
240d9a0
Merge branch 'master' into public_get_reference
n2ygk May 17, 2021
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
5 changes: 5 additions & 0 deletions docs/api-guide/schemas.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,11 @@ Computes the component's name from the serializer.

You may see warnings if your API has duplicate component names. If so you can override `get_component_name()` or pass the `component_name` `__init__()` kwarg (see below) to provide different names.

#### `get_reference()`

Returns a reference to the serializer component. This may be useful if you override `get_schema()`.


#### `map_serializer()`

Maps serializers to their OpenAPI representations.
Expand Down
14 changes: 11 additions & 3 deletions rest_framework/schemas/openapi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -636,7 +636,7 @@ def get_response_serializer(self, path, method):
"""
return self.get_serializer(path, method)

def _get_reference(self, serializer):
def get_reference(self, serializer):
return {'$ref': '#/components/schemas/{}'.format(self.get_component_name(serializer))}

def get_request_body(self, path, method):
Expand All @@ -650,7 +650,7 @@ def get_request_body(self, path, method):
if not isinstance(serializer, serializers.Serializer):
item_schema = {}
else:
item_schema = self._get_reference(serializer)
item_schema = self.get_reference(serializer)

return {
'content': {
Expand All @@ -674,7 +674,7 @@ def get_responses(self, path, method):
if not isinstance(serializer, serializers.Serializer):
item_schema = {}
else:
item_schema = self._get_reference(serializer)
item_schema = self.get_reference(serializer)

if is_list_view(path, method, self.view):
response_schema = {
Expand Down Expand Up @@ -808,3 +808,11 @@ def _allows_filters(self, path, method):
RemovedInDRF314Warning, stacklevel=2
)
return self.allows_filters(path, method)

def _get_reference(self, serializer):
warnings.warn(
"Method `_get_reference()` has been renamed to `get_reference()`. "
"The old name will be removed in DRF v3.14.",
RemovedInDRF314Warning, stacklevel=2
)
return self.get_reference(serializer)