Skip to content

Serializers

DetailSerializer

Bases: OpenApiSerializer

To show in spec responses like this {detail: text}.

Source code in saritasa_drf_tools/open_api/serializers.py 
24
25
26
27
class DetailSerializer(OpenApiSerializer):
    """To show in spec responses like this {detail: text}."""

    detail = serializers.CharField(help_text="Message from backend")

OpenApiSerializer

Bases: Serializer

Serializer that should be used for customizing open_api spec.

Made to avoid warnings about unimplemented methods

Source code in saritasa_drf_tools/open_api/serializers.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
class OpenApiSerializer(serializers.Serializer):
    """Serializer that should be used for customizing open_api spec.

    Made to avoid warnings about unimplemented methods

    """

    def create(self, validated_data: dict[str, typing.Any]) -> typing.Any:
        """Made to avoid warnings about unimplemented methods."""

    def update(
        self,
        instance: typing.Any,
        validated_data: dict[str, typing.Any],
    ) -> typing.Any:
        """Made to avoid warnings about unimplemented methods."""

create(validated_data)

Made to avoid warnings about unimplemented methods.

Source code in saritasa_drf_tools/open_api/serializers.py 
13
14
def create(self, validated_data: dict[str, typing.Any]) -> typing.Any:
    """Made to avoid warnings about unimplemented methods."""

update(instance, validated_data)

Made to avoid warnings about unimplemented methods.

Source code in saritasa_drf_tools/open_api/serializers.py 
16
17
18
19
20
21
def update(
    self,
    instance: typing.Any,
    validated_data: dict[str, typing.Any],
) -> typing.Any:
    """Made to avoid warnings about unimplemented methods."""