-
Notifications
You must be signed in to change notification settings - Fork 0
/
petstore.yaml
218 lines (218 loc) · 6.17 KB
/
petstore.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
openapi: "3.0.0"
info:
version: 1.0.0
title: Swagger Petstore
license:
name: MIT
servers:
- url: http://localhost:3001
paths:
/pets:
get:
summary: List all pets
operationId: listPets
tags:
- pets
parameters:
- name: limit
in: query
description: How many items to return at one time (max 100)
required: false
schema:
type: integer
format: int32
responses:
'200':
description: A paged array of pets
headers:
x-next:
description: A link to the next page of responses
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/Pets"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
post:
summary: Create a pet
operationId: createPets
security:
- key: []
tags:
- pets
requestBody:
description: Optional description in *Markdown*
required: true
content:
application/json:
schema:
required:
- name
$ref: '#/components/schemas/Pet'
text/plain:
schema:
type: string
responses:
'201':
description: Null response
content:
application/json:
schema:
$ref: "#/components/schemas/Pet"
application/xml:
schema:
$ref: '#/components/schemas/Pet'
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/pets/{petId}:
get:
summary: Info for a specific pet
operationId: showPet.byId
tags:
- pets
parameters:
- name: petId
in: path
required: true
description: The id of the pet to retrieve
schema:
type: integer
responses:
200:
description: Expected response to a valid request
content: {}
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
security:
- oauth2: ["uid"]
delete:
summary: Remove a pet
security:
- jwt: []
tags:
- pets
parameters:
- name: petId
in: path
required: true
description: The id of the pet to retrieve
schema:
type: integer
responses:
'202':
description: Null response
content:
application/json:
schema:
$ref: "#/components/schemas/Pet"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
components:
schemas:
Pet:
type: object
required:
- id
- name
properties:
id:
readOnly: true
type: integer
format: int64
name:
type: string
tag:
type: string
enum:
- dog
- cat
- fish
Pets:
type: array
items:
$ref: "#/components/schemas/Pet"
Error:
description: A Problem Details object (RFC 7807)
type: object
required:
- type
- title
- status
properties:
type:
type: string
format: uri
description: An absolute URI that identifies the problem type
default: about:blank # kept for backwards-compatibility, type will be mandatory in problem-v2
href:
type: string
format: uri
description: An absolute URI that, when dereferenced, provides human-readable documentation for the problem type (e.g. using HTML).
title:
type: string
description: A short summary of the problem type. Written in English and readable for engineers (usually not suited for non technical stakeholders and not localized).
example: Service Unavailable
status:
type: integer
format: int32
description: The HTTP status code generated by the origin server for this occurrence of the problem.
minimum: 400
maximum: 600
exclusiveMaximum: true
example: 503
detail:
type: string
description: A human-readable explanation specific to this occurrence of the problem
instance:
type: string
format: uri
description: An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
example:
{
"type": "urn:problem-type:belgif:payloadTooLarge",
"href": "https://www.belgif.be/specification/rest/api-guide/problems/payloadTooLarge.html", # location of linked doc will change in the future to recommended URI structure
"title": "Payload Too Large",
"status": 413,
"detail": "Request message must not be larger than 10 MB",
"instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000",
"limit": 10485760 # additional properties specific to the problem type are allowed
}
securitySchemes:
oauth2:
type: oauth2
flows:
implicit:
authorizationUrl: https://api.getbase.com/oauth2/authorize
scopes:
read: Grant read-only access to all your data except for the account and user info
write: Grant write-only access to all your data except for the account and user info
profile: Grant read-only access to the account and user info only
basic:
type: http
scheme: basic
jwt:
type: http
scheme: bearer
bearerFormat: JWT
key:
type: apiKey
name: X-Auth
in: header