-
Notifications
You must be signed in to change notification settings - Fork 0
/
dog_ceo.yaml
188 lines (187 loc) · 5.16 KB
/
dog_ceo.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
openapi: "3.0.0"
info:
# Copyright 2018, 2019 Transposit Corporation. All Rights Reserved.
version: 1.0.0
title: The Dog API
description: A public api of dog data
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://dog.ceo/api
externalDocs:
url: https://dog.ceo/dog-api/documentation/
paths:
/breeds/list/all:
get:
description: List all dog breeds
operationId: list_breeds
responses:
'200':
description: List of all breeds and sub-breeds
content:
application/json:
schema:
type: object
/breeds/image/random:
get:
description: Get a random dog image
operationId: get_random_dog
responses:
'200':
description: "success"
content:
application/json:
schema:
$ref: "#/components/responses/Image"
/breeds/image/random/{num}:
parameters:
- $ref: "#/components/parameters/Number"
get:
description: Get multiple random dog images
operationId: get_random_dogs
responses:
'200':
description: "success"
content:
application/json:
schema:
type: array
items:
$ref: "#/components/responses/Image"
/breed/{breed}/images:
parameters:
- $ref: "#/components/parameters/Breed"
get:
description: Get all images of a particular breed
operationId: list_breed_images
responses:
'200':
description: "success"
content:
application/json:
schema:
type: array
items:
$ref: "#/components/responses/Image"
/breed/{breed}/images/random:
parameters:
- $ref: "#/components/parameters/Breed"
get:
description: Get a random dog image for a breed
operationId: get_random_dog_by_breed
responses:
'200':
description: "success"
content:
application/json:
schema:
$ref: "#/components/responses/Image"
/breed/{breed}/images/random/{num}:
parameters:
- $ref: "#/components/parameters/Breed"
- $ref: "#/components/parameters/Number"
get:
description: Get multiple random dog images from a breed, e.g. hound
operationId: get_random_breed_dogs
responses:
'200':
description: "success"
content:
application/json:
schema:
type: array
items:
$ref: "#/components/responses/Image"
/breed/{breed}/list:
parameters:
- $ref: "#/components/parameters/Breed"
get:
description: Returns an array of all the sub-breeds from a breed
operationId: list_subbreeds
responses:
'200':
description: "success"
content:
application/json:
schema:
type: array
items:
type: string
/breed/{breed}/{subbreed}/images:
parameters:
- $ref: "#/components/parameters/Breed"
- $ref: "#/components/parameters/Subbreed"
get:
description: Get all images of a particular sub-breed
operationId: list_subbreed_images
responses:
'200':
description: "success"
content:
application/json:
schema:
type: array
items:
$ref: "#/components/responses/Image"
/breed/{breed}/{subbreed}/images/random:
parameters:
- $ref: "#/components/parameters/Breed"
- $ref: "#/components/parameters/Subbreed"
get:
description: Get a random dog image for a sub-breed
operationId: get_random_dog_by_subbreed
responses:
'200':
description: "success"
content:
application/json:
schema:
$ref: "#/components/responses/Image"
/breed/{breed}/{subbreed}/images/random/{num}:
parameters:
- $ref: "#/components/parameters/Breed"
- $ref: "#/components/parameters/Subbreed"
- $ref: "#/components/parameters/Number"
get:
description: Get multiple random dog images from a sub-breed
operationId: get_random_subbreed_dogs
responses:
'200':
description: "success"
content:
application/json:
schema:
type: array
items:
$ref: "#/components/responses/Image"
components:
parameters:
Breed:
name: breed
in: path
description: breed to fetch
required: true
schema:
type: string
Subbreed:
name: subbreed
in: path
description: subbreed to fetch
required: true
schema:
type: string
Number:
name: num
in: path
description: Number of dogs to return. Max number returned is 50.
required: true
schema:
type: integer
responses:
Image:
description: URL to an image of a dog
content:
application/json:
schema:
type: string