essentials-openapi/tests/res/example9-openapi.yaml at 034eaba1fd1451eba29d31957df1877d995c64b1 · Neoteroi/essentials-openapi · 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
---
openapi: 3.0.0
info:
  title: Header Ref Example
  version: v1
paths:
  /pets:
    get:
      summary: List all pets
      operationId: listPets
      tags:
        - Pets
      responses:
        "200":
          description: A paged array of pets
          headers:
            Current-Page:
              $ref: '#/components/headers/current-page'
            X-Rate-Limit:
              description: Rate limit per hour
              schema:
                type: integer
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                    name:
                      type: string
components:
  headers:
    current-page:
      description: The current page of total pages this response represents.
      example: '1'
      style: simple
      schema:
        type: string
      required: true