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

# AUTOMATICALLY GENERATED. DO NOT EDIT.
---
paths:
  /widgets:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WidgetPost"
        required: true
      responses:
        201:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Widget"
components:
  schemas:
    Widget:
      type: object
      description: |
        A displayable widget.
      required:
        - id
        - name
        - readonly
      properties:
        comment:
          type: string
        id:
          type: string
          example: e35a3c8d-5486-49ec-9b23-6747afc19570
          format: uuid
        name:
          type: string
        readonly:
          type: string
      additionalProperties: false
    WidgetMergePatch:
      type: object
      description: |
        (Parameters used to PATCH the `Widget` type.)

        A displayable widget.
      properties:
        comment:
          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."
        name:
          type: string
      additionalProperties: false
    WidgetPost:
      type: object
      description: |
        (Parameters used to POST a new value of the `Widget` type.)

        A displayable widget.
      required:
        - name
        - readonly
      properties:
        comment:
          type: string
        name:
          type: string
        readonly:
          type: string
      additionalProperties: false
    WidgetPut:
      description: |
        (Parameters used to PUT a value of the `Widget` type.)

        A displayable widget.
      type: object
      required:
        - name
      properties:
        comment:
          type: string
        name:
          type: string
      additionalProperties: false
info:
  title: Example OpenAPI definition
openapi: 3.1.0