Skip to content

Responses that use oneOf generate confusing documentation and examples #2721

@collimarco

Description

@collimarco

This issue is present when there is a responses schema that uses oneOf.

  1. Documentation generated by redoc doesn't show the description for the different responses (shows only "object", "object").
  2. 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions