-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
300 lines (289 loc) · 7.29 KB
/
swagger.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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
openapi: 3.0.0
info:
title: Song API
description: API for managing songs
version: 1.0.0
servers:
- url: http://localhost:8080
paths:
/info:
get:
summary: Get song info
parameters:
- in: query
name: song_name
schema:
type: string
required: true
description: Song name to search for
- in: query
name: group
schema:
type: string
required: true
description: Group name to search for
responses:
200:
description: Song info
content:
application/json:
schema:
$ref: '#/components/schemas/Song'
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrResponse'
500:
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrResponse'
/fullinfo:
get:
summary: Get full song info
parameters:
- in: query
name: id
schema:
type: integer
required: true
description: Id of song to look for
responses:
200:
description: Full song info
content:
application/json:
schema:
$ref: '#/components/schemas/Song'
500:
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrResponse'
/getInfoByField:
get:
summary: Get songs by field
parameters:
- in: query
name: field
schema:
type: string
required: true
description: Field to filter by
responses:
200:
description: List of songs
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Song'
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrResponse'
500:
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrResponse'
/getText:
get:
summary: Get song text
parameters:
- in: query
name: id
schema:
type: integer
required: true
description: Song ID
responses:
200:
description: Song text
content:
text/plain:
schema:
$ref: '#/components/schemas/Verses'
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrResponse'
500:
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrResponse'
/delete:
delete:
summary: Delete song
parameters:
- in: query
name: id
schema:
type: integer
required: true
description: Song ID
responses:
200:
description: Song deleted
content:
application/json:
schema:
type: object
properties:
message:
type: string
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrResponse'
500:
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrResponse'
/edit:
put:
summary: Edit song
requestBody:
description: Song to edit
content:
application/json:
schema:
$ref: '#/components/schemas/SongToSend'
responses:
200:
description: Song edited
content:
application/json:
schema:
type: object
properties:
message:
type: string
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrResponse'
500:
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrResponse'
/add:
post:
summary: Add song
requestBody:
description: Song to add
content:
application/json:
schema:
$ref: '#/components/schemas/SongToSend'
responses:
200:
description: Song added
content:
application/json:
schema:
type: object
properties:
message:
type: string
400:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrResponse'
500:
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrResponse'
components:
schemas:
Song:
type: object
properties:
id:
type: integer
description: Song ID
example: 1
release_date:
type: string
format: date-time
description: Release date of the song
example: "2022-01-01T12:00:00Z"
text:
type: string
description: Song text
example: "This is a song text"
link:
type: string
description: Song link
example: "https://example.com/song-link"
song:
type: string
description: Song title
example: "Song Title"
group_name:
type: string
description: Group Name
example: "Beatles"
SongToSend:
type: object
properties:
release_date:
type: string
format: date-time
description: Release date of the song
example: "2022-01-01T12:00:00Z"
text:
type: string
description: Song text
example: "This is a song text"
link:
type: string
description: Song link
example: "https://example.com/song-link"
ErrResponse:
type: object
properties:
error:
type: string
description: Error message
example: "Error occurred"
Verses:
type: object
properties:
verses:
type: array
items:
$ref: '#/components/schemas/Verse'
Verse:
type: object
properties:
id:
type: integer
description: id of the verse
text:
type: string
description: Verse text