Forum Discussion

vmcg105's avatar
vmcg105
New Contributor
8 years ago

Cannot add "content" to the "responses"

When I try to the "content" under "responses" I get the error:

 

responses['200'] should NOT have additional properties additionalProperty: content, description

 

Even though I copied the code straight out of the Swagger example:

 

responses:
 200:
  description: "Got form"
   content:
    application/json:
     schema:
      type: object
      properties:
       id:
        type: integer
        description: The user ID.

 

It doesn't like the content field, what am I doing wrong?

  • Hi vmcg105,

     

    Is your spec in the OpenAPI 3.0 or Swagger 2.0 format?

     

    If you use OpenAPI 3.0, add quotes around "200" and make sure description and content have the indentation.

     

    If it's Swagger 2.0, use the following instead. See Describing Responses for more examples.

    paths:
      /something:
        get:
          produces:
            - application/json
          responses:
            200:
              description: "Got form"
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    description: The user ID.

     

  • HKosova's avatar
    HKosova
    SmartBear Alumni (Retired)

    Hi vmcg105,

     

    Is your spec in the OpenAPI 3.0 or Swagger 2.0 format?

     

    If you use OpenAPI 3.0, add quotes around "200" and make sure description and content have the indentation.

     

    If it's Swagger 2.0, use the following instead. See Describing Responses for more examples.

    paths:
      /something:
        get:
          produces:
            - application/json
          responses:
            200:
              description: "Got form"
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    description: The user ID.

     

  • vmcg105's avatar
    vmcg105
    New Contributor

    Is there a good example of the 3.0?

    When I switch my doc to point to 3.0 I get this:

    Schema error at swagger

    should be equal to one of the allowed values allowedValues: 2.0