How to describe nested request body in OpenAPI (Swagger) syntax?

1.2k Views Asked by At

I need to describe REST (json) api with OpenAPI (Swagger) syntax. I have stuck at the point when I need to describe nested request body. Please suggest how to make it, lets use as example the next nested request body:

{
   "pauses" : [
     {"name" : "PAUSING_AUTO"},
     {"name" : "NO_PAUSE_CRITERIA","Min" : 15},
     {"name" : "PREVENTED_PAUSE","Min" : 5},
     {"name" : "REVERT_TO_RUN"},
     {"name" : "RUNNING"}
    ]
}
1

There are 1 best solutions below

0
On BEST ANSWER

The following description would do:

pauses:
    type: "array"
    items:
      type: "object"
      required: 
        - name
      properties:
        name:
          type: "string"
        Min:
          type: "integer"