Swagger errors shows a need to define a parameter in the path or operation level

Question

I am getting the error below:

Declared path parameter "imageId" needs to be defined as a path parameter at either the path or operation level

This is the snapshot of my swagger definition

 '/api/v1/images/{unitnumber}/{type}/{imageId}':
        delete:
          tags:
            - Images
          summary: 'Summary'
          description: "Description"
          operationId: DeleteImage
          consumes: []
          produces:
            - application/json
          parameters:
            - name: unitnumber
              in: path
              required: true
              type: string
            - name: type
              in: path
              required: true
              type: string
            - name: imageId
              in: query
              required: false
              type: string
          responses:
            '400':
              description: Bad Request
              schema:
                $ref: '#/definitions/ErrorResponse'
            '401':
              description: Unauthorized
              schema:
                type: string
            '500':
              description: Server Error
              schema:
                $ref: '#/definitions/ErrorResponse'

I only can get rid of the error if I take the imageId and changing to path instead query which is not the intention

           - name: imageId
                  in: path
                  required: true
                  type: string

Any idea of what I need to change to have this working?

Related (or duplicate): Swagger API which is having query string — Helen
– Helen, Commented Jul 10, 2019 at 7:52

Helen · Accepted Answer · 2019-07-10 07:52:07Z

10

The path string /api/v1/images/{unitnumber}/{type}/{imageId} means that imageId is a path parameter so it must be in: path.

If imageId is supposed to be a query parameter, as in /api/v1/images/{unitnumber}/{type}?imageId=..., you need to change the path string to /api/v1/images/{unitnumber}/{type}. Query parameters should not be mentioned in paths, they are defined in the parameters section alone.

answered Jul 10, 2019 at 7:52

Helen

99.8k18 gold badges280 silver badges352 bronze badges

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

Comments

tisaksen · Accepted Answer · 2021-10-19 11:10:47Z

2

You have to declare a query parameter using a question mark as follows:

/api/v1/images/{unitnumber}/{type}/{?imageId}

answered Oct 19, 2021 at 11:10

tisaksen

3294 silver badges11 bronze badges

Comments

Patrick de Jong · Accepted Answer · 2023-04-21 12:09:07Z

0

(The question is not clear in the context of the question so:)

If you are using OpenAPI and in a C# context:

 [OpenApiParameter("imageId", In = ParameterLocation.Path, Required = true, Type = typeof(string), Description = "The image identifier")]

The error occurs in some pipelines that use OpenAPI. Place the code snippet above your Azure Function/ Endpoint / Controller and the error should be fixed.

answered Apr 21, 2023 at 12:09

Patrick de Jong

852 silver badges10 bronze badges

Collectives™ on Stack Overflow

Swagger errors shows a need to define a parameter in the path or operation level

3 Answers 3

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related