How to define Object with multiple properties including an array of objects in OpenAPI?

Question

I am struggling to define a request body in OpenApi. I want to force the user to send me data in the following shape:

{
    "test": {
        "a": "a",
        "b": "b",
        "abc": [
            {
                "type": "abc",
                "name": "name"
            },
            {
                "type": "abc",
                "name": "name"
            }
            ...more
        ]
    }
}

This is what I tried but it does not seem to work:

 schemas:
    SampleRequest:
      required:
        - abc
      properties:
        abc: 
          $ref: "#/components/schemas/ABCType"

    ABCType:
      type: object
      required:
        - test
      properties: 
        test: 
          type: array 
          items:
            type: object
        properties: 
          type: 
            type: string
          name:
            type: string

Any help appreciated. Thank you

Related (or duplicate): How to define an array of another schema in OpenAPI 3? — Helen
– Helen, Commented Aug 12, 2020 at 19:59

BenceL · Accepted Answer · 2020-08-12 17:31:37Z

2

With the currect json I couldn't make such sense but created this. This created a json which replicates yours.

ABCType:
  type: object
  additionalProperties: false
  required: 
  - a
  - b
  - abc
  properties:
    a:
      description: A of ABCType
      type: string
    b:
      description: B of ABCType
      type: string
    abc:
      description: Array of ABCType
      type: array
      items:
        $ref: '#/components/schemas/ABCArrayValue'
ABCArrayValue:
  type: object
  additionalProperties: false
  required:
  - type
  - name
  properties:
    type:
      description: Type of this array value
      type: string
    name:
      description: Name of this array value
      type: string

answered Aug 12, 2020 at 17:31

BenceL

8446 silver badges14 bronze badges

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

Collectives™ on Stack Overflow

How to define Object with multiple properties including an array of objects in OpenAPI?

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related