Ft/3803 multiple responses using one of attribute do not appear in ui #5530

VIIgit · 2019-08-14T21:40:35Z

Description

Display oneOf/anyOf schema in Example View.

Appears only on OAS3 specifications (obviously) and if an oneOf/anyOf structure is present on RequestBody or on Response
By default the first oneOf/anyOf item is shown to keep the UI noise at a minimum
Option to manually select oneOf/anyOf item
config option to switch feature on/off (showAlternativeSchemaExample: false)
- could be removed in case the feature becomes standard

    const ui = SwaggerUIBundle({
        ....
        showAlternativeSchemaExample: true,
        ...

Supports and covered with test cases

oneOf:
- of objects: example default: selects first item
- of primitive data types: example default: selects first item
- of arrays with oneOf subschemas: example default: selects first item
- of arrays of an object with an oneOf subschema: example default: object with first item of subschema
- uses discriminator's mapping values as example Swagger Inheritance and Polymorphism
anyOf:
- of objects: example default: selects first item
- of primitive data types: example default: selects first item
- of arrays with anyOf subschemas: all items are shown as example value
- of arrays of an object with an anyOf subschema: example default: object with first item of subschema
Not yet supported/considered:
- oneOf/anyOf of arrays of an object with an oneOf/anyOf subschema: all permutation of an oneOf/anyOf could be listed
- random selection or round-robin selection (is a bit non-deterministic and UI is leaner without)

Motivation and Context

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

How Has This Been Tested?

Swagger to demonstrate the feature

openapi: 3.0.1
info:
  title: OneOf examples
  license:
    name: Apache 2.0
    url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
  version: 1.0.0
servers: 
 - url: localhost
paths:

  /delivery-addresses/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    patch:
      summary: Update delivery address
      operationId: patchDeleiverAddress
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeliveryAddress'
          application/xml:
            schema:
              $ref: '#/components/schemas/DeliveryAddress'
      responses:
        '200':
          description: successful operation
          x-content:
            application/hal-form+json:
              schema:
                type: object
              x-schemaRef: '#/components/schemas/DeliveryAddress'

    get:
      summary: Read delivery address
      operationId: getDeliveryAddress
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryAddress'

components:
  schemas:
    DeliveryAddress:
      type: object
      title: Delivery Address
      description: OneOf Example
      properties:
        address:
          type: string
        city:
          type: string
        options:
          oneOf:
            - type: object
              title: Delivery Express
              required:
                - company
              properties:
                company:
                  type: string              
                shipping:
                  type: string
                  default: STANDARD
                  example: STANDARD
                  enum:
                    - FAST
                    - STANDARD
            - type: object
              title: Parcel Quick
              required:
                - company
              properties:
                company:
                  type: string
                remarks:
                  type: string
        options2:               
          anyOf:
            - type: object
              title: US
              properties:
                state:
                  type: string
                zipCode:
                  type: string
              required:
                - zipCode
                - state
            - type: object
              title: Europe
              properties:
                county:
                  type: string
                postCode:
                  type: string
              required:
                - postCode

Screenshots:

Checklist

My PR contains...

No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
Dependency changes (any modification to dependencies in package.json)
Bug fixes (non-breaking change which fixes an issue)
Improvements (misc. changes to existing features)
Features (non-breaking change which adds functionality)

My changes...

are breaking changes to a public API (config options, System API, major UI change, etc).
are breaking changes to a private API (Redux, component props, utility functions, etc.).
are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
are not breaking changes.

Documentation

My changes do not require a change to the project documentation.
My changes require a change to the project documentation.
If yes to above: I have updated the documentation accordingly.

Automated tests

My changes can not or do not need to be tested.
My changes can and should be tested by unit and/or integration tests.
If yes to above: I have added tests to cover my changes.
If yes to above: I have taken care to cover edge cases in my tests.
All new and existing tests passed.

re-synch

Resync

…ribute-do-not-appear-in-UI

AlexNik · 2019-09-11T16:45:15Z

Merge it please!

hannes-ucsc · 2019-09-12T04:34:20Z

Is this intended to only work with oneOf or anyOf as a child of a property definition like in the example above?

type: "object"
properties:
    "options":
        oneOf: 
            - …
            - …

oneOf/anyOf can appear at the top level of a schema, too.

type: "object"
oneOf:
    - …
    - …

VIIgit · 2019-09-13T19:38:46Z

oneOf/anyOf at the top level

openapi: 3.0.1
info:
  title: OneOf examples
  license:
    name: Apache 2.0
    url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
  version: 1.0.0
servers: 
 - url: localhost
paths:

  /delivery-addresses/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    patch:
      summary: Update delivery address
      operationId: patchDeleiverAddress
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeliveryAddress'
          application/xml:
            schema:
              $ref: '#/components/schemas/DeliveryAddress'
      responses:
        '200':
          description: successful operation
          x-content:
            application/hal-form+json:
              schema:
                type: object
              x-schemaRef: '#/components/schemas/DeliveryAddress'

    get:
      summary: Read delivery address
      operationId: getDeliveryAddress
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryAddress'

components:
  schemas:
    DeliveryAddress:
      oneOf:
      - type: object
        title: Online Delivery
        properties:
          email:
            type: string     
            example: [email protected] 
      - type: object
        title: Delivery Address
        description: OneOf Example
        properties:
          address:
            type: string
          city:
            type: string
          options:
            oneOf:
              - type: object
                title: Delivery Express
                required:
                  - company
                properties:
                  company:
                    type: string              
                  shipping:
                    type: string
                    default: STANDARD
                    example: STANDARD
                    x-oneOf:
                      - const: FAST
                        title: 24h + EUR 40
                      - const: STANDARD
                        title: 3-5 Days
              - type: object
                title: Parcel Quick
                required:
                  - company
                properties:
                  company:
                    type: string
                    x-const: PQ
                  remarks:
                    type: string
          options2:               
            oneOf:
              - type: object
                title: US
                properties:
                  state:
                    type: string
                  zipCode:
                    type: string
                required:
                  - zipCode
                  - state
              - type: object
                title: Europe
                properties:
                  county:
                    type: string
                  postCode:
                    type: string
                required:
                  - postCode

hannes-ucsc · 2019-09-14T06:56:34Z

Interesting. I tried your branch on my spec and couldn't get it to work. Is it because the children of my oneOf are $ref or because the parent schema has properties as well?

VIIgit · 2019-09-14T19:13:14Z

Interesting. I tried your branch on my spec and couldn't get it to work. Is it because the children of my oneOf are $ref or because the parent schema has properties as well?

Upps, interesting! I'll try to consider your scenario as well...

…to swagger-api-master

…ng-oneOf-attribute-do-not-appear-in-UI

This reverts commit b4ac5a9.

This reverts commit 03fb990.

Consider Element renaming

VIIgit · 2019-09-23T13:09:00Z

Interesting. I tried your branch on my spec and couldn't get it to work. Is it because the children of my oneOf are $ref or because the parent schema has properties as well?

Hi Hannes,

your use case works now too:

hannes-ucsc · 2019-09-23T19:21:18Z

Cool! What do you think about adding support for discriminator? With my spec this would eliminate the issue that the example value for integration_type does not change depending on the selected alternative.

Also noticed that for lists of documents whose schema has a oneOf, the examples only represent a partial set of properties.

The "manually selected" UI element also doesn't populate a list of alternatives but I'm not sure that is needed here. It may make more sense to simply select the first alternative for the first document, the second alternative for the second document and so on.

hannes-ucsc · 2019-09-23T19:23:00Z

The above screen shot is from the 200 response for the GET /portal/{portal_id}/integration path in my spec.

…ribute-do-not-appear-in-UI

miroslavKovacPantheon · 2020-05-06T14:06:21Z

Hi @shockey,

could you please look at this patch and give it some review so @VIIgit could finish it. Or merge it please if it is in a shape that it can go to this project.

Thank you

desponda · 2020-05-16T22:43:50Z

please look at this PR @shockey @webron

miroslavKovacPantheon · 2020-05-18T08:07:46Z

Hello

@desponda I am very greatfull for your review. It is finally moving along.

@VIIgit do you thing that now you would be able to move on to xml generation as well?

Thank you

webpro · 2020-05-18T09:38:08Z

@desponda I think I'm incorrectly mentioned here :-)

soberich · 2020-05-18T09:48:01Z

+1 for xml!
I've added syntax highlight in this PR from another PR in case anyone wants to play with it.
Please note! It has opionated index.html which suits my use case.

https://bintray.com/soberich/maven/com.github.soberich%3Aswagger-ui

eLvErDe · 2020-05-22T05:20:02Z

Great to see some activities around :-)

faraazbrcm · 2020-05-22T08:31:51Z

Hi @VIIgit Thanks for taking the time and implementing a solution for oneOf directive.
I have tested your PR. It seems to be working for some scenario of payload but not for some. One of the sample where it is not working is below

Not Working schema

patch_openconfig_system_system_ntp_servers: allOf: - type: object properties: openconfig-system:servers: type: object properties: server: type: array items: type: object required: - address properties: address: oneOf: - oneOf: - maxLength: 18446744073709551615 minLength: 0 type: string x-pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$ x-yang-type: string - maxLength: 18446744073709551615 minLength: 0 type: string x-pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$ && ^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))$ x-yang-type: string - maxLength: 253 minLength: 1 type: string x-length: 1..253 x-pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$ && ^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))$ && ((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\. x-yang-type: string config: type: object properties: address: oneOf: - oneOf: - maxLength: 18446744073709551615 minLength: 0 type: string x-pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$ x-yang-type: string - maxLength: 18446744073709551615 minLength: 0 type: string x-pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$ && ^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))$ x-yang-type: string - maxLength: 253 minLength: 1 type: string x-length: 1..253 x-pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$ && ^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))$ && ((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\. x-yang-type: string port: default: 123 format: int32 maximum: 65535 minimum: 0 type: integer x-yang-type: uint16 version: default: 4 format: int32 maximum: 4 minimum: 1 type: integer x-range: 1..4 x-yang-type: uint8 association-type: default: SERVER enum: - SERVER - PEER - POOL maxLength: 18446744073709551615 minLength: 0 type: string x-yang-type: string iburst: default: 'false' format: boolean type: boolean x-yang-type: boolean prefer: default: 'false' format: boolean type: boolean x-yang-type: boolean

Scenario where is it working

post_list_openconfig_system_system_ntp_servers_server: allOf: - type: object properties: openconfig-system:server: type: array items: type: object required: - address properties: address: oneOf: - oneOf: - maxLength: 18446744073709551615 minLength: 0 type: string x-pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$ x-yang-type: string - maxLength: 18446744073709551615 minLength: 0 type: string x-pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$ && ^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))$ x-yang-type: string - maxLength: 253 minLength: 1 type: string x-length: 1..253 x-pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$ && ^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))$ && ((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\. x-yang-type: string config: type: object properties: address: oneOf: - oneOf: - maxLength: 18446744073709551615 minLength: 0 type: string x-pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$ x-yang-type: string - maxLength: 18446744073709551615 minLength: 0 type: string x-pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$ && ^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))$ x-yang-type: string - maxLength: 253 minLength: 1 type: string x-length: 1..253 x-pattern: ^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$ && ^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))$ && ((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\. x-yang-type: string port: default: 123 format: int32 maximum: 65535 minimum: 0 type: integer x-yang-type: uint16 version: default: 4 format: int32 maximum: 4 minimum: 1 type: integer x-range: 1..4 x-yang-type: uint8 association-type: default: SERVER enum: - SERVER - PEER - POOL maxLength: 18446744073709551615 minLength: 0 type: string x-yang-type: string iburst: default: 'false' format: boolean type: boolean x-yang-type: boolean prefer: default: 'false' format: boolean type: boolean x-yang-type: boolean

VIIgit · 2020-05-22T10:08:27Z

Hi @faraazbrcm
could you provide me your example as OpenAPI or not as prose text? it's hard to read for humans ;)

…ribute-do-not-appear-in-UI

patrickelectric · 2020-07-28T15:42:52Z

Any plan to get this merged ? :)

…ribute-do-not-appear-in-UI

alex1987 · 2020-09-25T09:52:12Z

Any update on whether this could get merged? We came up against this limitation recently and it would be really nice to have this supported.

dylanhsieh · 2020-09-29T09:10:51Z

I really need this fix, please merge it.

ivanchurkin · 2020-10-03T13:03:29Z

ping

vincentchalamon · 2020-10-21T10:22:02Z

May also solve #6540

adammkelly · 2021-01-28T09:41:22Z

Any idea when this will merge?

hannes-ucsc · 2021-01-28T23:11:28Z

For goodness sake, maintainers, speak up!

If lack of XML support is holding this up, please reconsider. Who cares if this improvement is only available for JSON, not XML? Right now its implemented for neither so this would be a clear improvement. Omitting XML support does not accrue any new debt so insisting that it be added make no sense.

In my opinion.

JonFranchi · 2021-02-25T14:25:05Z

Are there any plans to merge and release this anytime soon?

hpl002 · 2021-03-18T09:53:53Z

Please supply us with an update on this.

The feature request has been dragging on for 3+ years...

soberich · 2021-03-18T16:27:26Z

They are probably too busy redistributing profits from becoming a specification still.

Maybe the phrase will get attention to get this merged )

