sampleApiDocs/Arrays.yml at main · rtritean/sampleApiDocs · 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
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
openapi: 3.1.0
info:
  title: Array & Map Stress Test
  version: 1.0.0
  description: |
    Tests for **Array-in-Array**, **Object-in-Array**, and **Polymorphism** (oneOf, allOf, anyOf).
paths:
  /inventory/complex-demo:
    post:
      summary: Create a complex inventory record
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InventoryCreateRequest'
      responses:
        "201":
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseWrapper'
  /inventory/items:
    get:
      summary: List inventory items
      responses:
        "200":
          description: "OK"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Artifact"

components:
  schemas:
    # --- allOf Example ---
    # Combines the base Artifact properties with specific Restoration data
    Artifact:
      allOf:
        - $ref: '#/components/schemas/BaseObject'
        - type: object
          properties:
            restorationHistory:
              type: array
              items:
                type: string
                format: date

    BaseObject:
      type: object
      required: [id]
      properties:
        id:
          type: string
        name:
          type: string

    # --- oneOf Example ---
    # The payload MUST be exactly one of these types (Physical or Digital)
    InventoryItem:
      oneOf:
        - $ref: '#/components/schemas/PhysicalItem'
        - $ref: '#/components/schemas/DigitalItem'

    PhysicalItem:
      type: object
      required: [dimensions]
      properties:
        dimensions:
          type: string

    DigitalItem:
      type: object
      required: [fileSize]
      properties:
        fileSize:
          type: integer

    # --- anyOf Example ---
    # The response can be a success, a warning, or both (combined)
    ResponseWrapper:
      anyOf:
        - $ref: '#/components/schemas/InventoryCreateResponse'
        - $ref: '#/components/schemas/SystemWarning'

    InventoryCreateResponse:
      type: object
      required: [id, status]
      properties:
        id:
          type: string
        status:
          type: string

    SystemWarning:
      type: object
      properties:
        warningCode:
          type: string
        message:
          type: string

    InventoryCreateRequest:
      type: object
      required: [name, items]
      properties:
        name:
          type: string
        items:
          type: array
          items:
            $ref: '#/components/schemas/InventoryItem'