name an array in swagger documentation

Question

trying to get a name of an array field to show up. trying to the following:

{
  history: []
}

and I have in my doc:

      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/historyList'

in definitions...

  historyList:
    type: array
    items:
      $ref: '#/definitions/History'  #my object of many values

I have tried the name on the schema level in the response, and in the array itself, and it always just comes through as "array". The swagger doc, there has to be something obvious I am missing on this.

Thanks

Limey · Accepted Answer · 2022-01-28 15:01:37Z

4

And, as always, I post a question and then figure it out 10 minutes later....

So, its not obvious, but here is how I named my array "history"

historyList:
  type: object
  properties:
    history:
      type: array
      items:
        $ref: '#/definitions/history'

So you need to put your array in an object and name the object.

answered Jan 28, 2022 at 15:01

Limey

2,7946 gold badges38 silver badges70 bronze badges

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

Collectives™ on Stack Overflow

name an array in swagger documentation

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related