OpenAPI-Specification/tests/schema/pass/response-object-examples.yaml at 5cfd8fb496d342fc20212f3f8cbc8baf8e929577 · karenetheridge/OpenAPI-Specification · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
openapi: 3.3.0
info:
  title: API
  version: 1.0.0
components:
  responses:
    complex-object-array:
      summary: Complex object array
      description: A complex object array response
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/VeryComplexType'
    simple-string:
      description: A simple string response
      content:
        text/plain:
          schema:
            type: string
    plain-text-with-headers:
      description: A simple string response
      content:
        text/plain:
          schema:
            type: string
          example: 'whoa!'
      headers:
        X-Rate-Limit-Limit:
          description: The number of allowed requests in the current period
          schema:
            type: integer
        X-Rate-Limit-Remaining:
          description: The number of remaining requests in the current period
          schema:
            type: integer
        X-Rate-Limit-Reset:
          description: The number of seconds left in the current period
          schema:
            type: integer
    no-return-value:
      description: object created