redoc
redoc copied to clipboard
Responses that use oneOf generate confusing documentation and examples
This issue is present when there is a responses schema that uses oneOf.
- Documentation generated by redoc doesn't show the description for the different responses (shows only "object", "object").
- The code examples on the right, show only one of the possible responses (which is very confusing for a user reading the documentation). It would be more consistent to show a tab to select the different responses.
You can see an example here: https://github.com/pushpad/pushpad-openapi/blob/master/specification/resources/notifications/notifications_create.yml
Could you try to use title on the schemas instead of/in addition to description
The title is working correctly, but the description is ignored. As a workaround, if you have a discriminator field, you can set a description there for each variant.