Swagger not rendering multiple schemas

Question

Below is a piece of code from a GET endpoint. The endpoint will return one of the schemas based on the 'subject' which is an input parameter to the endpoint.I want to display both the schemas and their field's definitions with example under defined response section on the documentation page. But I am not able to do that. My code shows below line:array[]The content depends on the subject.discriminator:&nbsp;{"propertyName":"subject","mapping":{"Schema_01":"#/components/schemas/Schema1","Schema_02":"#/components/schemas/Schema2"}}......content:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; description: The content depends on the subject.&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; type: array&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; items:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; oneOf:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; - $ref: '#/components/schemas/Schema1'&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; - $ref: '#/components/schemas/Schema2'&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; discriminator:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; propertyName: subject&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; mapping:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; Schema_01: '#/components/schemas/Schema1'&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; Schema_02: '#/components/schemas/Schema2'........Here are the schemas:components:&nbsp; schemas:Schema1:&nbsp; &nbsp; &nbsp; description: The content and the structure depends on the subject.&nbsp; &nbsp; &nbsp; type: object&nbsp; &nbsp; &nbsp; required:&nbsp; &nbsp; &nbsp; &nbsp; - subject&nbsp; &nbsp; &nbsp; properties:&nbsp; &nbsp; &nbsp; &nbsp; subject:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; type: string........Schema2:&nbsp; &nbsp; &nbsp; description: The content and the structure depends on the subject.&nbsp; &nbsp; &nbsp; type: object&nbsp; &nbsp; &nbsp; required:&nbsp; &nbsp; &nbsp; &nbsp; - subject&nbsp; &nbsp; &nbsp; properties:&nbsp; &nbsp; &nbsp; &nbsp; subject:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; type: string&nbsp;Please help me fix this.&nbsp;

frankkilcommins · Answer

Hi mtiwari176
Do you need to use discriminator here? If the goal is to just show examples of the different schemas to the consumer, then you could have:
      responses:
        '200':
          description: search results matching criteria
          content:
            application/json:
              schema:
                type: array
                items:
                  oneOf:
                    - $ref: '#/components/schemas/Schema1'
                    - $ref: '#/components/schemas/Schema2'
              examples:
                Schema1:
                  value:
                    subject: foo
                Schema2:
                  value:
                    subject: bar
This would then render as follows in SwaggerUI and allow a consumer to select the appropriate example and see the schemas:

&nbsp;

Forum Discussion

Swagger not rendering multiple schemas

1 Reply

Related Content

Swagger - Parameter not rendering

Error rendering output

Swagger UI endpoint path render

Stoplight not rendering arrays of refs?

swagger- specific_Api

Recent Discussions

Multiple path params not working

OPTIONS with no Authorization

NEED HELP WITH A PROJECT | Media type as urlencoded | Optional field

Swagger not rendering multiple schemas

Object in Query must be sent inline, not plain