How to define path and formData parameters for the same operation in OpenAPI 2.0?

Question

I have an image upload endpoint that looks like /test/{id}/relationships/image. I want to describe this endpoint using OpenAPI 2.0 (Swagger 2.0).

The endpoint has both path and formData parameters. I tried the following:

swagger: '2.0'
info:
  title: API
  version: 1.0.0
host: api.server.de
schemes:
  - https
produces:
  - application/json
paths:
  '/test/{id}/relationships/image':
    post:
      operationId: addImage
      consumes:
        - multipart/form-data
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
            format: int32
        - in: formData
          name: file
          type: file
          required: true
          description: The file to upload.
        - in: formData
          name: metadata
          type: string
          required: false
          description: Description of file contents.
      responses:
        '202':
          description: Uploaded

But Swagger Editor shows errors:

Schema error at paths['/test/{id}/relationships/image'].post.parameters[0].in should be equal to one of the allowed values allowedValues: body, header, formData, query Jump to line 17

Schema error at paths['/test/{id}/relationships/image'].post.parameters[0] should NOT have additional properties additionalProperty: schema, in, name, required Jump to line 17

What am I doing wrong?

Helen · Accepted Answer · 2017-08-06 16:49:17Z

17

In your path parameter, change

          schema:
            type: integer
            format: int32

to

          type: integer
          format: int32

In OpenAPI/Swagger 2.0, path, header, query and formData parameters use type directly, without a schema. The schema keyword is used for body parameters only.

answered Aug 6, 2017 at 16:49

Helen

99.8k17 gold badges280 silver badges352 bronze badges

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

3 Comments

JuKe Over a year ago

thank you very much, that's helps. it's weird because the docs said something different swagger.io/docs/specification/paths-and-operations look at the '/users/{id}:' example and on this example also it uses the schema paramter swagger.io/docs/specification/describing-parameters

Helen Over a year ago

Those docs are for OpenAPI 3.0, as indicated by the note at the top. The 2.0 versions are swagger.io/docs/specification/2-0/paths-and-operations/ and swagger.io/docs/specification/2-0/describing-parameters

Raj Over a year ago

Helped me though I wanted it in the reverse way :) I was on 3.0

Collectives™ on Stack Overflow

How to define path and formData parameters for the same operation in OpenAPI 2.0?

1 Answer 1

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related