OpenAPI.NET/test/Microsoft.OpenApi.Hidi.Tests/UtilityFiles/docWithReusableHeadersAndExamples.yaml at f67fe64e669a3f8518d89b007150c3e1bdb69fd1 · microsoft/OpenAPI.NET · 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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
openapi: 3.0.4
info:
  title: Example with Multiple Operations and Local $refs
  version: 1.0.0
servers:
- url: https://api.github.com
paths:
  /items:
    get:
      tags:
        - list.items
      operationId: getItems
      summary: Get a list of items
      responses:
        '200':
          description: A list of items
          headers:
            x-custom-header:
               $ref: '#/components/headers/CustomHeader'
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
              examples:
                ItemExample:
                  $ref: '#/components/examples/ItemExample'
    post:
      operationId: createItem
      summary: Create a new item
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
              example:
                $ref: '#/components/examples/ItemExample'
      responses:
        '201':
          description: Item created
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
              example:
                $ref: '#/components/examples/ItemExample'
components:
  schemas:
    pet:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        tag:
           type: string
  headers:
    CustomHeader:
      description: Custom header for authentication
      required: true
      schema:
        type: string
  examples:
    ItemExample:
      summary: Example of a new item to be created
      value:
        name: "New Item"