Multiple responses using oneOf attribute do not appear in UI #3803

danr1979 · 2017-10-23T13:08:32Z

Q	A
Bug or feature request?	Bug
Which Swagger/OpenAPI version?
Which Swagger-UI version?
How did you install Swagger-UI?
Which browser & version?
Which operating system?

Demonstration API definition

responses:
  '200':
    description: OK
    content:
      application/json:
        schema:
          oneOf:
            - $ref: '#/components/schemas/AuthorisationResponse'
            - $ref: '#/components/schemas/ForbiddenResponse'

Configuration (browser query string, constructor, config.yaml)

constructorConfig contains just the default values.

Expected Behavior

Since I have two schemas passed in as a $ref to the 200 response I would expect to see two schemas in the Swagger UI application.

Current Behavior

Instead I see only the reference to the 200 response and its description with no example responses displayed as JSON in the black boxes.

Possible Solution

Context

webron · 2017-10-23T17:07:05Z

You've left out a bunch of details from the table - please fill them in.

We also need a full API definition - we can't really test the issue with the snippet you provided.

mrichar1 · 2017-11-03T18:21:13Z

The following spec shows nothing in the responses section of the UI - replacing the oneOf section with just an object containing either of the refs and it works fine.

Q	A
Bug or feature request?	Bug
Which Swagger/OpenAPI version?	3.0.0
Which Swagger-UI version?	3.4.2
How did you install Swagger-UI?	CDN (Cloudflare)
Which browser & version?	firefox 56/Chromium 62
Which operating system?	Linux (Ubuntu 16.04.3

openapi: 3.0.0
info:
  contact:
    email: [email protected]
    name: No Name
  description: Example API
  version: 0.0.2
  title: example
paths:
  "/test":
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                - "$ref": "#/definitions/foo"
                - "$ref": "#/definitions/bar"
definitions:
  foo:
    type: string
  bar:
    type: int

Zakini · 2017-11-20T13:16:46Z

Similar issue occurs when using oneOf for a request body.

Q	A
Bug or feature request?	Bug
Which Swagger/OpenAPI version?	3.0.0
Which Swagger-UI version?	which ever version is on editor.swagger.io
How did you install Swagger-UI?	using editor.swagger.io
Which browser & version?	Firefox 57.0
Which operating system?	macOS 10.12.6

openapi: 3.0.0
info:
  title: Test API
  version: 0.0.1
servers:
  - url: 'localhost:3000/api'
    description: Local API URL.
paths:
  /test:
    get:
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/a'
                - $ref: '#/components/schemas/b'
      responses:
        '200':
          description: OK
components:
  schemas:
    a:
      type: integer
    b:
      type: string

epetitje · 2017-11-27T14:52:47Z

Hello,

I have the exact same problem and this issue still exists in version 3.5.

Oleg-Arkhipov · 2017-12-02T18:45:51Z

I would be glad to see this implemented too. In the current state using multiple responses is not really usable because documentation consumer has to dig into YAML/JSON to find out all this information.

crussell52 · 2018-01-08T17:29:17Z

@shockey I'm confused why this has been tagged as a Feature instead of Bug. According to the Specification, schema is listed as supporting anyOf, oneOf, and allOf.

crussell52 · 2018-01-09T15:47:32Z

Applying the oneOf to type within components/schema does not work around this problem.

components:
  responses:
    ...
    ServerWriteError:
      description: Write Failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServerWriteErrorResponse'

  schemas:
    ...
    ServerWriteErrorResponse:
      oneOf:
        - $ref: '#/components/schemas/PartialWriteError'
        - $ref: '#/components/schemas/BaseError'

You can sort of work around this by declaring type: object as a sibling to oneOf:

components:
  responses:
    ...
    ServerWriteError:
      description: Write Failed
      content:
        application/json:
          schema:
            oneOf:
            $ref: '#/components/schemas/ServerWriteErrorResponse'

  schemas:
    ...
    ServerWriteErrorResponse:
      type: object     # Workaround-ish
      oneOf:
        - $ref: '#/components/schemas/PartialWriteError'
        - $ref: '#/components/schemas/BaseError'

OR In the referenced schema component

components:
 responses:
    ...
    ServerWriteError:
      description: Write Failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServerWriteErrorResponse'

  schemas:
    ...
    ServerWriteErrorResponse:
      type: object
      oneOf:
        - $ref: '#/components/schemas/PartialWriteError'
        - $ref: '#/components/schemas/BaseError'

The work-around isn't great because it puts an empty object in the response example (which is shown by default), but at least consumers can see the relevant models:

shockey · 2018-01-11T00:16:11Z

Hey @crussell52, I tagged it as a feature because Swagger-UI hasn't/doesn't support oneOf responses, as opposed to there being an issue with how a oneOf responses implementation renders things.

In other news... Work on this stalled (clearly), I'm going to do my best to circle back in January.

crussell52 · 2018-01-11T01:51:45Z

@shockey That makes sense... thanks for the clarification :)

