Skip to content

Commit db7cae6

Browse files
committed
[OpenAPI] - Linting and Test updates
1 parent 4bda249 commit db7cae6

File tree

6 files changed

+19
-19
lines changed

6 files changed

+19
-19
lines changed

example/serializers.py

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ class TaggedItemDRFSerializer(drf_serilazers.ModelSerializer):
3333
"""
3434
DRF default serializer to test default DRF functionalities
3535
"""
36+
3637
class Meta:
3738
model = TaggedItem
3839
fields = ('tag',)
@@ -177,7 +178,6 @@ class JSONAPIMeta:
177178

178179

179180
class EntryDRFSerializers(drf_serilazers.ModelSerializer):
180-
181181
tags = TaggedItemDRFSerializer(many=True, read_only=True)
182182
url = drf_serilazers.HyperlinkedIdentityField(
183183
view_name='drf-entry-blog-detail',
@@ -194,7 +194,7 @@ class Meta:
194194
class AuthorTypeSerializer(serializers.ModelSerializer):
195195
class Meta:
196196
model = AuthorType
197-
fields = ('name', )
197+
fields = ('name',)
198198

199199

200200
class AuthorBioSerializer(serializers.ModelSerializer):
@@ -333,13 +333,9 @@ class CurrentProjectRelatedField(relations.PolymorphicResourceRelatedField):
333333
def get_attribute(self, instance):
334334
obj = super(CurrentProjectRelatedField, self).get_attribute(instance)
335335

336-
is_art = (
337-
self.field_name == 'current_art_project' and
338-
isinstance(obj, ArtProject)
339-
)
336+
is_art = (self.field_name == 'current_art_project' and isinstance(obj, ArtProject))
340337
is_res = (
341-
self.field_name == 'current_research_project' and
342-
isinstance(obj, ResearchProject)
338+
self.field_name == 'current_research_project' and isinstance(obj, ResearchProject)
343339
)
344340

345341
if is_art or is_res:

example/tests/snapshots/snap_test_openapi.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
snapshots = Snapshot()
99

1010
snapshots['test_path_without_parameters 1'] = '''{
11+
"description": "",
1112
"operationId": "List/authors/",
1213
"parameters": [
1314
{
@@ -182,6 +183,7 @@
182183
}'''
183184

184185
snapshots['test_path_with_id_parameter 1'] = '''{
186+
"description": "",
185187
"operationId": "retrieve/authors/{id}/",
186188
"parameters": [
187189
{
@@ -344,6 +346,7 @@
344346
}'''
345347

346348
snapshots['test_post_request 1'] = '''{
349+
"description": "",
347350
"operationId": "create/authors/",
348351
"parameters": [],
349352
"requestBody": {
@@ -576,6 +579,7 @@
576579
}'''
577580

578581
snapshots['test_patch_request 1'] = '''{
582+
"description": "",
579583
"operationId": "update/authors/{id}",
580584
"parameters": [
581585
{
@@ -802,6 +806,7 @@
802806
}'''
803807

804808
snapshots['test_delete_request 1'] = '''{
809+
"description": "",
805810
"operationId": "Destroy/authors/{id}",
806811
"parameters": [
807812
{

example/tests/test_serializers.py

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,17 @@
77
from rest_framework.request import Request
88
from rest_framework.test import APIRequestFactory
99

10-
from example.factories import ArtProjectFactory
1110
from rest_framework_json_api.serializers import (
1211
DateField,
1312
ModelSerializer,
1413
ResourceIdentifierObjectSerializer,
15-
empty,
14+
empty
1615
)
1716
from rest_framework_json_api.utils import format_resource_type
1817

18+
from example.factories import ArtProjectFactory
1919
from example.models import Author, Blog, Entry
20-
from example.serializers import (
21-
BlogSerializer,
22-
ProjectSerializer,
23-
ArtProjectSerializer,
24-
)
20+
from example.serializers import ArtProjectSerializer, BlogSerializer, ProjectSerializer
2521

2622
request_factory = APIRequestFactory()
2723
pytestmark = pytest.mark.django_db

example/urls.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
from rest_framework import routers
66
from rest_framework.schemas import get_schema_view
77

8+
from rest_framework_json_api.schemas.openapi import SchemaGenerator
9+
810
from example.views import (
911
AuthorRelationshipView,
1012
AuthorViewSet,
@@ -19,7 +21,6 @@
1921
ProjectTypeViewset,
2022
ProjectViewset
2123
)
22-
from rest_framework_json_api.schemas.openapi import SchemaGenerator
2324

2425
router = routers.DefaultRouter(trailing_slash=False)
2526

@@ -83,5 +84,5 @@
8384
import debug_toolbar
8485

8586
urlpatterns = [
86-
url(r'^__debug__/', include(debug_toolbar.urls)),
87-
] + urlpatterns
87+
url(r'^__debug__/', include(debug_toolbar.urls)),
88+
] + urlpatterns

requirements/requirements-testing.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ pytest==5.3.5
55
pytest-cov==2.8.1
66
pytest-django==3.8.0
77
pytest-factoryboy==2.0.3
8+
snapshottest==0.5.1

rest_framework_json_api/schemas/openapi.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -749,7 +749,8 @@ def _map_serializer(self, serializer):
749749
if field.default and field.default != empty:
750750
schema['default'] = field.default
751751
if field.help_text:
752-
schema['description'] = str(field.help_text) # Ensure django gettext_lazy is rendered correctly
752+
# Ensure django gettext_lazy is rendered correctly
753+
schema['description'] = str(field.help_text)
753754
self._map_field_validators(field, schema)
754755

755756
attributes[field.field_name] = schema

0 commit comments

Comments
 (0)