-
Notifications
You must be signed in to change notification settings - Fork 50
/
pet-store-swagger-with-base-path.yaml
233 lines (233 loc) · 5.38 KB
/
pet-store-swagger-with-base-path.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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
swagger: "2.0"
info:
version: 1.0.0
title: Swagger Petstore
license:
name: MIT
host: petstore.swagger.io
basePath: /v1
schemes:
- http
consumes:
- application/json
produces:
- application/json
paths:
/pets:
get:
consumes:
- application/json
produces:
- application/json
summary: List all pets
operationId: listPets
tags:
- pets
parameters:
- $ref: '#/parameters/ApiRequestId'
- $ref: '#/parameters/ApiVersion'
- name: limit
in: query
description: How many items to return at one time (max 100)
required: false
type: integer
# format: int32
minimum: 1
maximum: 100
- name: page
in: query
description: page number
required: true
type: integer
# format: int32
minimum: 0
responses:
"200":
description: An paged array of pets
headers:
x-next:
type: string
description: A link to the next page of responses
schema:
$ref: '#/definitions/Pets'
default:
description: unexpected error
schema:
$ref: '#/definitions/Error'
post:
summary: Create a pet
operationId: createPets
consumes:
- application/json
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiRequestId'
- name: body
in: body
required: true
schema:
required:
- name
- test
properties:
name:
type: string
tag:
type: string
test:
type: object
required:
- field1
properties:
field1:
type: string
enum: ['enum1', 'enum2']
responses:
"201":
description: Null response
default:
description: unexpected error
schema:
$ref: '#/definitions/Error'
put:
summary: Info for a specific pet
operationId: updatePats
tags:
- pets
parameters:
- name: body
in: body
required: true
schema:
type: array
items:
type: object
required:
- name
- test
properties:
name:
type: string
tag:
type: string
test:
type: object
required:
- field1
properties:
field1:
type: string
enum: ['enum1', 'enum2']
responses:
"200":
description: Expected response to a valid request
schema:
$ref: '#/definitions/Pets'
default:
description: unexpected error
schema:
$ref: '#/definitions/Error'
/pets/{petId}:
get:
summary: Info for a specific pet
operationId: showPetById
tags:
- pets
parameters:
- $ref: '#/parameters/ApiVersion'
- $ref: '#/parameters/ApiRequestId'
- name: petId
in: path
required: true
description: The id of the pet to retrieve
type: string
minLength: 3
maxLength: 10
responses:
"200":
description: Expected response to a valid request
schema:
$ref: '#/definitions/Pets'
default:
description: unexpected error
schema:
$ref: '#/definitions/Error'
/heartbeat:
get:
summary: Info for current system status
operationId: getHearbeat
responses:
"200":
description: Expected response to a valid request
schema:
$ref: '#/definitions/StatusReport'
default:
description: unexpected error
schema:
$ref: '#/definitions/Error'
/capital:
get:
parameters:
- $ref: '#/parameters/CapitalLetters'
responses:
"200":
description: An paged array of pets
definitions:
Pet:
required:
- id
- name
properties:
id:
type: integer
format: int64
name:
type: string
tag:
type: string
Pets:
type: array
items:
$ref: '#/definitions/Pet'
Error:
required:
- code
- message
properties:
code:
type: integer
# format: int32
message:
type: string
StatusReport:
required:
- text
- code
properties:
text:
type: string
code:
type: string
parameters:
ApiVersion:
name: 'api-version'
in: header
description: 'The api version. It overwrites the account settings.'
required: true
type: string
minLength: 1
pattern: '^\d{1,3}\.\d{1,3}$'
x-example: '3.0'
ApiRequestId:
name: 'request-id'
in: header
description: 'global request id through the system.'
type: string
minLength: 1
x-example: '123456'
CapitalLetters:
name: 'Capital-Letters'
in: header
required: true
type: string