vickysg0210 · 2018-01-24T02:00:07Z

I am facing the same issue. Using oneOf in requestBody is fine. You can not see the exact example but can still see the model. User can dig inside.

However, responses not working. :) Just to share

JinSung-Hwang · 2018-01-25T00:10:24Z

i`m facing the same issue

jasongonzales23 · 2018-02-01T02:22:33Z

+1

PavelStefanov · 2018-02-04T10:31:59Z

@shockey I want to fix this issue. But I don't know how to do. There are two cases:
1.

schema: 
  type: array 
  items:  
    oneOf:  
      - type: string  
      - type: integer

I can do like this

schema:
  oneOf:
  - $ref: '#/components/schemas/a'
  - $ref: '#/components/schemas/b'

components:
  schemas:
    a:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    b:
      type: array
      items:
        type: integer
        format: int64

I can do like this

Or something more complicated like in model tab? What do you think?

JinSung-Hwang · 2018-02-05T00:44:43Z

i want the 2 type

DustinOgan · 2018-02-12T02:43:14Z

of those I prefer the second one. Since we can name examples in the yaml, would it be a stretch to have
example1:
text box

example2:
text box

PavelStefanov · 2018-02-12T08:46:54Z

@DustinOgan this is just two different case for oneOf attribute, for array and for object, and example like I can do.

NeoDobby · 2018-02-16T09:44:37Z

For arrays I like the approach to have one example of each item type in the example array.
For objects, I think an approach like in the model tab seems appropriate to me.

mikefidel · 2018-02-27T17:00:59Z

I too wish to see some way for Models to display oneOf. It is used in my OpenAPI document. It's not used in a particularly critical API endpoint, but thumbs-up to anybody working on a solution.

rickyblaha · 2018-02-27T17:26:23Z

@mikefidel Models in Swagger UI does display oneOf now. We just recently migrated our docs from swagger 2 to open api 3 just for that reason. See this help page: https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/

mrichar1 · 2018-02-27T17:29:15Z

@rickyblaha The spec supports it, but not the UI (unless you're saying bug has been resolved in the UI code?)

mathis-m · 2020-09-04T23:18:20Z

Swagger ui should generate multiple examples for nested combined schemas as well.

For example:

openapi: 3.0.3
info:
  title: title
  version: 0.0.0
paths:
  /test:
    post:
      summary: test
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/nested'
      responses:
        200:
          description: OK
      operationId: test.post
components:
  schemas:
    nested:
      type: object
      properties:
        some: 
          type: string
        nestedProp:
          type: object
          anyOf:
            - $ref: '#/components/schemas/one'
            - $ref: '#/components/schemas/two'
    one:
      title: One
      type: object
      required:
        - name
      properties:
        name:
          type: string
          pattern: ^one$
      example: 
        name: one
    two:
      title: Two
      type: object
      required:
        - name
      properties:
        name:
          type: string
          pattern: ^two$
      example:
        name: two

is rendered like:

and should be rendered like:

openapi: 3.0.3
info:
  title: title
  version: 0.0.0
paths:
  /test:
    post:
      summary: test
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/nested'
            examples:
              nested_One:
                $ref: '#/components/examples/nested_One'
              nested_Two:
                $ref: '#/components/examples/nested_Two'
      responses:
        200:
          description: OK
      operationId: test.post
components:
  examples:
    nested_One:
      value: 
        some: string
        nestedProp:
          name: one
    nested_Two:
      value:
        some: string
        nestedProp:
          name: two
  schemas:
    nested:
      type: object
      properties:
        some: 
          type: string
        nestedProp:
          type: object
          anyOf:
            - $ref: '#/components/schemas/one'
            - $ref: '#/components/schemas/two'
    one:
      title: One
      type: object
      required:
        - name
      properties:
        name:
          type: string
          pattern: ^one$
      example: 
        name: one
    two:
      title: Two
      type: object
      required:
        - name
      properties:
        name:
          type: string
          pattern: ^two$
      example:
        name: two

ssm-shah · 2020-09-21T12:56:45Z

+1

jokaorgua · 2020-10-09T09:48:04Z

any news from maintainers regarding this issue?

NagoLazaro · 2021-02-22T18:13:07Z

Are there any updates from Swagger team regarding this functionality?

hpl002 · 2021-03-18T09:32:52Z

+1

raffig · 2021-06-24T09:31:44Z

Any news about this issue?

lsc-dotsource · 2021-09-17T07:19:24Z

considering the website of SwaggerUI claims "Complete OAS Support Complete OAS Support Visualize APIs defined in Swagger 2.0 or OAS 3.0" (https://swagger.io/tools/swagger-ui/) and oneOf, anyOf and allOf are clearly part of openApi 3, this should thus be re-categorized as a Bug, or the softwares description be corrected.

anthony-janocko · 2021-11-04T02:40:55Z

Any update here? Not working for subschemas in responses.

Laurianti · 2021-11-04T09:02:23Z

Any news?

jacobjmarks · 2021-11-11T02:44:12Z

I am having a similar issue here. See below an example spec in which I am attempting to describe a form which can accept one of two possible schemas:

openapi: 3.0.1
info:
  title: FooBar
  version: 1.0.0
paths:
  /foobar:
    post:
      summary: Summary
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              oneOf:
              - type: object
                properties:
                  Foo:
                    type: string
              - type: object
                properties:
                  Bar:
                    type: string
      responses:
        default:
          description: Description

Please note that the same issue occurs when using a requestBody/content type of multipart/form-data

This endpoint should expect to receive a body of either Foo= or Bar=.
This schema causes the following Swagger UI interface to be rendered:

This is not correct. It is representing the form as a JSON payload and causes invalid requests to be sent to the endpoint in which the Swagger UI is encoding each character as a separate form value. E.g. sending a value of hi would result in the body 0=h&1=i.

This same issue occurs when using anyOf.

When using allOf, however, a correct representation is rendered as below:

Are there any updates here regarding the support for such oneOf and anyOf usage? Alternatively; am I incorrectly defining my schema in some way to achieve such usage?

jaredbarranco · 2022-01-13T23:25:55Z

+1 to this - My scenario:
API client should expect return to contain array of objects who's underlying structure changes based on type fields that are optional query params.

Disregard above - I found a solution with current version:

  responses:
    '200':
      description: search results matching criteria
      content:
        application/json:
          schema:
            type: array
            items:
              oneOf:
                - $ref: '#/components/schemas/foo'
                - $ref: '#/components/schemas/bar'

tomasvts · 2022-02-04T15:48:02Z

If anyone is having this problem, I changed to using the latest 4.4.1 version from unpkg and it worked fine.
I'm using the standalone version like this:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Swagger API</title>
    <link rel="stylesheet" type="text/css" href="https://unpkg.com/[email protected]/swagger-ui.css">
</head>
<body>

<div id="swagger-ui"></div>

<script src="https://unpkg.com/[email protected]/swagger-ui-standalone-preset.js"></script>
<script src="https://unpkg.com/[email protected]/swagger-ui-bundle.js"></script>
<script>
    window.onload = function() {
        window.ui = SwaggerUIBundle({
            url: "YOUR URL HERE",
            dom_id: '#swagger-ui',
            deepLinking: true,
            presets: [
                SwaggerUIBundle.presets.apis,
                SwaggerUIStandalonePreset
            ],
            plugins: [
                SwaggerUIBundle.plugins.DownloadUrl
            ],
        })
    }
</script>
</body>
</html>

EladG77 · 2022-04-19T12:45:50Z

Any news about this?

tomasvts · 2022-04-19T12:49:40Z

Try updating to the last version

…

On Tue, Apr 19, 2022 at 7:46 AM EladG77 ***@***.***> wrote: Any news about this? — Reply to this email directly, view it on GitHub <#3803 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABBGPQJ2AETYFBGEQ63F4UDVF2TJBANCNFSM4EALH5VQ> . You are receiving this because you commented.Message ID: ***@***.***>

thiagomengue · 2022-06-09T17:55:15Z

Hello,

Does anyone have a solution or workaround ?
I'm using the swaggerapi/swagger-ui:v4.11.0 docker image but the problem persists....

ajith428 · 2022-07-22T16:16:42Z

Any update/workaround for the issue?

alecnmk · 2022-08-10T16:21:30Z

👋 the is a workaround I've found working and built a simple demo:
https://gitlab.com/alecnmk/openapi-swaggerui-multiple-response-examples-demo/-/blob/main/openapi.yaml#/default/get_products__id_

WellingtonSI · 2022-10-26T13:04:19Z

I'd like to thank alecnmk for the help with the code.

vpaflah · 2023-03-29T09:21:40Z

@jaredbarranco ' solution worked for me.

njmulsqb · 2023-04-12T16:09:32Z

I am also having this issue, @alecnmk solution worked partially, but anyOf is not working at all.
Using examples is not resolving the example content from YAML file properly.

Moro-Code · 2023-04-14T14:40:08Z

This issue should have been solved #5435 (comment)

ivanzigoni · 2024-07-11T15:04:22Z

👋 the is a workaround I've found working and built a simple demo: https://gitlab.com/alecnmk/openapi-swaggerui-multiple-response-examples-demo/-/blob/main/openapi.yaml#/default/get_products__id_

looks great but for anyone trying to use nestjs swagger module decorators, this unfortunately doesn't seem to apply

hkosova mentioned this issue Nov 2, 2017

Array items with oneOf schemas are rendered as null in examples #3859

Closed

shockey added version: 3.x specification: 3.x type: bug labels Dec 2, 2017

shockey self-assigned this Dec 4, 2017

shockey added this to the December 8, 2017 milestone Dec 4, 2017

shockey added type: feature and removed type: bug labels Dec 9, 2017

shockey mentioned this issue Jan 23, 2018

OAS 3.0 Support Backlog #3641

Open

22 tasks

MikeRalphson mentioned this issue Jan 24, 2018

response multi data model OAI/OpenAPI-Specification#1406

Closed

marisahoenig mentioned this issue Oct 23, 2020

API can accept VA identifiers department-of-veterans-affairs/notification-api#190

Closed

22 tasks

tschaffter mentioned this issue Nov 5, 2020

Add dataset, FHIR stores and annotations stores and related resources nlpsandbox/nlpsandbox-schemas#71

Merged

jacobjmarks mentioned this issue Nov 12, 2021

oneOf / anyOf usage with form-based content-type schema #7640

Open

Yokai1000 mentioned this issue Feb 8, 2022

Updated to newest version of Swagger UI Darmikon/swagger-ui-koa#1

Open

lightclient mentioned this issue May 8, 2022

Add Builder API schema ethereum/builder-specs#2

Merged

vpiskunov mentioned this issue Jun 15, 2023

swagger ui v5.0.0 nestjs/swagger#2469

Closed

1 task

jvcAdHoc mentioned this issue Nov 10, 2023

Fixup swagger docs department-of-veterans-affairs/va.gov-team#69743

Closed

paulsturgess mentioned this issue Nov 21, 2023

Expose error responses in the spec output apiaframework/apia-openapi#25

Merged

Multiple responses using oneOf attribute do not appear in UI #3803

Multiple responses using oneOf attribute do not appear in UI #3803

Comments

danr1979 commented Oct 23, 2017 • edited Loading

Demonstration API definition

Configuration (browser query string, constructor, config.yaml)

Expected Behavior

Current Behavior

Possible Solution

Context

webron commented Oct 23, 2017

mrichar1 commented Nov 3, 2017 • edited Loading

Zakini commented Nov 20, 2017

epetitje commented Nov 27, 2017

Oleg-Arkhipov commented Dec 2, 2017

crussell52 commented Jan 8, 2018

crussell52 commented Jan 9, 2018

shockey commented Jan 11, 2018 • edited Loading

crussell52 commented Jan 11, 2018

vickysg0210 commented Jan 24, 2018

JinSung-Hwang commented Jan 25, 2018

jasongonzales23 commented Feb 1, 2018

PavelStefanov commented Feb 4, 2018

JinSung-Hwang commented Feb 5, 2018 • edited Loading

DustinOgan commented Feb 12, 2018

PavelStefanov commented Feb 12, 2018

NeoDobby commented Feb 16, 2018

mikefidel commented Feb 27, 2018

rickyblaha commented Feb 27, 2018

mrichar1 commented Feb 27, 2018

mathis-m commented Sep 4, 2020

ssm-shah commented Sep 21, 2020

jokaorgua commented Oct 9, 2020

NagoLazaro commented Feb 22, 2021

hpl002 commented Mar 18, 2021

raffig commented Jun 24, 2021

lsc-dotsource commented Sep 17, 2021 • edited Loading

anthony-janocko commented Nov 4, 2021

Laurianti commented Nov 4, 2021

jacobjmarks commented Nov 11, 2021

jaredbarranco commented Jan 13, 2022 • edited Loading

tomasvts commented Feb 4, 2022 • edited Loading

EladG77 commented Apr 19, 2022

tomasvts commented Apr 19, 2022 via email

thiagomengue commented Jun 9, 2022

ajith428 commented Jul 22, 2022

alecnmk commented Aug 10, 2022

WellingtonSI commented Oct 26, 2022

vpaflah commented Mar 29, 2023

njmulsqb commented Apr 12, 2023

Moro-Code commented Apr 14, 2023

ivanzigoni commented Jul 11, 2024

danr1979 commented Oct 23, 2017 •

edited

Loading

mrichar1 commented Nov 3, 2017 •

edited

Loading

shockey commented Jan 11, 2018 •

edited

Loading

JinSung-Hwang commented Feb 5, 2018 •

edited

Loading

lsc-dotsource commented Sep 17, 2021 •

edited

Loading

jaredbarranco commented Jan 13, 2022 •

edited

Loading

tomasvts commented Feb 4, 2022 •

edited

Loading