Variable query parameter names in OpenAPI

Question

Does anyone have an ideal how to model that in OpenAPI specification? :-/

https://api.example.de/search?facet=key1&facet=key2&key1=value1&key2=value2

key1, key2 etc. are given values from an enumeration. It there a way to describe them more detailed?

/search:
    get:
      parameters:
        - in: query
          name: facet
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - key1 # Description?
                - key2
        - in: query
          name: {facet_name}
          required: false
          ???

Is that the only solution:

/search:
    get:
      parameters:
        - in: query
          name: facet
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - key1 # Description ?
                - key2
        - in: query
          name: key1
          required: false
          schema:
            type: string
          description: Key1 is that...

did you manage to find any way of doing that?

idetyp
– idetyp

2020-09-01 12:58:47 +00:00
Commented Sep 1, 2020 at 12:58 — idetyp
– idetyp, Commented Sep 1, 2020 at 12:58

turivishal · Accepted Answer · 2020-06-25 12:51:09Z

1

All values in an enum must adhere to the specified type. If you need to specify descriptions for enum items, you can do this in the description of the parameter or property,

Description supports Markdown CommonMark for rich text representation, Like below example:

description: >
  **Your Title**:
    * `key1` - description for key1
    * `key2` - description for key2

It will look:

Hope this help.

answered Jun 25, 2020 at 12:51

turivishal

36.4k7 gold badges48 silver badges69 bronze badges

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

2 Comments

Michael Over a year ago

Thanks! It's better than nothing... ;-) Do you have any ideas about the variable-query-parameter thing?

turivishal Over a year ago

@michael, i am not getting, can you share example about variable-query-parameter

Collectives™ on Stack Overflow

Variable query parameter names in OpenAPI

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related