How to define an array of objects in OpenAPI 3.0?

Question

I'm trying to add an object in an array, but this seems not be possible. I've tried the following, but I get always the error:

Property Name is not allowed.

This is shown for all items defined in the devices array. How can I define items in an array in OpenAPI?

  /demo/:
    post:
      summary: Summary
      requestBody:
        description: Description.
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                Name:
                  type: string
                Number:
                  type: array
                  items:
                    type: string
                description:
                  type: string
                type:
                  type: string
                devices:
                  type: array
                  items:
                    Name:
                      type: string
                    descripiton:
                      type: string
                    Number:
                      type: integer
                    enabled:
                      type: boolean
              required:
                - Name
                - Number
                - devices
      responses:
        '201': # status code
          description: Created.
        '500':
          description: Error.
        '405':
          description: Invalid body has been presented.

Related (or duplicate): Return an array of object in SwaggerHub — Helen
– Helen, Commented Sep 4, 2020 at 11:08

Helen · Accepted Answer · 2020-09-04 11:07:07Z

53

You need to add two extra lines inside items to specify that the item type is an object:

            devices:
              type: array
              items:
                type: object      # <----------
                properties:       # <----------
                  Name:
                    type: string
                  descripiton:
                    type: string
                  Number:
                    type: integer
                  enabled:
                    type: boolean

answered Sep 4, 2020 at 11:07

Helen

99.8k17 gold badges280 silver badges352 bronze badges

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

Comments

your sir · Accepted Answer · 2022-03-25 13:19:50Z

7

This is the array of objects with examples:

components:        
  schemas:
    abc:
      xml:
        wrapped : true    
        name: abc
      type: array
      items:
        type: object
        xml:
          name: 'item'
        properties: 
          Name:
            type: string
          age:
            type: integer
          enabled: 
            type: boolean
      example:
        - Name: no1
          age: 18
          enabled: true
        - Name: no2
          age: 20
          enabled: false

json

xml

edited Mar 25, 2022 at 13:19

answered Mar 25, 2022 at 10:20

your sir

711 silver badge3 bronze badges

2 Comments

OzzyCzech Over a year ago

actually, it's a much more accurate answer than most voted one

rh0x Over a year ago

@OzzyCzech only if you need xml, which is not the case of this question

Collectives™ on Stack Overflow

How to define an array of objects in OpenAPI 3.0?

2 Answers 2

Comments

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related