-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathopenapi.yaml
208 lines (208 loc) · 4.86 KB
/
openapi.yaml
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
openapi: 3.0.0
info:
version: 0.0.1
title: Some cool title
description: Awesome description
servers: []
paths:
/pets:
get:
description: Returns all pets from the system that the user has access to
operationId: GetUser
responses:
"200":
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Pet'
description: A list of pets.
"302":
content: {}
description: Trip Signals Redirection
headers:
Location:
description: The url to the signal API
schema:
type: string
tags:
- pet
parameters:
- in: path
name: deviceId
schema:
type: integer
enum:
- "3"
- "4"
required: true
description: Numeric ID of the user to get
security:
- petstore_auth:
- write:pets
- read:pets
servers:
- url: https://{environment}.hello.com
description: what up
variables:
environment:
default: api
enum:
- api
- api.dev
- api.staging
description: ""
externalDocs:
description: External documentation
url: https://{environment}-docs.hello.com
post:
description: Returns all pets from the system that the user has access to
responses:
"201":
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Pet'
description: Post a new pet
parameters: []
requestBody:
description: Pet to add to the store
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Pet'
components:
schemas:
AnonymousArray:
type: object
properties:
data:
type: array
items:
properties:
id:
type: string
type: object
AnyValue:
description: 'Can be anything: string, number, array, object, etc., including
`null`'
CustomString:
type: string
Dog:
allOf:
- $ref: '#/components/schemas/Pet'
- $ref: '#/components/schemas/WeirdCustomName'
- type: object
properties:
name:
type: string
EditableFoo:
type: object
properties:
string:
type: string
Foo:
type: object
properties:
string:
type: string
MapStringString: null
Pet:
required:
- string
type: object
properties:
ByteData:
type: string
format: binary
IntData:
type: object
additionalProperties:
type: integer
anonymous:
type: object
properties:
field:
type: string
children:
type: object
additionalProperties:
$ref: '#/components/schemas/Pet'
custom_string:
$ref: '#/components/schemas/CustomString'
enumTest:
type: string
enum:
- UNKNOWN
- MALE
- FEMALE
id:
type: string
example: f1dad44f-600a-4fe3-8ae1-fdc35f99bdb0
int:
type: integer
json_data:
type: string
format: binary
pointerOfString:
nullable: true
type: string
pointerOfStruct:
$ref: '#/components/schemas/Foo'
pointerOfTime:
nullable: true
type: string
format: date-time
sliceOfStruct:
type: array
items:
$ref: '#/components/schemas/Foo'
sliceofInt:
type: array
items:
type: integer
sliceofSliceofFloat:
type: array
items:
items:
type: number
type: array
sliceofString:
type: array
items:
type: string
strData:
type: object
additionalProperties:
type: string
string:
type: string
example: Some String Example
struct:
$ref: '#/components/schemas/Foo'
test:
$ref: '#/components/schemas/Test'
time:
type: string
format: date-time
weird_int:
$ref: '#/components/schemas/WeirdInt'
Signals:
type: array
items:
$ref: '#/components/schemas/Foo'
Test:
type: integer
WeirdCustomName:
type: object
properties:
some_string:
type: string
WeirdInt:
type: integer
example: 42
x-tagGroups: []