How to declare query object in the parameters?

Question

I'm trying to define a query object in OpenAPI 3:

      parameters:
        - name: query
          in: query
          schema:
            type: object
            properties:
              id:
                type: number
            required:
              - id

But the example value and schema is not shown in Swagger UI.

Is there a bug or am I missing something?

Related: Use object type query param in Swagger documentation — Helen
– Helen, Commented Jan 13, 2021 at 10:12

Helen · Accepted Answer · 2021-01-13 10:11:32Z

2

Your definition is correct.

but example value and schema was not shown in swaager ui.

The example is actually shown, in the JSON key/value format:

{
  "id": 0
}

"Try it out" will serialize this parameter according to the defined serialization method, in this case as the ?id=<value> query string.

The issue with the schema not being displayed for query parameters of type: object is a known limitation, it's tracked here:
https://github.com/swagger-api/swagger-ui/issues/4581

answered Jan 13, 2021 at 10:11

Helen

99.8k17 gold badges280 silver badges352 bronze badges

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

Collectives™ on Stack Overflow

How to declare query object in the parameters?

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