dsych · 2021-05-11T14:44:37Z

@VIIgit it's sad to see this awesome work go to waste... have you considered turning this into a plugin instead of a base preset? then people would be able to actually use this without depending on swagger-ui

VIIgit · 2021-05-12T19:16:26Z

@VIIgit it's sad to see this awesome work go to waste... have you considered turning this into a plugin instead of a base preset? then people would be able to actually use this without depending on swagger-ui

Yes, I've started with a plugin, but it was not possible due to missing or not accessible context data within the plugin. So I've decided to fix it in the core.
I also believe a plugin could be beneficial, but I would need more context data to provide a perfect solution. To improve that is may be again waste of time.

dsych · 2021-05-12T19:54:51Z

@VIIgit it's sad to see this awesome work go to waste... have you considered turning this into a plugin instead of a base preset? then people would be able to actually use this without depending on swagger-ui

Yes, I've started with a plugin, but it was not possible due to missing or not accessible context data within the plugin. So I've decided to fix it in the core.
I also believe a plugin could be beneficial, but I would need more context data to provide a perfect solution. To improve that is may be again waste of time.

When you say "context data" what do you mean exactly?
Also I disagree that re-writing this as a plugin would be a waste of time if only judging by the number of comments on this PR :) People definitely want this feature, but I see how this would be discouraging for you given the state of this PR.

hannes-ucsc · 2021-05-13T01:14:47Z

I envy your patience, Erwin.

perry-autofi · 2021-06-08T00:42:12Z

+1
I'm having the same issue. Would love to see this merged.

KminekMatej · 2021-08-27T07:41:42Z

+1 , and dont undestand why this 3 yeas old bug isnt fixed, when there are clearly pull requests pending ..

RaffaeleSp · 2022-08-22T07:31:31Z

+1, is there any timeline for the above merge proposal?

Thank you

StephenOTT · 2023-11-21T16:17:00Z

+1

VIIgit and others added 6 commits August 9, 2019 16:47

Merge pull request #1 from swagger-api/master

7d17742

re-synch

Merge pull request #2 from swagger-api/master

f94f42c

Resync

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

e4d8a7d

lint-errors fixed

865a922

Merge branch 'master' into ft/3803-Multiple-responses-using-oneOf-att…

7faa035

…ribute-do-not-appear-in-UI

Merge branch 'master' into ft/3803-Multiple-responses-using-oneOf-att…

b642ce7

…ribute-do-not-appear-in-UI

VIIgit and others added 11 commits September 22, 2019 00:13

Consider oneOf/AnyOf on top level

8b07279

Move conflicting file

14cc22b

Merge branch 'master' of https://github.com/swagger-api/swagger-ui in…

ff2a6ff

…to swagger-api-master

Merge branch 'swagger-api-master' into ft/3803-Multiple-responses-usi…

64bcbd2

…ng-oneOf-attribute-do-not-appear-in-UI

Rename fn.js to fn-2.js

03fb990

Create fn.js

b4ac5a9

Revert "Create fn.js"

6cadd4c

This reverts commit b4ac5a9.

Revert "Rename fn.js to fn-2.js"

7ba60fc

This reverts commit 03fb990.

Adapt test for additional getConfigs check

62d48d6

Rename Element to Item

4a0abb3

Update fn.js

eaca85d

Consider Element renaming

VIIgit and others added 5 commits September 24, 2019 00:18

Simplify alternativeSchema

1c2ff55

alternative schema (oneOf/anyOf) with discriminator

7b5e94b

oneOf in arrays and improve oneOf item name

2252f39

eslint issues fixed

53ae729

Merge branch 'master' into ft/3803-Multiple-responses-using-oneOf-att…

78bab69

…ribute-do-not-appear-in-UI

desponda approved these changes May 16, 2020

View reviewed changes

Merge branch 'master' into ft/3803-Multiple-responses-using-oneOf-att…

05a7816

…ribute-do-not-appear-in-UI

Merge branch 'master' into ft/3803-Multiple-responses-using-oneOf-att…

