forked from zircote/swagger-php
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpetstore-with-external-docs.yaml
205 lines (205 loc) · 5.44 KB
/
petstore-with-external-docs.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
openapi: 3.0.0
info:
title: 'Swagger Petstore'
description: 'A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification'
termsOfService: 'http://swagger.io/terms/'
contact:
name: 'Swagger API Team'
url: 'http://swagger.io'
email: [email protected]
license:
name: MIT
url: 'http://github.com/gruntjs/grunt/blob/master/LICENSE-MIT'
version: 1.0.0
servers:
-
url: petstore.swagger.io
description: 'API server'
paths:
/pets:
get:
description: 'Returns all pets from the system that the user has access to'
externalDocs:
description: 'find more info here'
url: 'https://swagger.io/about'
operationId: findPets
parameters:
-
name: tags
in: query
description: 'tags to filter by'
required: false
style: form
schema:
type: array
items:
type: string
-
name: limit
in: query
description: 'maximum number of results to return'
required: false
schema:
type: integer
format: int32
responses:
'200':
description: 'pet response'
content:
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/Pet'
text/xml:
schema:
type: array
items:
$ref: '#/components/schemas/Pet'
text/html:
schema:
type: array
items:
$ref: '#/components/schemas/Pet'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Pet'
default:
description: 'unexpected error'
content:
application/xml:
schema:
$ref: '#/components/schemas/ErrorModel'
text/xml:
schema:
$ref: '#/components/schemas/ErrorModel'
text/html:
schema:
$ref: '#/components/schemas/ErrorModel'
application/json:
schema:
$ref: '#/components/schemas/ErrorModel'
post:
description: 'Creates a new pet in the store. Duplicates are allowed'
operationId: addPet
requestBody:
description: 'Pet to add to the store'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NewPet'
responses:
'200':
description: 'pet response'
content:
application/json:
schema:
$ref: '#/components/schemas/Pet'
default:
description: 'unexpected error'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorModel'
'/pets/{id}':
get:
description: 'Returns a user based on a single ID, if the user does not have access to the pet'
operationId: findPetById
parameters:
-
name: id
in: path
description: 'ID of pet to fetch'
required: true
schema:
type: integer
format: int64
responses:
'200':
description: 'pet response'
content:
text/html:
schema:
$ref: '#/components/schemas/Pet'
text/xml:
schema:
$ref: '#/components/schemas/Pet'
application/json:
schema:
$ref: '#/components/schemas/Pet'
application/xml:
schema:
$ref: '#/components/schemas/Pet'
default:
description: 'unexpected error'
content:
text/xml:
schema:
$ref: '#/components/schemas/ErrorModel'
text/html:
schema:
$ref: '#/components/schemas/ErrorModel'
application/json:
schema:
$ref: '#/components/schemas/ErrorModel'
application/xml:
schema:
$ref: '#/components/schemas/ErrorModel'
delete:
description: 'deletes a single pet based on the ID supplied'
operationId: deletePet
parameters:
-
name: id
in: path
description: 'ID of pet to delete'
required: true
schema:
type: integer
format: int64
responses:
'204':
description: 'pet deleted'
default:
description: 'unexpected error'
components:
schemas:
ErrorModel:
required:
- code
- message
properties:
code:
type: integer
format: int32
message:
type: string
type: object
NewPet:
required:
- name
properties:
name:
type: string
tag:
type: string
type: object
Pet:
type: object
allOf:
-
$ref: '#/components/schemas/NewPet'
-
required:
- id
properties:
id:
type: integer
format: int64
type: object
externalDocs:
description: 'find more info here'
url: 'https://swagger.io/about'