Cant see scroll menu when working with enum

Question

I want to define enum in openAPI.

I looked at this post:

How to define an enum in OpenAPI (Swagger)?

and I want to be able to see the enum like:

I'm working with components and I define it as:

components:
  
  schemas:
  
    FilterImg:
      type: object
      properties:
          name:
            type: string
            enum: ["img_1", "img_2"]
          value:
            type: string

And I'm using it:

post:
      summary: Add new img
      tags:
        - img
      description: Lets a user post a new img
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilterImg'
      responses:
        '200':
          description: Successfully

But I can't see the enum as enum scroll menu (in the web browser), as we can see it in the example.

What am I missing ?

What are you getting right now in output? Why you want to show enum in response? It will always show an object., and check your schema FilterImg you have defined its type: object so it will show in object view — turivishal
– turivishal, Commented Jul 2, 2020 at 5:41
Possible duplicate of Only first element of Enum list is displayed instead of Entire list in Swagger — Helen
– Helen, Commented Jul 2, 2020 at 13:18

turivishal · Accepted Answer · 2022-12-25 09:57:26Z

0

You are passing application/json in content type and you want enum dropdown how its possible?

You need to learn more about swagger from this documentation Swagger Docs and Openapi Specification,

Anyway i got an idea, you need this dropdown in body so here i have just added in application/x-www-form-urlencoded content type:

post:
  summary: Add new img
  tags:
    - img
  description: Lets a user post a new img
  requestBody:
    required: true
    content:
      application/x-www-form-urlencoded:
        schema:
          $ref: '#/components/schemas/FilterImg'
  responses:
    '200':
      description: Successfully

Remaining things will be same.

It will looks like:

edited Dec 25, 2022 at 9:57

answered Jul 2, 2020 at 10:48

turivishal

36.4k7 gold badges48 silver badges69 bronze badges

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

Comments

Helen · Accepted Answer · 2020-07-02 13:15:13Z

-1

In case of JSON/XML request and response bodies, the enum values for individual body fields are displayed in the schema documentation, that is on the Schema tab (or Model tab in case of OpenAPI 2.0).

Enum values for a JSON body field

answered Jul 2, 2020 at 13:15

Helen

99.8k18 gold badges280 silver badges352 bronze badges

1 Comment

turivishal Over a year ago

Dear @Helen, i respect you, the questioner need a scroll menu, for particular image choices or selection purpose, your pointed schema view will just view it will not allow to select particular choice, if i am wrong can you please explain how its my answer not useful?

Collectives™ on Stack Overflow

Cant see scroll menu when working with enum

2 Answers 2

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related