-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
140 lines (140 loc) · 3.83 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
swagger: "2.0"
info:
title: "FIRST Israel API"
description: "The official API for FIRST Israel."
version: "1.0.0"
contact:
email: "[email protected]"
host: "api.firstisrael.org.il"
basePath: "/v1"
tags:
- name: "Teams"
description: "Everything about teams"
paths:
/explore/team/{team_key}:
get:
tags:
- "Teams"
description: "Gets details for a FIRST LEGO League Explore team referenced by the given key."
parameters:
- name: "team_key"
in: "path"
description: "Team Key, eg `254`."
required: true
type: "integer"
responses:
"200":
description: "Successful response"
schema:
$ref: "#/definitions/FLLTeam"
"404":
description: "Team not found"
/challenge/team/{team_key}:
get:
tags:
- "Teams"
description: "Gets details for a FIRST LEGO League Challenge team referenced by the given key."
parameters:
- name: "team_key"
in: "path"
description: "Team Key, eg `261`."
required: true
type: "integer"
responses:
"200":
description: "Successful response"
schema:
$ref: "#/definitions/FLLTeam"
"404":
description: "Team not found"
/ftc/team/{team_key}:
get:
tags:
- "Teams"
description: "Gets details for a FIRST Tech Challenge team referenced by the given key."
parameters:
- name: "team_key"
in: "path"
description: "Team Key, eg `9662`."
required: true
type: "integer"
responses:
"200":
description: "Successful response"
schema:
$ref: "#/definitions/FTCTeam"
"404":
description: "Team not found"
/frc/team/{team_key}:
get:
tags:
- "Teams"
description: "Gets details for a FIRST Robotics Competition team referenced by the given key."
parameters:
- name: "team_key"
in: "path"
description: "Team Key, eg `1937`."
required: true
type: "integer"
responses:
"200":
description: "Successful response"
schema:
$ref: "#/definitions/FRCTeam"
"404":
description: "Team not found"
definitions:
FLLTeam:
type: "object"
properties:
team:
type: "integer"
description: "Official team number issued by FIRST."
affiliation:
type: "string"
description: "Name of team school or affilited group."
city:
type: "string"
description: "City of the team."
FTCTeam:
type: "object"
properties:
team:
type: "integer"
description: "Official team number issued by FIRST."
affiliation:
type: "string"
description: "Name of team school or affilited group."
city:
type: "string"
description: "City of the team."
affiliation_en:
type: "string"
description: "[English] Name of team school or affilited group."
city_en:
type: "string"
description: "[English] City of the team."
rookie:
type: "integer"
description: "First year the team officially competed."
FRCTeam:
type: "object"
properties:
team:
type: "integer"
description: "Official team number issued by FIRST."
affiliation:
type: "string"
description: "Name of team school or affilited group."
city:
type: "string"
description: "City of the team."
affiliation_en:
type: "string"
description: "[English] Name of team school or affilited group."
city_en:
type: "string"
description: "[English] City of the team."
rookie:
type: "integer"
description: "First year the team officially competed."