You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Structural error at paths.[path].get.responses.200
should have required property 'description'
missingProperty: description'
Note: The description should be added in schemas.openapi.AutoSchema._get_responses(), however I'm not sure what to put in there. An empty string does satisfy editor.swagger.io, but of course doesn't help much.
Should we put the serializer's docstring into the description? Would that make sense?
The text was updated successfully, but these errors were encountered:
Let's start by including it but leaving it as an empty string.
Putting something meaningful in there could then be left as a follow up.
Pull requests resolving this would be most welcome.
As per OpenAPI Spec, the
response
object must have adescription
property.Steps to reproduce
Generate a schema with
manage.py generateschema
and paste it into https://editor.swagger.org/Expected behavior
There should be no error message
Actual behavior
We get an error message
Note: The description should be added in
schemas.openapi.AutoSchema._get_responses()
, however I'm not sure what to put in there. An empty string does satisfy editor.swagger.io, but of course doesn't help much.Should we put the serializer's docstring into the description? Would that make sense?
The text was updated successfully, but these errors were encountered: