Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Union types - description not displayed #590

Open
eNcacz opened this issue Jan 15, 2019 · 1 comment

Comments

Projects
None yet
2 participants
@eNcacz
Copy link

commented Jan 15, 2019

I have this sample RAML file:

#%RAML 1.0
title: Test Case
version: 1.0
mediaType: [ application/json ]

types:
  Obj1:
    type: object
    description: The Obj1 description
    properties:
      aaa:
        type: string
        description: The string

  Obj2:
    type: object
    description: The Obj2 description
    properties:
      bbb:
        type: number
        description: The number

  Obj3:
    type: object
    description: The Obj3 description
    properties:
      bbb:
        type: boolean
        description: The boolean

  UnionObjects: Obj1 | Obj2 | Obj3

/foo:
  get:
    responses:
      200:
        description: everything OK
        body:
          type: object
          description: The response body description
          properties:
            foo:
              type: UnionObjects[]

I expect that the description of the chosen union variant will be shown at the place to which the violet arrow points to.
The Obj1 is chosen in the screenshot so I expect the "The Obj1 description" text will be shown there.
screenshot
It will help to better describe the meaning of variants in the union type.

@jarrodek

This comment has been minimized.

Copy link
Contributor

commented Mar 5, 2019

Thank you for the issue report.
This makes sense. I will try to schedule it soon for development.

@jarrodek jarrodek self-assigned this Mar 5, 2019

@jarrodek jarrodek added the enhancement label Mar 5, 2019

@jarrodek jarrodek added this to the AC v6 milestone Mar 5, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.