openapi-interfaces 0.4.0

Generate OpenAPI schemas for related GET, POST, PUT and JSON Merge Patch types
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

openapi: 3.1.0
info:
  title: Example OpenAPI definition
paths:
  /widgets:
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WidgetPost"
      responses:
        201:
          $ref: "#/components/responses/WidgetResponse"
  /widgets/{id}:
    patch:
      parameters:
        - name: dataset_id
          in: path
          description: The UUID of a dataset
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json+merge-patch:
            schema:
              $ref: "#/components/schemas/WidgetMergePatch"
        required: true
      responses:
        200:
          $ref: "#/components/responses/WidgetResponse"
        404:
          description: The requested ID was not found
          content: {}
components:
  responses:
    WidgetResponse:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Widget"
  schemas:
    ResourceStatus:
      type: string
      description: The current state of this resource.
      example: new
      enum:
        - new
        - updating
        - ready
        - error
    Widget:
      type: object
      title: "Widgetter"
      required:
        - created_at
        - id
        - metadata
        - sku
        - status
        - updated_at
        - vendor_id
      properties:
        id:
          type: string
          format: uuid
          example: "994fc99e-fa9f-454b-a3de-c1966ae61533"
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        status:
          $ref: "#/components/schemas/ResourceStatus"
        sku:
          type: string
        name:
          description: "The name of this widget."
          type: string
        vendor_id:
          type: string
          format: uuid
        metadata:
          $ref: "#/components/schemas/Metadata"
      additionalProperties: false
    WidgetPost:
      type: object
      title: "Widgetter"
      required:
        - metadata
        - sku
        - vendor_id
      properties:
        sku:
          type: string
        name:
          description: "The name of this widget."
          type: string
        vendor_id:
          type: string
          format: uuid
        metadata:
          $ref: "#/components/schemas/MetadataPost"
      additionalProperties: false
    WidgetPut:
      type: object
      title: "Widgetter"
      required:
        - metadata
      properties:
        name:
          description: "The name of this widget."
          type: string
        metadata:
          $ref: "#/components/schemas/MetadataPut"
      additionalProperties: false
    WidgetMergePatch:
      type: object
      title: "Widgetter"
      properties:
        name:
          description: "The name of this widget."
          oneOf:
            - type: string
              title: "Overwrite"
              description: "Pass this value to overwrite the existing value."
            - type: "null"
              title: "Clear"
              description: "Pass `null` to clear this field's existing value."
        metadata:
          $ref: "#/components/schemas/MetadataMergePatch"
      additionalProperties: false
    Metadata:
      type: object
      additionalProperties:
        type:
          - boolean
          - number
          - string
    MetadataPost:
      type: object
      additionalProperties:
        type:
          - boolean
          - number
          - string
    MetadataPut:
      type: object
      additionalProperties:
        type:
          - boolean
          - number
          - string
    MetadataMergePatch:
      type: object
      additionalProperties:
        type:
          - boolean
          - "null"
          - number
          - string