ftc_events_client 0.1.0 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +351 -101
- data/Rakefile +0 -2
- data/config.json +1 -1
- data/docs/AllianceModelVersion2.md +10 -28
- data/docs/AllianceScore2020.md +37 -82
- data/docs/AllianceSelectionApi.md +14 -14
- data/docs/AllianceSelectionModelVersion2.md +4 -16
- data/docs/ApiIndexModel.md +11 -30
- data/docs/AutoNavigatedStatus.md +6 -0
- data/docs/AwardAssignmentModel.md +13 -34
- data/docs/AwardsApi.md +47 -49
- data/docs/AwardsModel.md +3 -14
- data/docs/BarcodeElement.md +6 -0
- data/docs/EndgameParkedStatus.md +6 -0
- data/docs/EventMatchResultsModelVersion2.md +3 -14
- data/docs/EventRankingsModel.md +3 -14
- data/docs/EventScheduleHybridModelVersion2.md +3 -14
- data/docs/EventScheduleModelVersion2.md +3 -14
- data/docs/FTCEventLevel.md +6 -0
- data/docs/GeneralApi.md +9 -11
- data/docs/LeagueMemberListModel.md +7 -0
- data/docs/LeaguesApi.md +179 -0
- data/docs/MatchResultModelVersion2.md +16 -40
- data/docs/MatchResultTeamModelVersion2.md +6 -18
- data/docs/MatchResultsApi.md +33 -35
- data/docs/MatchScoresModel.md +3 -14
- data/docs/MatchScoresModelMatchScoresOneOf.md +5 -1
- data/docs/OneOfMatchScoresModelMatchScoresItems.md +6 -0
- data/docs/RankingsApi.md +16 -17
- data/docs/ScheduleApi.md +30 -32
- data/docs/ScheduleHybridModelTeamVersion2.md +8 -22
- data/docs/ScheduleHybridModelVersion2.md +18 -40
- data/docs/ScheduledMatchModelVersion2.md +10 -28
- data/docs/ScheduledMatchTeamModelVersion2.md +6 -20
- data/docs/ScoreDetailAllianceModel2020.md +39 -86
- data/docs/ScoreDetailAllianceModel2021.md +48 -0
- data/docs/ScoreDetailModel2019.md +6 -18
- data/docs/ScoreDetailModel2020.md +6 -18
- data/docs/ScoreDetailModel2021.md +10 -0
- data/docs/ScoreDetailModelAlliance2019.md +36 -80
- data/docs/ScoreDetailModelSinglePlayer2020.md +6 -20
- data/docs/ScoreDetailModelSinglePlayer2021.md +10 -0
- data/docs/ScoreDetailSinglePlayer2021.md +39 -0
- data/docs/SeasonAwardListingsModel.md +3 -14
- data/docs/SeasonAwardsModel.md +6 -20
- data/docs/SeasonDataApi.md +35 -37
- data/docs/SeasonEventListingsModelVersion2.md +4 -16
- data/docs/SeasonEventModelVersion2.md +24 -46
- data/docs/SeasonLeagueListingsModelVersion2.md +8 -0
- data/docs/SeasonLeagueModelVersion2.md +11 -0
- data/docs/SeasonSummaryModelChampionship.md +5 -18
- data/docs/SeasonSummaryModelVersion2.md +8 -24
- data/docs/SeasonTeamListingsModelVersion2.md +7 -22
- data/docs/SeasonTeamModelVersion2.md +14 -36
- data/docs/Stone.md +2 -11
- data/docs/TeamRankingModel.md +17 -42
- data/ftc_events_client.gemspec +5 -5
- data/git_push.sh +7 -10
- data/lib/ftc_events_client/api/alliance_selection_api.rb +17 -22
- data/lib/ftc_events_client/api/awards_api.rb +52 -74
- data/lib/ftc_events_client/api/general_api.rb +8 -17
- data/lib/ftc_events_client/api/leagues_api.rb +218 -0
- data/lib/ftc_events_client/api/match_results_api.rb +44 -45
- data/lib/ftc_events_client/api/rankings_api.rb +17 -22
- data/lib/ftc_events_client/api/schedule_api.rb +44 -45
- data/lib/ftc_events_client/api/season_data_api.rb +30 -53
- data/lib/ftc_events_client/api_client.rb +52 -54
- data/lib/ftc_events_client/api_error.rb +4 -4
- data/lib/ftc_events_client/configuration.rb +6 -76
- data/lib/ftc_events_client/models/alliance_model_version2.rb +19 -31
- data/lib/ftc_events_client/models/{alliance_score2020.rb → alliance_score_2020.rb} +46 -58
- data/lib/ftc_events_client/models/alliance_selection_model_version2.rb +13 -25
- data/lib/ftc_events_client/models/api_index_model.rb +20 -32
- data/lib/ftc_events_client/models/{tournament_level.rb → auto_navigated_status.rb} +11 -21
- data/lib/ftc_events_client/models/award_assignment_model.rb +22 -34
- data/lib/ftc_events_client/models/awards_model.rb +12 -24
- data/lib/ftc_events_client/models/barcode_element.rb +28 -0
- data/lib/ftc_events_client/models/endgame_parked_status.rb +29 -0
- data/lib/ftc_events_client/models/event_match_results_model_version2.rb +12 -24
- data/lib/ftc_events_client/models/event_rankings_model.rb +12 -24
- data/lib/ftc_events_client/models/event_schedule_hybrid_model_version2.rb +12 -24
- data/lib/ftc_events_client/models/event_schedule_model_version2.rb +12 -24
- data/lib/ftc_events_client/models/ftc_event_level.rb +31 -0
- data/lib/ftc_events_client/models/league_member_list_model.rb +209 -0
- data/lib/ftc_events_client/models/match_result_model_version2.rb +25 -37
- data/lib/ftc_events_client/models/match_result_team_model_version2.rb +26 -29
- data/lib/ftc_events_client/models/match_scores_model.rb +12 -24
- data/lib/ftc_events_client/models/one_of_match_scores_model_match_scores_items.rb +197 -0
- data/lib/ftc_events_client/models/schedule_hybrid_model_team_version2.rb +30 -32
- data/lib/ftc_events_client/models/schedule_hybrid_model_version2.rb +46 -38
- data/lib/ftc_events_client/models/scheduled_match_model_version2.rb +19 -31
- data/lib/ftc_events_client/models/scheduled_match_team_model_version2.rb +15 -27
- data/lib/ftc_events_client/models/{score_detail_alliance_model2020.rb → score_detail_alliance_model_2020.rb} +48 -60
- data/lib/ftc_events_client/models/score_detail_alliance_model_2021.rb +576 -0
- data/lib/ftc_events_client/models/{score_detail_model2019.rb → score_detail_model_2019.rb} +24 -27
- data/lib/ftc_events_client/models/{score_detail_model2020.rb → score_detail_model_2020.rb} +24 -27
- data/lib/ftc_events_client/models/score_detail_model_2021.rb +236 -0
- data/lib/ftc_events_client/models/{score_detail_model_alliance2019.rb → score_detail_model_alliance_2019.rb} +45 -57
- data/lib/ftc_events_client/models/{score_detail_model_single_player2020.rb → score_detail_model_single_player_2020.rb} +15 -27
- data/lib/ftc_events_client/models/score_detail_model_single_player_2021.rb +233 -0
- data/lib/ftc_events_client/models/score_detail_single_player_2021.rb +494 -0
- data/lib/ftc_events_client/models/season_award_listings_model.rb +12 -24
- data/lib/ftc_events_client/models/season_awards_model.rb +22 -34
- data/lib/ftc_events_client/models/season_event_listings_model_version2.rb +13 -25
- data/lib/ftc_events_client/models/season_event_model_version2.rb +77 -41
- data/lib/ftc_events_client/models/season_league_listings_model_version2.rb +218 -0
- data/lib/ftc_events_client/models/season_league_model_version2.rb +247 -0
- data/lib/ftc_events_client/models/season_summary_model_championship.rb +14 -26
- data/lib/ftc_events_client/models/season_summary_model_version2.rb +17 -29
- data/lib/ftc_events_client/models/season_team_listings_model_version2.rb +16 -28
- data/lib/ftc_events_client/models/season_team_model_version2.rb +23 -35
- data/lib/ftc_events_client/models/stone.rb +6 -15
- data/lib/ftc_events_client/models/team_ranking_model.rb +26 -38
- data/lib/ftc_events_client/version.rb +4 -5
- data/lib/ftc_events_client.rb +22 -12
- data/spec/api/leagues_api_spec.rb +77 -0
- data/spec/base_object_spec.rb +109 -0
- data/spec/configuration_spec.rb +3 -3
- data/spec/models/alliance_score_2020_spec.rb +244 -0
- data/spec/models/auto_navigated_status_spec.rb +28 -0
- data/spec/models/barcode_element_spec.rb +28 -0
- data/spec/models/endgame_parked_status_spec.rb +28 -0
- data/spec/models/ftc_event_level_spec.rb +28 -0
- data/spec/models/league_member_list_model_spec.rb +34 -0
- data/spec/models/one_of_match_scores_model_match_scores_items_spec.rb +34 -0
- data/spec/models/score_detail_alliance_model2021_spec.rb +280 -0
- data/spec/models/score_detail_alliance_model_2020_spec.rb +256 -0
- data/spec/models/score_detail_alliance_model_2021_spec.rb +286 -0
- data/spec/models/score_detail_model2021_spec.rb +52 -0
- data/spec/models/score_detail_model_2019_spec.rb +58 -0
- data/spec/models/score_detail_model_2020_spec.rb +58 -0
- data/spec/models/score_detail_model_2021_spec.rb +58 -0
- data/spec/models/score_detail_model_alliance_2019_spec.rb +238 -0
- data/spec/models/score_detail_model_single_player2021_spec.rb +52 -0
- data/spec/models/score_detail_model_single_player_2020_spec.rb +58 -0
- data/spec/models/score_detail_model_single_player_2021_spec.rb +58 -0
- data/spec/models/score_detail_single_player2021_spec.rb +226 -0
- data/spec/models/score_detail_single_player_2021_spec.rb +232 -0
- data/spec/models/season_league_listings_model_version2_spec.rb +40 -0
- data/{lib/ftc_events_client/models/match_scores_model_match_scores_one_of.rb → spec/models/season_league_model_version2_spec.rb} +35 -83
- data/update.sh +2 -2
- metadata +103 -11
@@ -3,15 +3,13 @@
|
|
3
3
|
|
4
4
|
#FTC Events API is a service to return relevant information about the _FIRST_ Tech Challenge (FTC). Information is made available from events operating around the world Information is currently made available after the conclusion of the tournament. The API will provide data as soon as it has synced, and we do not add any artificial delays. ## Documentation Notes ### Timezones All times are listed in the local time to the event venue. HTTP-date values will show their timezone. ### Query Parameters If you specify a parameter, but no value for that parameter, it will be ignored. For example, if you request `URL?teamNumber=` the `teamNumber` parameter would be ignored. For all APIs that accept a query string in addition to the base URI, the order of parameters do not matter, but the name shown in the documentation must match exactly, as does the associated value format as described in details. For response codes that are not HTTP 200 (OK), the documentation will show a body message that represents a possible response value. While the \"title\" of the HTTP Status Code will match those shown in the response codes documentation section exactly, the body of the response will be a more detailed explanation of why that status code is being returned and may not always be exactly as shown in the examples. ### Experimenting with the API This documentation is rendered at both [api-docs](https://ftc-events.firstinspires.org/api-docs) and [try-it-out](https://ftc-events.firstinspires.org/try-it-out). [api-docs](https://ftc-events.firstinspires.org/api-docs) has a three panel, easy to read layout, while [try-it-out](https://ftc-events.firstinspires.org/try-it-out) has a feature that allows you try out endpoints from within the page. Additionally, the Open API Json is availabe at [Open API](https://ftc-events.firstinspires.org/swagger/v2.0/swagger.json). This can be imported into a tool such as [Postman](https://www.postman.com) for experimentation as well. ### Last-Modified, FMS-OnlyModifiedSince, and If-Modified-Since Headers The FTC Events API utilizes the `Last-Modified` and `If-Modified-Since` Headers to communicate with consumers regarding the age of the data they are requesting. With a couple of exceptions, all calls will return a `Last-Modified` Header set with the time at which the data at that endpoint was last modified. The Header will always be set in the HTTP-date format, as described in the HTTP Protocol. There are two exceptions: the `Last-Modified` Header is not set if the endpoint returns no results (such as a request for a schedule with no matches). Consumers should keep track of the `Last-Modified` Header, and return it on subsequent calls to the same endpoint as the If-Modified-Since. The server will recognize this request, and will only return a result if the data has been modified since the last request. If no changes have been made, an HTTP 304 will be returned. If data has been modified, ALL data on that call will be returned (for \"only modified\" data, see below). The FTC Events API also allows a custom header used to filter the return data to a specific subset. This is done by specifying a `FMS-OnlyModifiedSince` header with each call. As with the `If-Modified-Since` header, consumers should keep track of the Last-Modified Header, and return it on subsequent calls to the same endpoint as the `FMS-OnlyModifiedSince` Header. The server will recognize this request, and will only return a result if the data has been modified since the last request, and, if returned, the data will only be those portions modified since the included date. If no changes, have been made, an HTTP 304 will be returned. Using this method, the server and consumer save processing time by only receiving modified data that is in need of update on the consumer side. If the Headers are improperly passed (such as the wrong Day of Week for the matching date, or a date in the future), the endpoint will simply ignore the Header and return all results. If both headers are specified, the request will be denied. ## Response Codes The FTC Events API HTTP Status Codes correspond with the [common codes](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html), but occasionally with different \"titles\". The \"title\" used by the API is shown next to each of the below possible response HTTP Status Codes. Throughout the documentation, Apiary may automatically show the common \"title\" in example returns (like \"Not Found\" for 404) but on the production server, the \"title\" will instead match those listed below. ### HTTP 200 - \"OK\" The request has succeeded. An entity corresponding to the requested resource is sent in the response. This will be returned as the HTTP Status Code for all request that succeed, even if the body is empty (such as an event that has no rankings, but with a valid season and event code were used) ### HTTP 304 - \"Not Modified\" When utilizing a Header that allows filtered data returns, such as `If-Modified-Since`, this response indicates that no data meets the request. ### HTTP 400 - \"Invalid Season Requested\"/\"Malformed Parameter Format In Request\"/\"Missing Parameter In Request\"/\"Invalid API Version Requested\": The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications. Specifically for this API, a 400 response indicates that the requested URI matches with a valid API, but one or more required parameter was malformed or invalid. Examples include an event code that is too short or team number that contains a letter. ### HTTP 401 - \"Unauthorized\" All requests against the API require authentication via a valid user token. Failing to provide one, or providing an invalid one, will warrant a 401 response. The client MAY repeat the request with a suitable Authorization header field. ### HTTP 404 - \"Invalid Event Requested\" Even though the 404 code usually indicates any not found status, a 404 will only be issued in this API when an event cannot be found for the requested season and event code. If the request didn't match a valid API or there were malformed parameters, the response would not receive a 404 but rather a 400 or 501. If this HTTP code is received, the season was a valid season and the event code matched the acceptable style of an event code, but there were no records of an event matching the combination of that season and event code. For example, HTTP 404 would be issued when the event had a different code in the requested season (the codes can change year to year based on event location). ### HTTP 500 - \"Internal Server Error\" The server encountered an unexpected condition which prevented it from fulfilling the request. This is a code sent directly by the server, and has no special alternate definition specific to this API. ### HTTP 501 - \"Request Did Not Match Any Current API Pattern\" The server does not support the functionality required to fulfill the request. Specifically, the request pattern did not match any of the possible APIs, and thus processing was discontinued. This code is also issued when too many optional parameters were included in a single request and fulfilling it would make the result confusing or misleading. Each API will specify which parameters or combination of parameters can be used at the same time. ### HTTP 503 - \"Service Unavailable\" The server is currently unable to handle the request due to a temporary overloading or maintenance of the server. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay MAY be indicated in a `Retry-After` header. This code will not always appear, sometimes the server may outright refuse the connection instead. This is a code sent directly by the server, and has no special alternate definition specific to this API. ## Authorization In order to make calls against the FTC Events API, you must include an HTTP Header called `Authorization` with the value set as specified below. If a request is made without this header, processing stops and an HTTP 401 is issued. All `Authorization` headers follow the same format: ``` Authorization: Basic 000000000000000000000000000000000000000000000000000000000000 ``` Where the Zeros are replaced by your Token. The Token can be formed by taking your username and your AuthorizationKey and adding a colon. For example, if your username is `sampleuser` and your AuthorizationKey is `7eaa6338-a097-4221-ac04-b6120fcc4d49` you would have this string: ``` sampleuser:7eaa6338-a097-4221-ac04-b6120fcc4d49 ``` This string must then be encoded using Base64 Encoded to form the Token, which will be the same length as the example above, but include letters and numbers. For our example, we would have: ``` c2FtcGxldXNlcjo3ZWFhNjMzOC1hMDk3LTQyMjEtYWMwNC1iNjEyMGZjYzRkNDk= ``` Most API client libraries can handle computing the authorization header using a username and password for you NOTICE: Publicly distributing an application, code snippet, etc, that has your username and token in it, encoded or not, WILL result in your token being blocked from the API. Each user should apply for their own token. If you wish to acquire a token for your development, you may do so by requesting a token through our automated system on this website.
|
5
5
|
|
6
|
-
|
7
|
-
|
8
|
-
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
6
|
+
OpenAPI spec version: v2.0
|
10
7
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 3.0.29
|
11
10
|
=end
|
12
11
|
|
13
12
|
require 'date'
|
14
|
-
require 'time'
|
15
13
|
|
16
14
|
module FtcEventsClient
|
17
15
|
class AllianceModelVersion2
|
@@ -45,22 +43,17 @@ module FtcEventsClient
|
|
45
43
|
}
|
46
44
|
end
|
47
45
|
|
48
|
-
# Returns all the JSON keys this model knows about
|
49
|
-
def self.acceptable_attributes
|
50
|
-
attribute_map.values
|
51
|
-
end
|
52
|
-
|
53
46
|
# Attribute type mapping.
|
54
47
|
def self.openapi_types
|
55
48
|
{
|
56
|
-
:'number' => :'
|
57
|
-
:'name' => :'
|
58
|
-
:'captain' => :'
|
59
|
-
:'round1' => :'
|
60
|
-
:'round2' => :'
|
61
|
-
:'round3' => :'
|
62
|
-
:'backup' => :'
|
63
|
-
:'backup_replaced' => :'
|
49
|
+
:'number' => :'Object',
|
50
|
+
:'name' => :'Object',
|
51
|
+
:'captain' => :'Object',
|
52
|
+
:'round1' => :'Object',
|
53
|
+
:'round2' => :'Object',
|
54
|
+
:'round3' => :'Object',
|
55
|
+
:'backup' => :'Object',
|
56
|
+
:'backup_replaced' => :'Object'
|
64
57
|
}
|
65
58
|
end
|
66
59
|
|
@@ -76,7 +69,7 @@ module FtcEventsClient
|
|
76
69
|
:'backup_replaced'
|
77
70
|
])
|
78
71
|
end
|
79
|
-
|
72
|
+
|
80
73
|
# Initializes the object
|
81
74
|
# @param [Hash] attributes Model attributes in the form of hash
|
82
75
|
def initialize(attributes = {})
|
@@ -178,9 +171,7 @@ module FtcEventsClient
|
|
178
171
|
def build_from_hash(attributes)
|
179
172
|
return nil unless attributes.is_a?(Hash)
|
180
173
|
self.class.openapi_types.each_pair do |key, type|
|
181
|
-
if
|
182
|
-
self.send("#{key}=", nil)
|
183
|
-
elsif type =~ /\AArray<(.*)>/i
|
174
|
+
if type =~ /\AArray<(.*)>/i
|
184
175
|
# check to ensure the input is an array given that the attribute
|
185
176
|
# is documented as an array but the input is not
|
186
177
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -188,6 +179,8 @@ module FtcEventsClient
|
|
188
179
|
end
|
189
180
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
190
181
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
182
|
+
elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
183
|
+
self.send("#{key}=", nil)
|
191
184
|
end
|
192
185
|
end
|
193
186
|
|
@@ -200,8 +193,8 @@ module FtcEventsClient
|
|
200
193
|
# @return [Object] Deserialized data
|
201
194
|
def _deserialize(type, value)
|
202
195
|
case type.to_sym
|
203
|
-
when :
|
204
|
-
|
196
|
+
when :DateTime
|
197
|
+
DateTime.parse(value)
|
205
198
|
when :Date
|
206
199
|
Date.parse(value)
|
207
200
|
when :String
|
@@ -231,9 +224,7 @@ module FtcEventsClient
|
|
231
224
|
end
|
232
225
|
end
|
233
226
|
else # model
|
234
|
-
|
235
|
-
klass = FtcEventsClient.const_get(type)
|
236
|
-
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
227
|
+
FtcEventsClient.const_get(type).build_from_hash(value)
|
237
228
|
end
|
238
229
|
end
|
239
230
|
|
@@ -281,8 +272,5 @@ module FtcEventsClient
|
|
281
272
|
else
|
282
273
|
value
|
283
274
|
end
|
284
|
-
end
|
285
|
-
|
286
|
-
end
|
287
|
-
|
275
|
+
end end
|
288
276
|
end
|
@@ -3,15 +3,13 @@
|
|
3
3
|
|
4
4
|
#FTC Events API is a service to return relevant information about the _FIRST_ Tech Challenge (FTC). Information is made available from events operating around the world Information is currently made available after the conclusion of the tournament. The API will provide data as soon as it has synced, and we do not add any artificial delays. ## Documentation Notes ### Timezones All times are listed in the local time to the event venue. HTTP-date values will show their timezone. ### Query Parameters If you specify a parameter, but no value for that parameter, it will be ignored. For example, if you request `URL?teamNumber=` the `teamNumber` parameter would be ignored. For all APIs that accept a query string in addition to the base URI, the order of parameters do not matter, but the name shown in the documentation must match exactly, as does the associated value format as described in details. For response codes that are not HTTP 200 (OK), the documentation will show a body message that represents a possible response value. While the \"title\" of the HTTP Status Code will match those shown in the response codes documentation section exactly, the body of the response will be a more detailed explanation of why that status code is being returned and may not always be exactly as shown in the examples. ### Experimenting with the API This documentation is rendered at both [api-docs](https://ftc-events.firstinspires.org/api-docs) and [try-it-out](https://ftc-events.firstinspires.org/try-it-out). [api-docs](https://ftc-events.firstinspires.org/api-docs) has a three panel, easy to read layout, while [try-it-out](https://ftc-events.firstinspires.org/try-it-out) has a feature that allows you try out endpoints from within the page. Additionally, the Open API Json is availabe at [Open API](https://ftc-events.firstinspires.org/swagger/v2.0/swagger.json). This can be imported into a tool such as [Postman](https://www.postman.com) for experimentation as well. ### Last-Modified, FMS-OnlyModifiedSince, and If-Modified-Since Headers The FTC Events API utilizes the `Last-Modified` and `If-Modified-Since` Headers to communicate with consumers regarding the age of the data they are requesting. With a couple of exceptions, all calls will return a `Last-Modified` Header set with the time at which the data at that endpoint was last modified. The Header will always be set in the HTTP-date format, as described in the HTTP Protocol. There are two exceptions: the `Last-Modified` Header is not set if the endpoint returns no results (such as a request for a schedule with no matches). Consumers should keep track of the `Last-Modified` Header, and return it on subsequent calls to the same endpoint as the If-Modified-Since. The server will recognize this request, and will only return a result if the data has been modified since the last request. If no changes have been made, an HTTP 304 will be returned. If data has been modified, ALL data on that call will be returned (for \"only modified\" data, see below). The FTC Events API also allows a custom header used to filter the return data to a specific subset. This is done by specifying a `FMS-OnlyModifiedSince` header with each call. As with the `If-Modified-Since` header, consumers should keep track of the Last-Modified Header, and return it on subsequent calls to the same endpoint as the `FMS-OnlyModifiedSince` Header. The server will recognize this request, and will only return a result if the data has been modified since the last request, and, if returned, the data will only be those portions modified since the included date. If no changes, have been made, an HTTP 304 will be returned. Using this method, the server and consumer save processing time by only receiving modified data that is in need of update on the consumer side. If the Headers are improperly passed (such as the wrong Day of Week for the matching date, or a date in the future), the endpoint will simply ignore the Header and return all results. If both headers are specified, the request will be denied. ## Response Codes The FTC Events API HTTP Status Codes correspond with the [common codes](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html), but occasionally with different \"titles\". The \"title\" used by the API is shown next to each of the below possible response HTTP Status Codes. Throughout the documentation, Apiary may automatically show the common \"title\" in example returns (like \"Not Found\" for 404) but on the production server, the \"title\" will instead match those listed below. ### HTTP 200 - \"OK\" The request has succeeded. An entity corresponding to the requested resource is sent in the response. This will be returned as the HTTP Status Code for all request that succeed, even if the body is empty (such as an event that has no rankings, but with a valid season and event code were used) ### HTTP 304 - \"Not Modified\" When utilizing a Header that allows filtered data returns, such as `If-Modified-Since`, this response indicates that no data meets the request. ### HTTP 400 - \"Invalid Season Requested\"/\"Malformed Parameter Format In Request\"/\"Missing Parameter In Request\"/\"Invalid API Version Requested\": The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications. Specifically for this API, a 400 response indicates that the requested URI matches with a valid API, but one or more required parameter was malformed or invalid. Examples include an event code that is too short or team number that contains a letter. ### HTTP 401 - \"Unauthorized\" All requests against the API require authentication via a valid user token. Failing to provide one, or providing an invalid one, will warrant a 401 response. The client MAY repeat the request with a suitable Authorization header field. ### HTTP 404 - \"Invalid Event Requested\" Even though the 404 code usually indicates any not found status, a 404 will only be issued in this API when an event cannot be found for the requested season and event code. If the request didn't match a valid API or there were malformed parameters, the response would not receive a 404 but rather a 400 or 501. If this HTTP code is received, the season was a valid season and the event code matched the acceptable style of an event code, but there were no records of an event matching the combination of that season and event code. For example, HTTP 404 would be issued when the event had a different code in the requested season (the codes can change year to year based on event location). ### HTTP 500 - \"Internal Server Error\" The server encountered an unexpected condition which prevented it from fulfilling the request. This is a code sent directly by the server, and has no special alternate definition specific to this API. ### HTTP 501 - \"Request Did Not Match Any Current API Pattern\" The server does not support the functionality required to fulfill the request. Specifically, the request pattern did not match any of the possible APIs, and thus processing was discontinued. This code is also issued when too many optional parameters were included in a single request and fulfilling it would make the result confusing or misleading. Each API will specify which parameters or combination of parameters can be used at the same time. ### HTTP 503 - \"Service Unavailable\" The server is currently unable to handle the request due to a temporary overloading or maintenance of the server. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay MAY be indicated in a `Retry-After` header. This code will not always appear, sometimes the server may outright refuse the connection instead. This is a code sent directly by the server, and has no special alternate definition specific to this API. ## Authorization In order to make calls against the FTC Events API, you must include an HTTP Header called `Authorization` with the value set as specified below. If a request is made without this header, processing stops and an HTTP 401 is issued. All `Authorization` headers follow the same format: ``` Authorization: Basic 000000000000000000000000000000000000000000000000000000000000 ``` Where the Zeros are replaced by your Token. The Token can be formed by taking your username and your AuthorizationKey and adding a colon. For example, if your username is `sampleuser` and your AuthorizationKey is `7eaa6338-a097-4221-ac04-b6120fcc4d49` you would have this string: ``` sampleuser:7eaa6338-a097-4221-ac04-b6120fcc4d49 ``` This string must then be encoded using Base64 Encoded to form the Token, which will be the same length as the example above, but include letters and numbers. For our example, we would have: ``` c2FtcGxldXNlcjo3ZWFhNjMzOC1hMDk3LTQyMjEtYWMwNC1iNjEyMGZjYzRkNDk= ``` Most API client libraries can handle computing the authorization header using a username and password for you NOTICE: Publicly distributing an application, code snippet, etc, that has your username and token in it, encoded or not, WILL result in your token being blocked from the API. Each user should apply for their own token. If you wish to acquire a token for your development, you may do so by requesting a token through our automated system on this website.
|
5
5
|
|
6
|
-
|
7
|
-
|
8
|
-
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
6
|
+
OpenAPI spec version: v2.0
|
10
7
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 3.0.29
|
11
10
|
=end
|
12
11
|
|
13
12
|
require 'date'
|
14
|
-
require 'time'
|
15
13
|
|
16
14
|
module FtcEventsClient
|
17
15
|
class AllianceScore2020
|
@@ -126,49 +124,44 @@ module FtcEventsClient
|
|
126
124
|
}
|
127
125
|
end
|
128
126
|
|
129
|
-
# Returns all the JSON keys this model knows about
|
130
|
-
def self.acceptable_attributes
|
131
|
-
attribute_map.values
|
132
|
-
end
|
133
|
-
|
134
127
|
# Attribute type mapping.
|
135
128
|
def self.openapi_types
|
136
129
|
{
|
137
|
-
:'adjust' => :'
|
138
|
-
:'dc_points' => :'
|
139
|
-
:'auto_points' => :'
|
140
|
-
:'dc_tower_low' => :'
|
141
|
-
:'dc_tower_mid' => :'
|
142
|
-
:'dc_tower_high' => :'
|
143
|
-
:'navigated1' => :'
|
144
|
-
:'navigated2' => :'
|
145
|
-
:'wobble_delivered1' => :'
|
146
|
-
:'wobble_delivered2' => :'
|
147
|
-
:'auto_tower_low' => :'
|
148
|
-
:'auto_tower_mid' => :'
|
149
|
-
:'auto_tower_high' => :'
|
150
|
-
:'auto_tower_points' => :'
|
151
|
-
:'auto_power_shot_left' => :'
|
152
|
-
:'auto_power_shot_center' => :'
|
153
|
-
:'auto_power_shot_right' => :'
|
154
|
-
:'auto_power_shot_points' => :'
|
155
|
-
:'wobble_rings1' => :'
|
156
|
-
:'wobble_rings2' => :'
|
157
|
-
:'wobble_end1' => :'
|
158
|
-
:'wobble_end2' => :'
|
159
|
-
:'wobble_end_points' => :'
|
160
|
-
:'wobble_ring_points' => :'
|
161
|
-
:'auto_wobble_points' => :'
|
162
|
-
:'end_power_shot_left' => :'
|
163
|
-
:'end_power_shot_center' => :'
|
164
|
-
:'end_power_shot_right' => :'
|
165
|
-
:'end_power_shot_points' => :'
|
166
|
-
:'penalty_points' => :'
|
167
|
-
:'major_penalties' => :'
|
168
|
-
:'minor_penalties' => :'
|
169
|
-
:'navigation_points' => :'
|
170
|
-
:'endgame_points' => :'
|
171
|
-
:'total_points' => :'
|
130
|
+
:'adjust' => :'Object',
|
131
|
+
:'dc_points' => :'Object',
|
132
|
+
:'auto_points' => :'Object',
|
133
|
+
:'dc_tower_low' => :'Object',
|
134
|
+
:'dc_tower_mid' => :'Object',
|
135
|
+
:'dc_tower_high' => :'Object',
|
136
|
+
:'navigated1' => :'Object',
|
137
|
+
:'navigated2' => :'Object',
|
138
|
+
:'wobble_delivered1' => :'Object',
|
139
|
+
:'wobble_delivered2' => :'Object',
|
140
|
+
:'auto_tower_low' => :'Object',
|
141
|
+
:'auto_tower_mid' => :'Object',
|
142
|
+
:'auto_tower_high' => :'Object',
|
143
|
+
:'auto_tower_points' => :'Object',
|
144
|
+
:'auto_power_shot_left' => :'Object',
|
145
|
+
:'auto_power_shot_center' => :'Object',
|
146
|
+
:'auto_power_shot_right' => :'Object',
|
147
|
+
:'auto_power_shot_points' => :'Object',
|
148
|
+
:'wobble_rings1' => :'Object',
|
149
|
+
:'wobble_rings2' => :'Object',
|
150
|
+
:'wobble_end1' => :'Object',
|
151
|
+
:'wobble_end2' => :'Object',
|
152
|
+
:'wobble_end_points' => :'Object',
|
153
|
+
:'wobble_ring_points' => :'Object',
|
154
|
+
:'auto_wobble_points' => :'Object',
|
155
|
+
:'end_power_shot_left' => :'Object',
|
156
|
+
:'end_power_shot_center' => :'Object',
|
157
|
+
:'end_power_shot_right' => :'Object',
|
158
|
+
:'end_power_shot_points' => :'Object',
|
159
|
+
:'penalty_points' => :'Object',
|
160
|
+
:'major_penalties' => :'Object',
|
161
|
+
:'minor_penalties' => :'Object',
|
162
|
+
:'navigation_points' => :'Object',
|
163
|
+
:'endgame_points' => :'Object',
|
164
|
+
:'total_points' => :'Object'
|
172
165
|
}
|
173
166
|
end
|
174
167
|
|
@@ -177,7 +170,7 @@ module FtcEventsClient
|
|
177
170
|
Set.new([
|
178
171
|
])
|
179
172
|
end
|
180
|
-
|
173
|
+
|
181
174
|
# Initializes the object
|
182
175
|
# @param [Hash] attributes Model attributes in the form of hash
|
183
176
|
def initialize(attributes = {})
|
@@ -414,9 +407,7 @@ module FtcEventsClient
|
|
414
407
|
def build_from_hash(attributes)
|
415
408
|
return nil unless attributes.is_a?(Hash)
|
416
409
|
self.class.openapi_types.each_pair do |key, type|
|
417
|
-
if
|
418
|
-
self.send("#{key}=", nil)
|
419
|
-
elsif type =~ /\AArray<(.*)>/i
|
410
|
+
if type =~ /\AArray<(.*)>/i
|
420
411
|
# check to ensure the input is an array given that the attribute
|
421
412
|
# is documented as an array but the input is not
|
422
413
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -424,6 +415,8 @@ module FtcEventsClient
|
|
424
415
|
end
|
425
416
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
426
417
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
418
|
+
elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
419
|
+
self.send("#{key}=", nil)
|
427
420
|
end
|
428
421
|
end
|
429
422
|
|
@@ -436,8 +429,8 @@ module FtcEventsClient
|
|
436
429
|
# @return [Object] Deserialized data
|
437
430
|
def _deserialize(type, value)
|
438
431
|
case type.to_sym
|
439
|
-
when :
|
440
|
-
|
432
|
+
when :DateTime
|
433
|
+
DateTime.parse(value)
|
441
434
|
when :Date
|
442
435
|
Date.parse(value)
|
443
436
|
when :String
|
@@ -467,9 +460,7 @@ module FtcEventsClient
|
|
467
460
|
end
|
468
461
|
end
|
469
462
|
else # model
|
470
|
-
|
471
|
-
klass = FtcEventsClient.const_get(type)
|
472
|
-
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
463
|
+
FtcEventsClient.const_get(type).build_from_hash(value)
|
473
464
|
end
|
474
465
|
end
|
475
466
|
|
@@ -517,8 +508,5 @@ module FtcEventsClient
|
|
517
508
|
else
|
518
509
|
value
|
519
510
|
end
|
520
|
-
end
|
521
|
-
|
522
|
-
end
|
523
|
-
|
511
|
+
end end
|
524
512
|
end
|
@@ -3,15 +3,13 @@
|
|
3
3
|
|
4
4
|
#FTC Events API is a service to return relevant information about the _FIRST_ Tech Challenge (FTC). Information is made available from events operating around the world Information is currently made available after the conclusion of the tournament. The API will provide data as soon as it has synced, and we do not add any artificial delays. ## Documentation Notes ### Timezones All times are listed in the local time to the event venue. HTTP-date values will show their timezone. ### Query Parameters If you specify a parameter, but no value for that parameter, it will be ignored. For example, if you request `URL?teamNumber=` the `teamNumber` parameter would be ignored. For all APIs that accept a query string in addition to the base URI, the order of parameters do not matter, but the name shown in the documentation must match exactly, as does the associated value format as described in details. For response codes that are not HTTP 200 (OK), the documentation will show a body message that represents a possible response value. While the \"title\" of the HTTP Status Code will match those shown in the response codes documentation section exactly, the body of the response will be a more detailed explanation of why that status code is being returned and may not always be exactly as shown in the examples. ### Experimenting with the API This documentation is rendered at both [api-docs](https://ftc-events.firstinspires.org/api-docs) and [try-it-out](https://ftc-events.firstinspires.org/try-it-out). [api-docs](https://ftc-events.firstinspires.org/api-docs) has a three panel, easy to read layout, while [try-it-out](https://ftc-events.firstinspires.org/try-it-out) has a feature that allows you try out endpoints from within the page. Additionally, the Open API Json is availabe at [Open API](https://ftc-events.firstinspires.org/swagger/v2.0/swagger.json). This can be imported into a tool such as [Postman](https://www.postman.com) for experimentation as well. ### Last-Modified, FMS-OnlyModifiedSince, and If-Modified-Since Headers The FTC Events API utilizes the `Last-Modified` and `If-Modified-Since` Headers to communicate with consumers regarding the age of the data they are requesting. With a couple of exceptions, all calls will return a `Last-Modified` Header set with the time at which the data at that endpoint was last modified. The Header will always be set in the HTTP-date format, as described in the HTTP Protocol. There are two exceptions: the `Last-Modified` Header is not set if the endpoint returns no results (such as a request for a schedule with no matches). Consumers should keep track of the `Last-Modified` Header, and return it on subsequent calls to the same endpoint as the If-Modified-Since. The server will recognize this request, and will only return a result if the data has been modified since the last request. If no changes have been made, an HTTP 304 will be returned. If data has been modified, ALL data on that call will be returned (for \"only modified\" data, see below). The FTC Events API also allows a custom header used to filter the return data to a specific subset. This is done by specifying a `FMS-OnlyModifiedSince` header with each call. As with the `If-Modified-Since` header, consumers should keep track of the Last-Modified Header, and return it on subsequent calls to the same endpoint as the `FMS-OnlyModifiedSince` Header. The server will recognize this request, and will only return a result if the data has been modified since the last request, and, if returned, the data will only be those portions modified since the included date. If no changes, have been made, an HTTP 304 will be returned. Using this method, the server and consumer save processing time by only receiving modified data that is in need of update on the consumer side. If the Headers are improperly passed (such as the wrong Day of Week for the matching date, or a date in the future), the endpoint will simply ignore the Header and return all results. If both headers are specified, the request will be denied. ## Response Codes The FTC Events API HTTP Status Codes correspond with the [common codes](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html), but occasionally with different \"titles\". The \"title\" used by the API is shown next to each of the below possible response HTTP Status Codes. Throughout the documentation, Apiary may automatically show the common \"title\" in example returns (like \"Not Found\" for 404) but on the production server, the \"title\" will instead match those listed below. ### HTTP 200 - \"OK\" The request has succeeded. An entity corresponding to the requested resource is sent in the response. This will be returned as the HTTP Status Code for all request that succeed, even if the body is empty (such as an event that has no rankings, but with a valid season and event code were used) ### HTTP 304 - \"Not Modified\" When utilizing a Header that allows filtered data returns, such as `If-Modified-Since`, this response indicates that no data meets the request. ### HTTP 400 - \"Invalid Season Requested\"/\"Malformed Parameter Format In Request\"/\"Missing Parameter In Request\"/\"Invalid API Version Requested\": The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications. Specifically for this API, a 400 response indicates that the requested URI matches with a valid API, but one or more required parameter was malformed or invalid. Examples include an event code that is too short or team number that contains a letter. ### HTTP 401 - \"Unauthorized\" All requests against the API require authentication via a valid user token. Failing to provide one, or providing an invalid one, will warrant a 401 response. The client MAY repeat the request with a suitable Authorization header field. ### HTTP 404 - \"Invalid Event Requested\" Even though the 404 code usually indicates any not found status, a 404 will only be issued in this API when an event cannot be found for the requested season and event code. If the request didn't match a valid API or there were malformed parameters, the response would not receive a 404 but rather a 400 or 501. If this HTTP code is received, the season was a valid season and the event code matched the acceptable style of an event code, but there were no records of an event matching the combination of that season and event code. For example, HTTP 404 would be issued when the event had a different code in the requested season (the codes can change year to year based on event location). ### HTTP 500 - \"Internal Server Error\" The server encountered an unexpected condition which prevented it from fulfilling the request. This is a code sent directly by the server, and has no special alternate definition specific to this API. ### HTTP 501 - \"Request Did Not Match Any Current API Pattern\" The server does not support the functionality required to fulfill the request. Specifically, the request pattern did not match any of the possible APIs, and thus processing was discontinued. This code is also issued when too many optional parameters were included in a single request and fulfilling it would make the result confusing or misleading. Each API will specify which parameters or combination of parameters can be used at the same time. ### HTTP 503 - \"Service Unavailable\" The server is currently unable to handle the request due to a temporary overloading or maintenance of the server. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay MAY be indicated in a `Retry-After` header. This code will not always appear, sometimes the server may outright refuse the connection instead. This is a code sent directly by the server, and has no special alternate definition specific to this API. ## Authorization In order to make calls against the FTC Events API, you must include an HTTP Header called `Authorization` with the value set as specified below. If a request is made without this header, processing stops and an HTTP 401 is issued. All `Authorization` headers follow the same format: ``` Authorization: Basic 000000000000000000000000000000000000000000000000000000000000 ``` Where the Zeros are replaced by your Token. The Token can be formed by taking your username and your AuthorizationKey and adding a colon. For example, if your username is `sampleuser` and your AuthorizationKey is `7eaa6338-a097-4221-ac04-b6120fcc4d49` you would have this string: ``` sampleuser:7eaa6338-a097-4221-ac04-b6120fcc4d49 ``` This string must then be encoded using Base64 Encoded to form the Token, which will be the same length as the example above, but include letters and numbers. For our example, we would have: ``` c2FtcGxldXNlcjo3ZWFhNjMzOC1hMDk3LTQyMjEtYWMwNC1iNjEyMGZjYzRkNDk= ``` Most API client libraries can handle computing the authorization header using a username and password for you NOTICE: Publicly distributing an application, code snippet, etc, that has your username and token in it, encoded or not, WILL result in your token being blocked from the API. Each user should apply for their own token. If you wish to acquire a token for your development, you may do so by requesting a token through our automated system on this website.
|
5
5
|
|
6
|
-
|
7
|
-
|
8
|
-
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
6
|
+
OpenAPI spec version: v2.0
|
10
7
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 3.0.29
|
11
10
|
=end
|
12
11
|
|
13
12
|
require 'date'
|
14
|
-
require 'time'
|
15
13
|
|
16
14
|
module FtcEventsClient
|
17
15
|
class AllianceSelectionModelVersion2
|
@@ -27,16 +25,11 @@ module FtcEventsClient
|
|
27
25
|
}
|
28
26
|
end
|
29
27
|
|
30
|
-
# Returns all the JSON keys this model knows about
|
31
|
-
def self.acceptable_attributes
|
32
|
-
attribute_map.values
|
33
|
-
end
|
34
|
-
|
35
28
|
# Attribute type mapping.
|
36
29
|
def self.openapi_types
|
37
30
|
{
|
38
|
-
:'alliances' => :'
|
39
|
-
:'count' => :'
|
31
|
+
:'alliances' => :'Object',
|
32
|
+
:'count' => :'Object'
|
40
33
|
}
|
41
34
|
end
|
42
35
|
|
@@ -46,7 +39,7 @@ module FtcEventsClient
|
|
46
39
|
:'alliances',
|
47
40
|
])
|
48
41
|
end
|
49
|
-
|
42
|
+
|
50
43
|
# Initializes the object
|
51
44
|
# @param [Hash] attributes Model attributes in the form of hash
|
52
45
|
def initialize(attributes = {})
|
@@ -120,9 +113,7 @@ module FtcEventsClient
|
|
120
113
|
def build_from_hash(attributes)
|
121
114
|
return nil unless attributes.is_a?(Hash)
|
122
115
|
self.class.openapi_types.each_pair do |key, type|
|
123
|
-
if
|
124
|
-
self.send("#{key}=", nil)
|
125
|
-
elsif type =~ /\AArray<(.*)>/i
|
116
|
+
if type =~ /\AArray<(.*)>/i
|
126
117
|
# check to ensure the input is an array given that the attribute
|
127
118
|
# is documented as an array but the input is not
|
128
119
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -130,6 +121,8 @@ module FtcEventsClient
|
|
130
121
|
end
|
131
122
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
132
123
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
124
|
+
elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
125
|
+
self.send("#{key}=", nil)
|
133
126
|
end
|
134
127
|
end
|
135
128
|
|
@@ -142,8 +135,8 @@ module FtcEventsClient
|
|
142
135
|
# @return [Object] Deserialized data
|
143
136
|
def _deserialize(type, value)
|
144
137
|
case type.to_sym
|
145
|
-
when :
|
146
|
-
|
138
|
+
when :DateTime
|
139
|
+
DateTime.parse(value)
|
147
140
|
when :Date
|
148
141
|
Date.parse(value)
|
149
142
|
when :String
|
@@ -173,9 +166,7 @@ module FtcEventsClient
|
|
173
166
|
end
|
174
167
|
end
|
175
168
|
else # model
|
176
|
-
|
177
|
-
klass = FtcEventsClient.const_get(type)
|
178
|
-
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
169
|
+
FtcEventsClient.const_get(type).build_from_hash(value)
|
179
170
|
end
|
180
171
|
end
|
181
172
|
|
@@ -223,8 +214,5 @@ module FtcEventsClient
|
|
223
214
|
else
|
224
215
|
value
|
225
216
|
end
|
226
|
-
end
|
227
|
-
|
228
|
-
end
|
229
|
-
|
217
|
+
end end
|
230
218
|
end
|
@@ -3,15 +3,13 @@
|
|
3
3
|
|
4
4
|
#FTC Events API is a service to return relevant information about the _FIRST_ Tech Challenge (FTC). Information is made available from events operating around the world Information is currently made available after the conclusion of the tournament. The API will provide data as soon as it has synced, and we do not add any artificial delays. ## Documentation Notes ### Timezones All times are listed in the local time to the event venue. HTTP-date values will show their timezone. ### Query Parameters If you specify a parameter, but no value for that parameter, it will be ignored. For example, if you request `URL?teamNumber=` the `teamNumber` parameter would be ignored. For all APIs that accept a query string in addition to the base URI, the order of parameters do not matter, but the name shown in the documentation must match exactly, as does the associated value format as described in details. For response codes that are not HTTP 200 (OK), the documentation will show a body message that represents a possible response value. While the \"title\" of the HTTP Status Code will match those shown in the response codes documentation section exactly, the body of the response will be a more detailed explanation of why that status code is being returned and may not always be exactly as shown in the examples. ### Experimenting with the API This documentation is rendered at both [api-docs](https://ftc-events.firstinspires.org/api-docs) and [try-it-out](https://ftc-events.firstinspires.org/try-it-out). [api-docs](https://ftc-events.firstinspires.org/api-docs) has a three panel, easy to read layout, while [try-it-out](https://ftc-events.firstinspires.org/try-it-out) has a feature that allows you try out endpoints from within the page. Additionally, the Open API Json is availabe at [Open API](https://ftc-events.firstinspires.org/swagger/v2.0/swagger.json). This can be imported into a tool such as [Postman](https://www.postman.com) for experimentation as well. ### Last-Modified, FMS-OnlyModifiedSince, and If-Modified-Since Headers The FTC Events API utilizes the `Last-Modified` and `If-Modified-Since` Headers to communicate with consumers regarding the age of the data they are requesting. With a couple of exceptions, all calls will return a `Last-Modified` Header set with the time at which the data at that endpoint was last modified. The Header will always be set in the HTTP-date format, as described in the HTTP Protocol. There are two exceptions: the `Last-Modified` Header is not set if the endpoint returns no results (such as a request for a schedule with no matches). Consumers should keep track of the `Last-Modified` Header, and return it on subsequent calls to the same endpoint as the If-Modified-Since. The server will recognize this request, and will only return a result if the data has been modified since the last request. If no changes have been made, an HTTP 304 will be returned. If data has been modified, ALL data on that call will be returned (for \"only modified\" data, see below). The FTC Events API also allows a custom header used to filter the return data to a specific subset. This is done by specifying a `FMS-OnlyModifiedSince` header with each call. As with the `If-Modified-Since` header, consumers should keep track of the Last-Modified Header, and return it on subsequent calls to the same endpoint as the `FMS-OnlyModifiedSince` Header. The server will recognize this request, and will only return a result if the data has been modified since the last request, and, if returned, the data will only be those portions modified since the included date. If no changes, have been made, an HTTP 304 will be returned. Using this method, the server and consumer save processing time by only receiving modified data that is in need of update on the consumer side. If the Headers are improperly passed (such as the wrong Day of Week for the matching date, or a date in the future), the endpoint will simply ignore the Header and return all results. If both headers are specified, the request will be denied. ## Response Codes The FTC Events API HTTP Status Codes correspond with the [common codes](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html), but occasionally with different \"titles\". The \"title\" used by the API is shown next to each of the below possible response HTTP Status Codes. Throughout the documentation, Apiary may automatically show the common \"title\" in example returns (like \"Not Found\" for 404) but on the production server, the \"title\" will instead match those listed below. ### HTTP 200 - \"OK\" The request has succeeded. An entity corresponding to the requested resource is sent in the response. This will be returned as the HTTP Status Code for all request that succeed, even if the body is empty (such as an event that has no rankings, but with a valid season and event code were used) ### HTTP 304 - \"Not Modified\" When utilizing a Header that allows filtered data returns, such as `If-Modified-Since`, this response indicates that no data meets the request. ### HTTP 400 - \"Invalid Season Requested\"/\"Malformed Parameter Format In Request\"/\"Missing Parameter In Request\"/\"Invalid API Version Requested\": The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications. Specifically for this API, a 400 response indicates that the requested URI matches with a valid API, but one or more required parameter was malformed or invalid. Examples include an event code that is too short or team number that contains a letter. ### HTTP 401 - \"Unauthorized\" All requests against the API require authentication via a valid user token. Failing to provide one, or providing an invalid one, will warrant a 401 response. The client MAY repeat the request with a suitable Authorization header field. ### HTTP 404 - \"Invalid Event Requested\" Even though the 404 code usually indicates any not found status, a 404 will only be issued in this API when an event cannot be found for the requested season and event code. If the request didn't match a valid API or there were malformed parameters, the response would not receive a 404 but rather a 400 or 501. If this HTTP code is received, the season was a valid season and the event code matched the acceptable style of an event code, but there were no records of an event matching the combination of that season and event code. For example, HTTP 404 would be issued when the event had a different code in the requested season (the codes can change year to year based on event location). ### HTTP 500 - \"Internal Server Error\" The server encountered an unexpected condition which prevented it from fulfilling the request. This is a code sent directly by the server, and has no special alternate definition specific to this API. ### HTTP 501 - \"Request Did Not Match Any Current API Pattern\" The server does not support the functionality required to fulfill the request. Specifically, the request pattern did not match any of the possible APIs, and thus processing was discontinued. This code is also issued when too many optional parameters were included in a single request and fulfilling it would make the result confusing or misleading. Each API will specify which parameters or combination of parameters can be used at the same time. ### HTTP 503 - \"Service Unavailable\" The server is currently unable to handle the request due to a temporary overloading or maintenance of the server. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay MAY be indicated in a `Retry-After` header. This code will not always appear, sometimes the server may outright refuse the connection instead. This is a code sent directly by the server, and has no special alternate definition specific to this API. ## Authorization In order to make calls against the FTC Events API, you must include an HTTP Header called `Authorization` with the value set as specified below. If a request is made without this header, processing stops and an HTTP 401 is issued. All `Authorization` headers follow the same format: ``` Authorization: Basic 000000000000000000000000000000000000000000000000000000000000 ``` Where the Zeros are replaced by your Token. The Token can be formed by taking your username and your AuthorizationKey and adding a colon. For example, if your username is `sampleuser` and your AuthorizationKey is `7eaa6338-a097-4221-ac04-b6120fcc4d49` you would have this string: ``` sampleuser:7eaa6338-a097-4221-ac04-b6120fcc4d49 ``` This string must then be encoded using Base64 Encoded to form the Token, which will be the same length as the example above, but include letters and numbers. For our example, we would have: ``` c2FtcGxldXNlcjo3ZWFhNjMzOC1hMDk3LTQyMjEtYWMwNC1iNjEyMGZjYzRkNDk= ``` Most API client libraries can handle computing the authorization header using a username and password for you NOTICE: Publicly distributing an application, code snippet, etc, that has your username and token in it, encoded or not, WILL result in your token being blocked from the API. Each user should apply for their own token. If you wish to acquire a token for your development, you may do so by requesting a token through our automated system on this website.
|
5
5
|
|
6
|
-
|
7
|
-
|
8
|
-
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
6
|
+
OpenAPI spec version: v2.0
|
10
7
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 3.0.29
|
11
10
|
=end
|
12
11
|
|
13
12
|
require 'date'
|
14
|
-
require 'time'
|
15
13
|
|
16
14
|
module FtcEventsClient
|
17
15
|
class ApiIndexModel
|
@@ -52,23 +50,18 @@ module FtcEventsClient
|
|
52
50
|
}
|
53
51
|
end
|
54
52
|
|
55
|
-
# Returns all the JSON keys this model knows about
|
56
|
-
def self.acceptable_attributes
|
57
|
-
attribute_map.values
|
58
|
-
end
|
59
|
-
|
60
53
|
# Attribute type mapping.
|
61
54
|
def self.openapi_types
|
62
55
|
{
|
63
|
-
:'name' => :'
|
64
|
-
:'api_version' => :'
|
65
|
-
:'service_mainifest_name' => :'
|
66
|
-
:'service_mainifest_version' => :'
|
67
|
-
:'code_package_name' => :'
|
68
|
-
:'code_package_version' => :'
|
69
|
-
:'status' => :'
|
70
|
-
:'current_season' => :'
|
71
|
-
:'max_season' => :'
|
56
|
+
:'name' => :'Object',
|
57
|
+
:'api_version' => :'Object',
|
58
|
+
:'service_mainifest_name' => :'Object',
|
59
|
+
:'service_mainifest_version' => :'Object',
|
60
|
+
:'code_package_name' => :'Object',
|
61
|
+
:'code_package_version' => :'Object',
|
62
|
+
:'status' => :'Object',
|
63
|
+
:'current_season' => :'Object',
|
64
|
+
:'max_season' => :'Object'
|
72
65
|
}
|
73
66
|
end
|
74
67
|
|
@@ -84,7 +77,7 @@ module FtcEventsClient
|
|
84
77
|
:'status',
|
85
78
|
])
|
86
79
|
end
|
87
|
-
|
80
|
+
|
88
81
|
# Initializes the object
|
89
82
|
# @param [Hash] attributes Model attributes in the form of hash
|
90
83
|
def initialize(attributes = {})
|
@@ -191,9 +184,7 @@ module FtcEventsClient
|
|
191
184
|
def build_from_hash(attributes)
|
192
185
|
return nil unless attributes.is_a?(Hash)
|
193
186
|
self.class.openapi_types.each_pair do |key, type|
|
194
|
-
if
|
195
|
-
self.send("#{key}=", nil)
|
196
|
-
elsif type =~ /\AArray<(.*)>/i
|
187
|
+
if type =~ /\AArray<(.*)>/i
|
197
188
|
# check to ensure the input is an array given that the attribute
|
198
189
|
# is documented as an array but the input is not
|
199
190
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -201,6 +192,8 @@ module FtcEventsClient
|
|
201
192
|
end
|
202
193
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
203
194
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
195
|
+
elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
196
|
+
self.send("#{key}=", nil)
|
204
197
|
end
|
205
198
|
end
|
206
199
|
|
@@ -213,8 +206,8 @@ module FtcEventsClient
|
|
213
206
|
# @return [Object] Deserialized data
|
214
207
|
def _deserialize(type, value)
|
215
208
|
case type.to_sym
|
216
|
-
when :
|
217
|
-
|
209
|
+
when :DateTime
|
210
|
+
DateTime.parse(value)
|
218
211
|
when :Date
|
219
212
|
Date.parse(value)
|
220
213
|
when :String
|
@@ -244,9 +237,7 @@ module FtcEventsClient
|
|
244
237
|
end
|
245
238
|
end
|
246
239
|
else # model
|
247
|
-
|
248
|
-
klass = FtcEventsClient.const_get(type)
|
249
|
-
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
240
|
+
FtcEventsClient.const_get(type).build_from_hash(value)
|
250
241
|
end
|
251
242
|
end
|
252
243
|
|
@@ -294,8 +285,5 @@ module FtcEventsClient
|
|
294
285
|
else
|
295
286
|
value
|
296
287
|
end
|
297
|
-
end
|
298
|
-
|
299
|
-
end
|
300
|
-
|
288
|
+
end end
|
301
289
|
end
|
@@ -3,38 +3,28 @@
|
|
3
3
|
|
4
4
|
#FTC Events API is a service to return relevant information about the _FIRST_ Tech Challenge (FTC). Information is made available from events operating around the world Information is currently made available after the conclusion of the tournament. The API will provide data as soon as it has synced, and we do not add any artificial delays. ## Documentation Notes ### Timezones All times are listed in the local time to the event venue. HTTP-date values will show their timezone. ### Query Parameters If you specify a parameter, but no value for that parameter, it will be ignored. For example, if you request `URL?teamNumber=` the `teamNumber` parameter would be ignored. For all APIs that accept a query string in addition to the base URI, the order of parameters do not matter, but the name shown in the documentation must match exactly, as does the associated value format as described in details. For response codes that are not HTTP 200 (OK), the documentation will show a body message that represents a possible response value. While the \"title\" of the HTTP Status Code will match those shown in the response codes documentation section exactly, the body of the response will be a more detailed explanation of why that status code is being returned and may not always be exactly as shown in the examples. ### Experimenting with the API This documentation is rendered at both [api-docs](https://ftc-events.firstinspires.org/api-docs) and [try-it-out](https://ftc-events.firstinspires.org/try-it-out). [api-docs](https://ftc-events.firstinspires.org/api-docs) has a three panel, easy to read layout, while [try-it-out](https://ftc-events.firstinspires.org/try-it-out) has a feature that allows you try out endpoints from within the page. Additionally, the Open API Json is availabe at [Open API](https://ftc-events.firstinspires.org/swagger/v2.0/swagger.json). This can be imported into a tool such as [Postman](https://www.postman.com) for experimentation as well. ### Last-Modified, FMS-OnlyModifiedSince, and If-Modified-Since Headers The FTC Events API utilizes the `Last-Modified` and `If-Modified-Since` Headers to communicate with consumers regarding the age of the data they are requesting. With a couple of exceptions, all calls will return a `Last-Modified` Header set with the time at which the data at that endpoint was last modified. The Header will always be set in the HTTP-date format, as described in the HTTP Protocol. There are two exceptions: the `Last-Modified` Header is not set if the endpoint returns no results (such as a request for a schedule with no matches). Consumers should keep track of the `Last-Modified` Header, and return it on subsequent calls to the same endpoint as the If-Modified-Since. The server will recognize this request, and will only return a result if the data has been modified since the last request. If no changes have been made, an HTTP 304 will be returned. If data has been modified, ALL data on that call will be returned (for \"only modified\" data, see below). The FTC Events API also allows a custom header used to filter the return data to a specific subset. This is done by specifying a `FMS-OnlyModifiedSince` header with each call. As with the `If-Modified-Since` header, consumers should keep track of the Last-Modified Header, and return it on subsequent calls to the same endpoint as the `FMS-OnlyModifiedSince` Header. The server will recognize this request, and will only return a result if the data has been modified since the last request, and, if returned, the data will only be those portions modified since the included date. If no changes, have been made, an HTTP 304 will be returned. Using this method, the server and consumer save processing time by only receiving modified data that is in need of update on the consumer side. If the Headers are improperly passed (such as the wrong Day of Week for the matching date, or a date in the future), the endpoint will simply ignore the Header and return all results. If both headers are specified, the request will be denied. ## Response Codes The FTC Events API HTTP Status Codes correspond with the [common codes](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html), but occasionally with different \"titles\". The \"title\" used by the API is shown next to each of the below possible response HTTP Status Codes. Throughout the documentation, Apiary may automatically show the common \"title\" in example returns (like \"Not Found\" for 404) but on the production server, the \"title\" will instead match those listed below. ### HTTP 200 - \"OK\" The request has succeeded. An entity corresponding to the requested resource is sent in the response. This will be returned as the HTTP Status Code for all request that succeed, even if the body is empty (such as an event that has no rankings, but with a valid season and event code were used) ### HTTP 304 - \"Not Modified\" When utilizing a Header that allows filtered data returns, such as `If-Modified-Since`, this response indicates that no data meets the request. ### HTTP 400 - \"Invalid Season Requested\"/\"Malformed Parameter Format In Request\"/\"Missing Parameter In Request\"/\"Invalid API Version Requested\": The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications. Specifically for this API, a 400 response indicates that the requested URI matches with a valid API, but one or more required parameter was malformed or invalid. Examples include an event code that is too short or team number that contains a letter. ### HTTP 401 - \"Unauthorized\" All requests against the API require authentication via a valid user token. Failing to provide one, or providing an invalid one, will warrant a 401 response. The client MAY repeat the request with a suitable Authorization header field. ### HTTP 404 - \"Invalid Event Requested\" Even though the 404 code usually indicates any not found status, a 404 will only be issued in this API when an event cannot be found for the requested season and event code. If the request didn't match a valid API or there were malformed parameters, the response would not receive a 404 but rather a 400 or 501. If this HTTP code is received, the season was a valid season and the event code matched the acceptable style of an event code, but there were no records of an event matching the combination of that season and event code. For example, HTTP 404 would be issued when the event had a different code in the requested season (the codes can change year to year based on event location). ### HTTP 500 - \"Internal Server Error\" The server encountered an unexpected condition which prevented it from fulfilling the request. This is a code sent directly by the server, and has no special alternate definition specific to this API. ### HTTP 501 - \"Request Did Not Match Any Current API Pattern\" The server does not support the functionality required to fulfill the request. Specifically, the request pattern did not match any of the possible APIs, and thus processing was discontinued. This code is also issued when too many optional parameters were included in a single request and fulfilling it would make the result confusing or misleading. Each API will specify which parameters or combination of parameters can be used at the same time. ### HTTP 503 - \"Service Unavailable\" The server is currently unable to handle the request due to a temporary overloading or maintenance of the server. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay MAY be indicated in a `Retry-After` header. This code will not always appear, sometimes the server may outright refuse the connection instead. This is a code sent directly by the server, and has no special alternate definition specific to this API. ## Authorization In order to make calls against the FTC Events API, you must include an HTTP Header called `Authorization` with the value set as specified below. If a request is made without this header, processing stops and an HTTP 401 is issued. All `Authorization` headers follow the same format: ``` Authorization: Basic 000000000000000000000000000000000000000000000000000000000000 ``` Where the Zeros are replaced by your Token. The Token can be formed by taking your username and your AuthorizationKey and adding a colon. For example, if your username is `sampleuser` and your AuthorizationKey is `7eaa6338-a097-4221-ac04-b6120fcc4d49` you would have this string: ``` sampleuser:7eaa6338-a097-4221-ac04-b6120fcc4d49 ``` This string must then be encoded using Base64 Encoded to form the Token, which will be the same length as the example above, but include letters and numbers. For our example, we would have: ``` c2FtcGxldXNlcjo3ZWFhNjMzOC1hMDk3LTQyMjEtYWMwNC1iNjEyMGZjYzRkNDk= ``` Most API client libraries can handle computing the authorization header using a username and password for you NOTICE: Publicly distributing an application, code snippet, etc, that has your username and token in it, encoded or not, WILL result in your token being blocked from the API. Each user should apply for their own token. If you wish to acquire a token for your development, you may do so by requesting a token through our automated system on this website.
|
5
5
|
|
6
|
-
|
7
|
-
|
8
|
-
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
6
|
+
OpenAPI spec version: v2.0
|
10
7
|
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 3.0.29
|
11
10
|
=end
|
12
11
|
|
13
12
|
require 'date'
|
14
|
-
require 'time'
|
15
13
|
|
16
14
|
module FtcEventsClient
|
17
|
-
class
|
18
|
-
NONE =
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
FINAL = "Final".freeze
|
24
|
-
|
25
|
-
# Builds the enum from string
|
26
|
-
# @param [String] The enum value in the form of the string
|
27
|
-
# @return [String] The enum value
|
28
|
-
def self.build_from_hash(value)
|
29
|
-
new.build_from_hash(value)
|
30
|
-
end
|
15
|
+
class AutoNavigatedStatus
|
16
|
+
NONE = 'NONE'.freeze
|
17
|
+
IN_STORAGE = 'IN_STORAGE'.freeze
|
18
|
+
COMPLETELY_IN_STORAGE = 'COMPLETELY_IN_STORAGE'.freeze
|
19
|
+
IN_WAREHOUSE = 'IN_WAREHOUSE'.freeze
|
20
|
+
COMPLETELY_IN_WAREHOUSE = 'COMPLETELY_IN_WAREHOUSE'.freeze
|
31
21
|
|
32
22
|
# Builds the enum from string
|
33
23
|
# @param [String] The enum value in the form of the string
|
34
24
|
# @return [String] The enum value
|
35
25
|
def build_from_hash(value)
|
36
|
-
constantValues =
|
37
|
-
raise "Invalid ENUM value #{value} for class #
|
26
|
+
constantValues = AutoNavigatedStatus.constants.select { |c| AutoNavigatedStatus::const_get(c) == value }
|
27
|
+
raise "Invalid ENUM value #{value} for class #AutoNavigatedStatus" if constantValues.empty?
|
38
28
|
value
|
39
29
|
end
|
40
30
|
end
|