Swagger UI displaying array example as null

Question

I use OpenAPI 3.0.0 and want to pass an array of Items as a parameter in the requestBody. My API definition looks like this:

post:
  tags:
    - test
  summary: Test dummy
  operationId: requestBodyTests
  requestBody:
    description: test the body
    required: true
    content:
      application/json:
        schema:
          $ref: '#/components/schemas/Items'


components:
  schemas:
  Items:
    type: array
    items:
      $ref: '#/components/schemas/Item'
    examples:
      - id: bla
        text: blubb
    - id: bla
      text: blubb

  Item:
    type: object
    properties:
      id:
        type: string
      name:
        type: string

Swagger UI displays the request body example as follows:

and the request body schema as follows:

Why does it show an orderedmap instead of my normal objects?

Can someone tell me how to do the spec right for having the array with items correct?

Helen · Accepted Answer · 2018-01-30 16:05:04Z

1

Examples inside schemas use the example keyword (singular), not examples (plural).

Also, your YAML indentation is wrong - Items and Item must be indented under schemas, list items in the example must have the same indent, etc. If you paste your spec into http://editor.swagger.io, it will point out syntax errors.

Here's the fixed version:

components:
  schemas:
    Items:
      type: array
      items:
        $ref: '#/components/schemas/Item'
      example:   # <------
        - id: bla
          text: blubb
        - id: bla
          text: blubb

    Item:
      type: object
      properties:
        id:
          type: string
        name:
          type: string

answered Jan 30, 2018 at 16:05

Helen

99.8k17 gold badges280 silver badges352 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Elad Rubi · Accepted Answer · 2022-03-30 01:11:29Z

0

Moreover, you get an example as 'orderedmap' because the example field is A free-form property. But represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary. (OpenAPI spec)

We can write an example as 'string' in both ways:

1.

example: '[ currency: USD, amount: 123 ]'

  example: |
    [ 
      currency: USD, 
      amount: 123 
    ]

answered Mar 30, 2022 at 1:11

Elad Rubi

6435 silver badges7 bronze badges

Collectives™ on Stack Overflow

Swagger UI displaying array example as null

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related