CODEWITHSUNDEEP
javaswaggerswagger-ui
Mr Weirdo
Mr Weirdo

Reputation: 590

Required parameters in query are not marked in UI

I have marked in my yaml file paremeter:

     parameters:
     - name: someID
       in: query
       description: The some ID
       required: true
       schema:
        type: uuid

In generated java classes field is marked as required which is great, but on Swagger UI unfortunately not. It is problematic, because I would like to inform user before fail request that this file is required.

Upvotes: 0

Views: 235

Answers (1)

Helen
Helen

Reputation: 97540

In OpenAPI 2.0 (swagger: '2.0'), query parameters do not use schema and use the type keyword directly. Note that there's no type: uuid, instead you need type: string + format: uuid:

parameters:
  - name: someID
    in: query
    description: The some ID
    required: true
    type: string
    format: uuid

Swagger UI indicates required parameters by displaying a red * required note next to the parameter name:

How required parameter is indicated in Swagger UI

Upvotes: 1

Related Questions