twilio-oai-generator/examples/test_spec/twilio_enum_v1.yaml at 959f58c1b31871f2136adf8aa185da5e6341b337 · twilio/twilio-oai-generator · 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
info:
  contact:
    email: support@twilio.com
    name: Twilio Support
    url: https://support.twilio.com
  description: This is the public Twilio REST API.
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://www.twilio.com/legal/tos
  title: Twilio - CONTENT
  version: 1.11.0
openapi: 3.0.1

paths:
  /v1/content:
    servers:
      - url: https://enum.twilio.com
    get:
      summary: Retrieve items with various filter options
      parameters:
        # PARAMETER_SINGLE
        - name: singleParam
          in: query
          description: A single enum value as a query parameter
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
            example: asc

        # PARAMETER_ARRAY
        - name: arrayParam
          in: query
          description: Order items using an array of enums
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - asc
                - desc
            example: [asc]

        # PARAMETER_ARRAY
        - name: arrayParamRef
          in: query
          required: false
          description: An array parameter referencing a reusable schema
          schema:
            type: array
            items:
              $ref: '#/components/schemas/singleReusable'

        - name: singleParamRef
          in: header
          schema:
            $ref: '#/components/schemas/singleReusable'

      responses:
        '200':
          description: A list of items
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Item'

components:
  schemas:
    Item:
      type: object
      properties:
        # PROPERTY_SINGLE
        singleProperty:
          type: string
          enum: [available, pending, sold]
          description: A single enum value as a property in a schema
          example: available

        # PROPERTY_ARRAY
        arrayProperty:
          type: array
          items:
            type: string
            enum: [new, sale, featured]
          description: An array of enum values in a schema property
          example: [new, featured]

        # REUSABLE_ARRAY
        arrayReusable:
          type: array
          items:
            $ref: '#/components/schemas/singleReusable'
          description: An array of reusable enum defined in components
          example: [electronics, clothing]

  # REUSABLE_SINGLE
    singleReusable:
      type: string
      enum: [electronics, furniture, clothing]
      description: A reusable single-value enum defined in components