forked from vtambourine/it61-rails
-
-
Notifications
You must be signed in to change notification settings - Fork 22
/
Copy pathswagger.yml
311 lines (308 loc) · 8 KB
/
swagger.yml
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
301
302
303
304
305
306
307
308
309
310
311
openapi: 3.0.0
# Added by API Auto Mocking Plugin
servers:
- description: IT52 API
url: https://www.it52.info/api/v2
info:
description: IT52 API
version: "2"
title: IT52 API
contact:
email: [email protected]
license:
name: MIT
url: 'https://github.com/NNRUG/it52-rails/blob/it52/LICENSE.md'
paths:
/events/{eventId}:
get:
summary: Event detail
operationId: eventDetail
parameters:
- in: path
required: true
name: eventId
description: event id
schema:
type: string
responses:
'200':
description: event detail
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
attributes:
'$ref': '#/components/schemas/Event'
id:
type: string
links:
type: object
properties:
url:
type: string
relationships:
type: object
properties:
organizer:
'$ref': '#/components/schemas/OneRelationship'
participants:
'$ref': '#/components/schemas/ManyRelationship'
type:
type: string
included:
type: array
items:
type: object
properties:
id:
type: string
type:
type: string
links:
type: object
properties:
url:
type: string
attributes:
'$ref': '#/components/schemas/User'
links:
type: object
properties:
self:
type: string
example: "https://www.it52.info/events/2019-06-29"
'404':
description: event not found
/events:
get:
summary: Events index
operationId: eventsIndex
parameters:
- in: query
name: page
description: page number
schema:
type: integer
- in: query
name: tag
description: filter events by string
schema:
type: string
responses:
'200':
description: events index
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
type:
type: string
attributes:
$ref: '#/components/schemas/Event'
links:
type: object
properties:
self:
type: string
next:
type: string
prev:
type: string
included:
type: array
items:
type: object
properties:
type:
type: string
links:
type: object
properties:
url:
type: string
id:
type: string
attributes:
$ref: '#/components/schemas/User'
meta:
type: object
properties:
total_count:
type: integer
total_pages:
type: integer
/tags:
get:
summary: tags index
operationId: tagsIndex
parameters:
- in: query
name: q
description: search query
schema:
type: string
responses:
'200':
description: tags index
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
type:
type: string
attributes:
$ref: '#/components/schemas/Tag'
meta:
type: object
properties:
total_count:
type: integer
components:
schemas:
Event:
type: object
properties:
title:
type: string
example: 'My Event'
createdAt:
type: string
example: "2019-06-13T19:00:00.000+03:00"
updatedAt:
type: string
example: "2019-06-13T19:00:00.000+03:00"
startedAt:
type: string
example: "2019-06-13T19:00:00.000+03:00"
published:
type: boolean
description:
type: string
titleImage:
type: object
properties:
url:
type: string
square_500:
type: object
properties:
url:
type: string
fb_1200:
type: object
properties:
url:
type: string
place:
type: string
slug:
type: string
foreignLink:
type: string
pageviews:
type: integer
kind:
type: string
enum:
- event
- education
tagList:
type: array
items:
type: string
UserAvatarImage:
type: object
properties:
url:
type: string
square_25:
type: object
properties:
url:
type: string
square_50:
type: object
properties:
url:
type: string
square_150:
type: object
properties:
url:
type: string
OneRelationship:
required:
- data
properties:
data:
type: object
properties:
id:
type: string
type:
type: string
ManyRelationship:
required:
- data
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
type:
type: string
User:
properties:
nickname:
type: string
example: 'cool_hacker'
role:
type: string
enum:
- member
- admin
firstName:
type: string
lastName:
type: string
bio:
type: string
avatarImage:
$ref: '#/components/schemas/UserAvatarImage'
slug:
type: string
website:
type: string
employment:
type: string
type: object
Tag:
type: object
properties:
name:
type: string
taggingsCount:
type: integer