JSON API examples in Swagger 2.0

Question

I'm trying to create example responses for an endpoint with Swagger 2.0.

    200:
      description: Successful response
      schema:
        type: object
        $ref: "#/definitions/User"
      examples:
        application/vnd.api+json:
            - data:
                attributes:
                  full_name: John Appleseed
            - data:
                attributes:
                  full_name: Mike Appleseed

My api consumes and produces application/vnd.api+json, but it won't recognize it. If I delete the examples, my spec works. Any idea how to specify it?

error

This is due to a bug that existed in the JSON Schema used for validation. While it's been fixed, it would take a few days until the editor is updated with it. — Ron
– Ron, Commented Aug 3, 2015 at 21:45

Saúl Martínez Vidals · Accepted Answer · 2015-07-29 01:24:15Z

9

It is not fully implemented yet, although you can define one single example like this:

   responses:
    "200":
      description: Successful response
      schema: 
        $ref: '#/definitions/User'
      examples:
        application/json:
          data:
            id: 1
            attributes:
              attr1: value1
              attr2: value2

there is one bug related with the mime-type, you cannot use dots thats why I did not put application/vnd.api+json

answered Jul 29, 2015 at 1:24

Saúl Martínez Vidals

6184 silver badges15 bronze badges

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

1 Comment

Brian Underwood Over a year ago

Couldn't you use quotes?

Collectives™ on Stack Overflow

JSON API examples in Swagger 2.0

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related