-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
281 lines (273 loc) · 6.78 KB
/
openapi.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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
openapi: 3.0.3
info:
title: Fast Photo Hub API
version: '0.1.0'
contact:
email: vv.tramo@gmail.com
tags:
- name: Photos
- name: Albums
- name: Images
paths:
/photos:
post:
tags:
- Photos
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
photo:
$ref: '#/components/schemas/Photo'
image:
type: string
format: binary
responses:
200:
description: Photo successfully created and returned
content:
application/json:
schema:
$ref: '#/components/schemas/Photo'
get:
tags:
- Photos
responses:
200:
description: A list of photos is successfully retrieved
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Photo'
/photos/{id}:
parameters:
- in: path
name: id
schema:
type: string
get:
tags:
- Photos
responses:
200:
description: A photo is successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/Photo'
patch:
tags:
- Photos
requestBody:
content:
application/json:
schema:
oneOf:
- type: object
properties:
albumId:
type: string
- type: object
properties:
title:
type: string
- type: object
properties:
visibility:
type: string
responses:
200:
description: Photo successfully updated and returned
content:
application/json:
schema:
$ref: '#/components/schemas/Photo'
/albums:
post:
tags:
- Albums
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
album:
$ref: '#/components/schemas/Album'
coverImage:
type: string
format: binary
responses:
200:
description: Album successfully created with cover image
content:
application/json:
schema:
$ref: '#/components/schemas/Album'
get:
tags:
- Albums
responses:
200:
description: A list of albums is successfully retrieved
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Album'
/images/{id}:
parameters:
- in: path
name: id
schema:
type: string
- in: query
name: huerotate
schema:
type: integer
example: 180
- in: query
name: thumbnail
schema:
type: string
example: 300,300
get:
tags:
- Images
responses:
200:
description: The image with the specified ID is successfully retrieved for download
content:
image/png:
schema:
type: string
format: binary
/albums/{id}:
parameters:
- in: path
name: id
schema:
type: string
get:
tags:
- Albums
responses:
200:
description: An album is successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/Album'
patch:
tags:
- Albums
requestBody:
content:
application/json:
schema:
oneOf:
- type: object
properties:
title:
type: string
responses:
200:
description: Photo successfully updated and returned
content:
application/json:
schema:
$ref: '#/components/schemas/Photo'
components:
schemas:
Photo:
type: object
required:
- id
- tags
- albumId
- category
- createdAt
- description
- imageId
- imageUrl
- title
- visibility
properties:
id:
type: string
description: Unique identifier for the photo
readOnly: true
albumId:
type: string
description: Identifier for the album the photo belongs to
readOnly: true
title:
type: string
description: Title of the photo
description:
type: string
description: Description of the photo
category:
type: string
description: Category of the photo
tags:
type: string
description: Tags associated with the photo (comma-separated list)
visibility:
description: Visibility status of the photo (e.g., public, private)
allOf:
- $ref: "#/components/schemas/Visibility"
createdAt:
type: string
format: date-time
description: Date and time when the photo was created
readOnly: true
imageId:
type: string
description: Unique identifier for the image
readOnly: true
imageUrl:
type: string
format: uri
description: URL of the image
readOnly: true
Album:
type: object
properties:
id:
type: string
description: Unique identifier for the album
readOnly: true
title:
type: string
description: Title of the album
description:
type: string
description: Description of the album
visibility:
description: Visibility status of the album (e.g., public, private)
allOf:
- $ref: "#/components/schemas/Visibility"
createdAt:
type: string
format: date-time
description: Date and time when the album was created
readOnly: true
coverImageId:
type: string
description: Unique identifier for the album's cover image
readOnly: true
coverImageUrl:
type: string
description: URL of the album's cover image
readOnly: true
Visibility:
type: string
enum:
- PUBLIC
- PRIVATE