OpenApi - how to specify response json with unknown attribute names

Question

I have an API that returns rows of data based on a request. The rows are JSON elements containing name:value pairs. However, the attribute names (and datatypes of the values) need to be fluid and undefined in the spec.

For example:

{
    "row_id": 1234,
    "data": {
        "foo": "bar",
        "date": "2019-07-31",
        "some_number": 5
    }
 }

In this example, the attributes 'row_id' and 'data' are the only fixed things. All the name:values pairs inside the data element can be anything.

I believe I can use open api additionalProperties to describe this, but no examples I can find tell me how or confirm that this is correct.

Does anyone have an idea how to do this or can point me in the right direction?

Possible duplicate of Swagger editor dictionary parameter definition, Swagger complex response model with dynamic key value hash maps — Helen
– Helen, Commented Apr 23, 2020 at 6:23

Kevin Bedell · Accepted Answer · 2020-04-22 20:05:30Z

10

It looks like what I was looking for was:

    recordData:
      type: object
      additionalProperties: {}

type: object defines it as a general object, and additionalProperties: {} says the object contains properties that have not been specifically defined.

The docs I finally located also say that additionalProperties: true would also work.

answered Apr 22, 2020 at 20:05

Kevin Bedell

13.5k10 gold badges80 silver badges116 bronze badges

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

1 Comment

Kevin Bedell Over a year ago

above is all i had to do. i didn't have to specify json in particular. i believe the {} implies it in this situation

Collectives™ on Stack Overflow

OpenApi - how to specify response json with unknown attribute names

1 Answer 1

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related