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

# An example file which includes definitions from several external files.

openapi: "3.1.0"
info:
  title: Example OpenAPI definition
$includeFiles:
  - "paths.yml"
  - "core_components.yml"
paths: {}
components:
  interfaces:
    Widget:
      # Include all fields from `Resource`.
      $includes: "Resource"
      description: |
        A displayable widget.
      members:
        name:
          required: true
          mutable: true
          schema:
            type: string
        comment:
          mutable: true
          schema:
            type: string
        readonly:
          required: true
          # This can't be updated once the object is created.
          mutable: false
          # But we do allow this to be set at creation time.
          # If omitted, `initializable` defaults to the value
          # of the `mutable` option.
          initializable: true
          schema:
            type: string