-
-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathswagger.yaml
383 lines (383 loc) · 9.26 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
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
openapi: 3.0.0
info:
title: 'OAS API for Handball Spanish scoring '
description: 'Sample REST APIs using Flask, OpenAPI and Connexion'
version: 1.0.0
servers:
- url: 'http://services.handbolsantquirze.cat'
description: Rest Server showing Swagger and Connexion capability
paths:
/club:
get:
operationId: club.getAll
tags:
- Club
summary: Returns a list of clubs
description: Returns a list of clubs.
responses:
'200':
description: Return the entire list of regions.
content:
application/json:
schema:
$ref: '#/components/schemas/Club'
examples:
example-1:
value:
idClub: 0
Club: string
Address: string
Phone: string
Email: string
Web: string
Responsible: string
Logo: string
Region: 0
parameters:
- schema:
type: string
minLength: 0
maxLength: 255
in: query
name: clubname
description: ClubName
'/club/{idClub}':
get:
operationId: club.get
tags:
- Club
summary: Return a Club with given ID
description: Return a Club with given ID
parameters:
- name: idClub
in: path
description: Club ID
required: true
schema:
type: integer
format: int
responses:
'200':
description: Return a Club with given ID
content:
application/json:
schema:
$ref: '#/components/schemas/Club'
'/club/region/{idRegion}':
get:
operationId: club.getIdRegion
tags:
- Club
summary: Return a Club with given ID
description: Return a Club with given ID
parameters:
- name: idRegion
in: path
description: Region ID
required: true
schema:
type: integer
format: int
responses:
'200':
description: Return a list of Clubs with given Region ID
content:
application/json:
schema:
$ref: '#/components/schemas/Club'
/region:
get:
operationId: region.getAll
tags:
- Region
summary: Returns a list of regions.
description: Returns a list of regions.
responses:
'200':
description: Return the entire list of regions.
content:
application/json:
schema:
$ref: '#/components/schemas/Region'
post:
operationId: region.create
tags:
- Region
summary: Create a new Region
description: Create a new Region
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Region'
responses:
'201':
description: Region Created successfully
'/team/club/{idClub}':
get:
operationId: team.getIdClub
tags:
- Team
summary: Return a Team with given ID
description: Return a Team with given ID
parameters:
- name: idClub
in: path
description: Club ID
required: true
schema:
type: integer
format: int
responses:
'200':
description: Return a Team with given ID
content:
application/json:
schema:
$ref: '#/components/schemas/Team'
'/team/{idTeam}':
get:
operationId: team.get
tags:
- Team
summary: Return a Team with given ID
description: Return a Team with given ID
parameters:
- name: idTeam
in: path
description: Team ID
required: true
schema:
type: integer
format: int
responses:
'200':
description: Return a Team with given ID
content:
application/json:
schema:
$ref: '#/components/schemas/Team'
/team:
get:
operationId: team.getAll
tags:
- Team
summary: Returns a list of Teams.
description: Returns a list of teams.
responses:
'200':
description: Return the entire list of teams.
content:
application/json:
schema:
$ref: '#/components/schemas/Team'
post:
operationId: team.create
tags:
- Team
summary: Create a new Team
description: Create a new Team
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Team'
responses:
'201':
description: Team Created successfully
parameters: []
'/region/{idRegion}':
get:
operationId: region.get
tags:
- Region
summary: Return an Region with given ID
description: Return an Region with given ID
parameters:
- name: idRegion
in: path
description: Region ID
required: true
schema:
type: integer
format: int
responses:
'200':
description: Return an Region with given ID
content:
application/json:
schema:
$ref: '#/components/schemas/Region'
put:
operationId: region.update
tags:
- Region
summary: Update an Region with given ID
description: Update an Region with given ID
parameters:
- name: idRegion
in: path
description: Region ID
required: true
schema:
type: integer
format: int
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Region'
responses:
'200':
description: Updated an Region with given ID
content:
application/json:
schema:
$ref: '#/components/schemas/Region'
'/scores':
get:
summary: Get seasson match score
operationId: scores.getAll
tags:
- Scores
parameters:
- schema:
type: string
in: query
name: idHomeTeam
description: ID Home Team
required: true
- schema:
type: string
in: query
name: idAwayTeam
description: ID Away Team
required: true
- schema:
type: string
in: query
name: season
description: 'season'
responses:
'200':
description: Return the entire list of scores for specific match.
content:
application/json:
schema:
$ref: '#/components/schemas/Scores'
components:
schemas:
#generate scores schema
Scores:
type: object
properties:
HomeTeam:
type: object
properties:
id:
type: integer
format: int
name:
type: string
logo:
type: string
score:
type: integer
format: int
AwayTeam:
type: object
properties:
id:
type: integer
format: int
name:
type: string
logo:
type: string
score:
type: integer
format: int
Date:
type: string
Stadium:
type: string
Seasson:
type: string
Round:
type: string
Group:
type: string
Status:
type: string
LocalTeamId:
type: integer
format: int
AwayTeamId:
type: integer
format: int
id:
type: integer
format: int
Region:
type: object
properties:
idRegion:
type: integer
format: int
Region:
type: string
description: REGION MODEL
Club:
type: object
properties:
idClub:
type: integer
format: int
Club:
type: string
Address:
type: string
Phone:
type: string
Email:
type: string
Web:
type: string
Responsible:
type: string
Logo:
type: string
Region:
type: integer
format: int
description: CLUB MODEL
Team:
type: object
properties:
idTeam:
type: integer
format: int
idClub:
type: integer
format: int
idSeason:
type: integer
format: int
idCategory:
type: integer
format: int
idRegion:
type: integer
format: int
Team:
type: string
format: int
x-examples:
example-1:
idTeam: 0
idClub: 0
idSeason: 0
idCategory: 0
idRegion: 0
Team: string
description: 'TEAM MODEL '