Swagger throws "Swagger Error Not a valid parameter definition" for body parameter

swagger swagger-editor
EpicPandaForce picture EpicPandaForce · Apr 20, 2016 · Viewed 8.8k times · Source

This is my input:

  parameters:
    - name: body
      in:  body
      required: true
      type: object
      description: | 
        The body.
      schema:
        $ref: '#/definitions/CsrRequest'

And it says this:

Details

 Object
code:  "ONE_OF_MISSING"
message:  "Not a valid parameter definition"
 path: Array [5]
 inner: Array [2]
level: 900
type:  "Swagger Error"
description:  "Not a valid parameter definition"
lineNumber: 24

What am I doing wrong?

Answer

EpicPandaForce picture EpicPandaForce · Apr 20, 2016

You need to remove the type: object from the body as per this issue.

parameters:
  - name: body
    in:  body
    required: true
    description: | 
      The body.
    schema:
      $ref: '#/definitions/CsrRequest'

Related questions

How can I represent 'Authorization: Bearer <token>' in a Swagger Spec (swagger.json)

I am trying to convey that the authentication/security scheme requires setting a header as follows: Authorization: Bearer <token> This is what I have based on the swagger documentation: securityDefinitions: APIKey: type: apiKey name: Authorization in: header security: …

Read More
Swagger Editor multiple parameters in body

So I understand that if we want body parameters we have to have a schema, which I do. The issue is no matter how I try to define my schema it does not allow me to have multiple body parameters. …

Read More
How to format Swagger 2.0 text descriptions?

I would like to format my Swagger API descriptions so that they are not simple paragraphs of text. Preferably, I'd like to add a small table to it. I did not find an online reference about text formatting in Swagger …

Read More