Styjun

What kind of world would drive brains to evolve high-throughput sensory?

What is the best word describing the nature of expiring in a short amount of time, connoting "losing public attention"?

how to add 1 milliseconds on a datetime string?

German phrase for 'suited and booted'

Do I care if the housing market has gone up or down, if I'm moving from one house to another?

If hash functions append the length, why does length extension attack work?

Origin of the suffix in hippocampus

Killing a star safely

Can a creature sustain itself by eating its own severed body parts?

Why are Oscar, India, and X-Ray (O, I, and X) not used as taxiway identifiers?

What is a "staved" town, like in "Staverton"?

Contact Search Results Address Type

Is the apartment I want to rent a scam?

Why did computer video outputs go from digital to analog, then back to digital?

Is an easily guessed plot twist a good plot twist?

Company requiring me to let them review research from before I was hired

How does mathematics work?

What's the 1 inch size square knob sticking out of wall?

How often should alkaline batteries be checked when they are in a device?

How can Kazakhstan perform MITM attacks on all HTTPS traffic?

Has Peter Parker ever eaten bugs?

High income and difficulty during interviews

Bounded Torsion, without Mazur’s Theorem

What does the following chess proverb mean: "Chess is a sea where a gnat may drink from and an elephant may bathe in."

django-rest-swagger nested serializers with readonly fields not rendered properly

Django REST framework: non-model serializerid field in django rest framework serializerHow can I apply a filter to a nested resource in Django REST framework?django-rest-framework and swagger api documentationDjango Rest Framework: Dynamically return subset of fieldsDoes django-rest-swagger not work well with modelserializers?read_only field in django rest serializer with unique_together contraintNested annotate fields in Django REST Framework serializersHow to specify a query parameter serializer in django-rest-swagger?Nested URL not showing in Django Rest Swagger

.everyoneloves__top-leaderboard:empty,.everyoneloves__mid-leaderboard:empty,.everyoneloves__bot-mid-leaderboard:empty margin-bottom:0;

6

I'm building an API with django-rest-framework and I started using django-rest-swagger for documentation.
I have a nested serializer with some read_only fields, like this:

# this is the nested serializer
class Nested(serializers.Serializer):
 normal_field = serializers.CharField(help_text="normal")
 readonly_field = serializers.CharField(read_only=True,
 help_text="readonly")

# this is the parent one
class Parent(serializers.Serializer):
 nested_field = Nested()

In the generated docs, nested serializers in the Parameters part of the page are rendered with field data type and no hint is given about its content, they are just like other fields.

Now you can see the problem there, as I would like to inform the user that there is a readonly field that should not be sent as part of the nested data but I can not see a way of doing so.

The ideal would be having a model description in Data Type column, just like the Response Class section.

Is there any proper way of doing so?

python django django-rest-framework documentation-generation

share|improve this question

asked Apr 27 '15 at 16:24

qwattashqwattash

64055 silver badges1212 bronze badges

add a comment | 

6

I'm building an API with django-rest-framework and I started using django-rest-swagger for documentation.
I have a nested serializer with some read_only fields, like this:

# this is the nested serializer
class Nested(serializers.Serializer):
 normal_field = serializers.CharField(help_text="normal")
 readonly_field = serializers.CharField(read_only=True,
 help_text="readonly")

# this is the parent one
class Parent(serializers.Serializer):
 nested_field = Nested()

In the generated docs, nested serializers in the Parameters part of the page are rendered with field data type and no hint is given about its content, they are just like other fields.

Now you can see the problem there, as I would like to inform the user that there is a readonly field that should not be sent as part of the nested data but I can not see a way of doing so.

The ideal would be having a model description in Data Type column, just like the Response Class section.

Is there any proper way of doing so?

python django django-rest-framework documentation-generation

share|improve this question

asked Apr 27 '15 at 16:24

qwattashqwattash

64055 silver badges1212 bronze badges

add a comment | 

I'm building an API with django-rest-framework and I started using django-rest-swagger for documentation.
I have a nested serializer with some read_only fields, like this:

# this is the nested serializer
class Nested(serializers.Serializer):
 normal_field = serializers.CharField(help_text="normal")
 readonly_field = serializers.CharField(read_only=True,
 help_text="readonly")

# this is the parent one
class Parent(serializers.Serializer):
 nested_field = Nested()

In the generated docs, nested serializers in the Parameters part of the page are rendered with field data type and no hint is given about its content, they are just like other fields.

Now you can see the problem there, as I would like to inform the user that there is a readonly field that should not be sent as part of the nested data but I can not see a way of doing so.

The ideal would be having a model description in Data Type column, just like the Response Class section.

Is there any proper way of doing so?

python django django-rest-framework documentation-generation

share|improve this question

asked Apr 27 '15 at 16:24

qwattashqwattash

64055 silver badges1212 bronze badges

# this is the nested serializer
class Nested(serializers.Serializer):
 normal_field = serializers.CharField(help_text="normal")
 readonly_field = serializers.CharField(read_only=True,
 help_text="readonly")

# this is the parent one
class Parent(serializers.Serializer):
 nested_field = Nested()

share|improve this question

asked Apr 27 '15 at 16:24

qwattashqwattash

64055 silver badges1212 bronze badges

share|improve this question

asked Apr 27 '15 at 16:24

qwattashqwattash

64055 silver badges1212 bronze badges

asked Apr 27 '15 at 16:24

qwattashqwattash

64055 silver badges1212 bronze badges

asked Apr 27 '15 at 16:24

qwattashqwattash

64055 silver badges1212 bronze badges