658da1e

…ribute-do-not-appear-in-UI

vincentchalamon mentioned this pull request Oct 21, 2020

"anyOf" fields not reveal on doc request body api-platform/core#3773

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ft/3803 multiple responses using one of attribute do not appear in ui #5530

Ft/3803 multiple responses using one of attribute do not appear in ui #5530

VIIgit commented Aug 14, 2019 •

edited

Loading

AlexNik commented Sep 11, 2019

hannes-ucsc commented Sep 12, 2019

VIIgit commented Sep 13, 2019 •

edited

Loading

hannes-ucsc commented Sep 14, 2019 •

edited

Loading

VIIgit commented Sep 14, 2019

VIIgit commented Sep 23, 2019

hannes-ucsc commented Sep 23, 2019

hannes-ucsc commented Sep 23, 2019

miroslavKovacPantheon commented May 6, 2020

desponda commented May 16, 2020 •

edited

Loading

miroslavKovacPantheon commented May 18, 2020

webpro commented May 18, 2020

soberich commented May 18, 2020

eLvErDe commented May 22, 2020

faraazbrcm commented May 22, 2020 •

edited

Loading

VIIgit commented May 22, 2020

patrickelectric commented Jul 28, 2020

alex1987 commented Sep 25, 2020

dylanhsieh commented Sep 29, 2020

ivanchurkin commented Oct 3, 2020

vincentchalamon commented Oct 21, 2020

adammkelly commented Jan 28, 2021

hannes-ucsc commented Jan 28, 2021

JonFranchi commented Feb 25, 2021

hpl002 commented Mar 18, 2021

soberich commented Mar 18, 2021

dsych commented May 11, 2021

VIIgit commented May 12, 2021

dsych commented May 12, 2021

hannes-ucsc commented May 13, 2021

perry-autofi commented Jun 8, 2021

KminekMatej commented Aug 27, 2021

RaffaeleSp commented Aug 22, 2022

StephenOTT commented Nov 21, 2023

Ft/3803 multiple responses using one of attribute do not appear in ui #5530

Are you sure you want to change the base?

Ft/3803 multiple responses using one of attribute do not appear in ui #5530

Conversation

VIIgit commented Aug 14, 2019 • edited Loading

Description

Motivation and Context

How Has This Been Tested?

Screenshots:

Checklist

My PR contains...

My changes...

Documentation

Automated tests

AlexNik commented Sep 11, 2019

hannes-ucsc commented Sep 12, 2019

VIIgit commented Sep 13, 2019 • edited Loading

hannes-ucsc commented Sep 14, 2019 • edited Loading

VIIgit commented Sep 14, 2019

VIIgit commented Sep 23, 2019

hannes-ucsc commented Sep 23, 2019

hannes-ucsc commented Sep 23, 2019

miroslavKovacPantheon commented May 6, 2020

desponda commented May 16, 2020 • edited Loading

miroslavKovacPantheon commented May 18, 2020

webpro commented May 18, 2020

soberich commented May 18, 2020

eLvErDe commented May 22, 2020

faraazbrcm commented May 22, 2020 • edited Loading

VIIgit commented May 22, 2020

patrickelectric commented Jul 28, 2020

alex1987 commented Sep 25, 2020

dylanhsieh commented Sep 29, 2020

ivanchurkin commented Oct 3, 2020

vincentchalamon commented Oct 21, 2020

adammkelly commented Jan 28, 2021

hannes-ucsc commented Jan 28, 2021

JonFranchi commented Feb 25, 2021

hpl002 commented Mar 18, 2021

soberich commented Mar 18, 2021

dsych commented May 11, 2021

VIIgit commented May 12, 2021

dsych commented May 12, 2021

hannes-ucsc commented May 13, 2021

perry-autofi commented Jun 8, 2021

KminekMatej commented Aug 27, 2021

RaffaeleSp commented Aug 22, 2022

StephenOTT commented Nov 21, 2023

VIIgit commented Aug 14, 2019 •

edited

Loading

VIIgit commented Sep 13, 2019 •

edited

Loading

hannes-ucsc commented Sep 14, 2019 •

edited

Loading

desponda commented May 16, 2020 •

edited

Loading

faraazbrcm commented May 22, 2020 •

edited

Loading