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

# AUTOMATICALLY GENERATED. DO NOT EDIT.
---
openapi: 3.0.0
paths: {}
components:
  schemas:
    Polygon:
      type: object
      properties:
        name:
          type: string
          mutable: true
        number_of_sides:
          type: number
          mutable: true
    Widget:
      type: object
      required:
        - id
        - name
      properties:
        comment:
          type: string
        id:
          type: string
          example: e35a3c8d-5486-49ec-9b23-6747afc19570
        name:
          type: string
        shape:
          $ref: "#/components/schemas/Polygon"
      additionalProperties: false
      description: "A displayable widget.\n"
    WidgetMergePatch:
      type: object
      properties:
        comment:
          type: string
          nullable: true
        name:
          type: string
        shape:
          oneOf:
            - $ref: "#/components/schemas/Polygon"
          nullable: true
      additionalProperties: false
      description: "(Parameters used to PATCH the `Widget` type.)\n\nA displayable widget.\n"
    WidgetPost:
      type: object
      required:
        - name
      properties:
        comment:
          type: string
        name:
          type: string
        shape:
          $ref: "#/components/schemas/Polygon"
      additionalProperties: false
      description: "(Parameters used to POST a new value of the `Widget` type.)\n\nA displayable widget.\n"
    WidgetPut:
      type: object
      required:
        - name
      properties:
        comment:
          type: string
        name:
          type: string
        shape:
          $ref: "#/components/schemas/Polygon"
      additionalProperties: false
      description: "(Parameters used to PUT a value of the `Widget` type.)\n\nA displayable widget.\n"
info:
  title: Example OpenAPI definition