Skip to content
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

Jump to bottom

Add PresentablePrimarKeyRelatedField schema for drf-exrta-fields blue… #957

Merged
merged 1 commit into from
Mar 7, 2023
Merged

Add PresentablePrimarKeyRelatedField schema for drf-exrta-fields blue… #957

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 20 additions & 0 deletions docs/blueprints/drf_extra_fields.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
from drf_spectacular.extensions import OpenApiSerializerFieldExtension
from drf_spectacular.openapi import AutoSchema
from drf_spectacular.plumbing import append_meta
from drf_spectacular.plumbing import build_basic_type
from drf_spectacular.types import OpenApiTypes
from drf_spectacular.utils import Direction


class Base64FileFieldSchema(OpenApiSerializerFieldExtension):
Expand All @@ -18,3 +21,20 @@ def map_serializer_field(self, auto_schema, direction):

class Base64ImageFieldSchema(Base64FileFieldSchema):
target_class = "drf_extra_fields.fields.Base64ImageField"


class PresentablePrimaryKeyRelatedFieldSchema(OpenApiSerializerFieldExtension):
target_class = 'drf_extra_fields.relations.PresentablePrimaryKeyRelatedField'

def map_serializer_field(self, auto_schema: AutoSchema, direction: Direction):
if direction == 'request':
return build_basic_type(OpenApiTypes.INT)

meta = auto_schema._get_serializer_field_meta(self.target, direction)
schema = auto_schema.resolve_serializer(
self.target.presentation_serializer(
context=self.target.context, **self.target.presentation_serializer_kwargs,
),
direction,
).ref
return append_meta(schema, meta)