-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
217 lines (217 loc) · 7.36 KB
/
openapi.yaml
File metadata and controls
217 lines (217 loc) · 7.36 KB
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
openapi: 3.0.1
info:
title: Dog API
version: 1.0.0
description: >-
The Dog API provides a wealth of information on dog breeds, groups, and fun
facts. Access and integrate this data into your website or application with
our easy-to-use JSON API.
termsOfService: 'https://dogapi.dog/terms'
contact:
email: dev@dogapi.dog
license:
name: MIT
url: 'https://github.com/kinduff/dogapi.dog/blob/master/LICENSE'
servers:
- url: 'https://dogapi.dog/api/v2'
paths:
/breeds:
get:
summary: list breeds
tags:
- Breeds
responses:
'200':
description: successful
content:
application/json:
examples:
example:
value:
data:
- id: f9643a80-af1d-422a-9f15-18d466822053
type: breed
attributes:
name: Caucasian Shepherd Dog
description: >-
The Caucasian Shepherd dog is a serious guardian
breed and should never be taken lightly.
hypoallergenic: false
life:
min: 15
max: 20
male_weight:
min: 50
max: 100
female_weight:
min: 50
max: 100
- id: dc5e84f8-9151-4624-836c-25b4e313118b
type: breed
attributes:
name: Bouvier des Flandres
description: They don't build 'em like this anymore.
hypoallergenic: false
life:
min: 10
max: 14
male_weight:
min: 30
max: 40
female_weight:
min: 25
max: 35
meta:
pagination:
current: 1
records: 9
links:
self: 'https://dogapi.dog/api/v2/breeds'
current: 'https://dogapi.dog/api/v2/breeds?page[number]=1'
next: 'https://dogapi.dog/api/v2/breeds?page[number]=2'
last: 'https://dogapi.dog/api/v2/breeds?page[number]=2'
'/breeds/{id}':
get:
summary: get breed with non-existing id
tags:
- Breeds
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: successful
content:
application/json:
examples:
example:
value:
data:
id: f9643a80-af1d-422a-9f15-18d466822053
type: breed
attributes:
name: Caucasian Shepherd Dog
life:
min: 15
max: 20
male_weight:
min: 50
max: 100
female_weight:
min: 50
max: 100
description: >-
The Caucasian Shepherd dog is a serious guardian breed
and should never be taken lightly.
hypoallergenic: false
links:
self: >-
https://dogapi.dog/api/v2/breeds/f9643a80-af1d-422a-9f15-18d466822053
'404':
description: not-found
/facts:
get:
summary: list facts
tags:
- Facts
parameters:
- name: limit
in: query
required: false
schema:
type: integer
responses:
'200':
description: successful
content:
application/json:
examples:
example:
value:
data:
- id: 1cd1a16d-6fe1-40ea-9dd2-c21dd0f7c24e
type: fact
attributes:
body: >-
Many foot disorders in dogs are caused by long
toenails.
/groups:
get:
summary: list groups
tags:
- Groups
responses:
'200':
description: successful
content:
application/json:
examples:
example:
value:
data:
- id: 02124eb6-1baa-410c-90ea-6b8629fb0837
type: group
attributes:
name: Foundation Stock Service
relationships:
breeds:
data:
- id: b0b6810c-fb88-4987-ad0a-ae0440b04634
type: breed
- id: 38e06144-2ac3-43c0-981c-f8598eabc902
type: breed
- id: 256db247-70ce-4f08-b6a6-60b27ce369d1
type: group
attributes:
name: Herding Group
relationships:
breeds:
data:
- id: 85d5a702-057f-42e3-a24c-b56e0aa94bf9
type: breed
- id: eef99f80-266a-4659-a1e7-3af639010984
type: breed
links:
self: 'https://dogapi.dog/api/v2/groups'
current: 'https://dogapi.dog/api/v2/groups?page[number]=1'
next: 'https://dogapi.dog/api/v2/groups?page[number]=2'
last: 'https://dogapi.dog/api/v2/groups?page[number]=2'
'/groups/{id}':
get:
summary: get group with non-existing id
tags:
- Groups
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: successful
content:
application/json:
examples:
example:
value:
data:
id: 02124eb6-1baa-410c-90ea-6b8629fb0837
type: group
attributes:
name: Foundation Stock Service
relationships:
breeds:
data:
- id: b0b6810c-fb88-4987-ad0a-ae0440b04634
type: breed
- id: 4bc90a09-5406-4739-96c6-ac2161fbfa4e
type: breed
links:
self: >-
https://dogapi.dog/api/v2/groups/02124eb6-1baa-410c-90ea-6b8629fb0837
'404':
description: not-found