Rust API client for tba-openapi-rust

Overview

Information and statistics about FIRST Robotics Competition teams and events.

Authentication

All endpoints require an Auth Key to be passed in the header X-TBA-Auth-Key. If you do not have an auth key yet, you can obtain one from your Account Page.

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

Installation

Put the package under your project folder in a directory named tba-openapi-rust and add the following to Cargo.toml under [dependencies]:

tba-openapi-rust = { path = "./tba-openapi-rust" }

Documentation for API Endpoints

All URIs are relative to https://www.thebluealliance.com/api/v3

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- DistrictApi | getdistrictevents | GET /district/{districtkey}/events | *DistrictApi* | getdistricteventskeys | GET /district/{districtkey}/events/keys | *DistrictApi* | getdistricteventssimple | GET /district/{districtkey}/events/simple | *DistrictApi* | getdistrictrankings | GET /district/{districtkey}/rankings | DistrictApi | getdistrictteams | GET /district/{districtkey}/teams | *DistrictApi* | getdistrictteamskeys | GET /district/{districtkey}/teams/keys | *DistrictApi* | getdistrictteamssimple | GET /district/{districtkey}/teams/simple | *DistrictApi* | getdistrictsbyyear | GET /districts/{year} | DistrictApi | geteventdistrictpoints | GET /event/{eventkey}/districtpoints | *DistrictApi* | getteamdistricts | GET /team/{teamkey}/districts | EventApi | getdistrictevents | GET /district/{districtkey}/events | *EventApi* | getdistricteventskeys | GET /district/{districtkey}/events/keys | *EventApi* | getdistricteventssimple | GET /district/{districtkey}/events/simple | *EventApi* | getevent | GET /event/{eventkey} | *EventApi* | geteventalliances | GET /event/{eventkey}/alliances | EventApi | geteventawards | GET /event/{eventkey}/awards | *EventApi* | geteventdistrictpoints | GET /event/{eventkey}/districtpoints | EventApi | geteventinsights | GET /event/{eventkey}/insights | *EventApi* | geteventmatchtimeseries | GET /event/{eventkey}/matches/timeseries | *EventApi* | geteventmatches | GET /event/{eventkey}/matches | EventApi | geteventmatcheskeys | GET /event/{eventkey}/matches/keys | EventApi | geteventmatchessimple | GET /event/{eventkey}/matches/simple | EventApi | geteventoprs | GET /event/{eventkey}/oprs | *EventApi* | geteventpredictions | GET /event/{eventkey}/predictions | EventApi | geteventrankings | GET /event/{eventkey}/rankings | *EventApi* | geteventsimple | GET /event/{eventkey}/simple | EventApi | geteventteams | GET /event/{eventkey}/teams | *EventApi* | geteventteamskeys | GET /event/{eventkey}/teams/keys | *EventApi* | geteventteamssimple | GET /event/{eventkey}/teams/simple | *EventApi* | geteventteamsstatuses | GET /event/{eventkey}/teams/statuses | *EventApi* | geteventsbyyear | GET /events/{year} | EventApi | geteventsbyyearkeys | GET /events/{year}/keys | EventApi | geteventsbyyearsimple | GET /events/{year}/simple | EventApi | getteameventawards | GET /team/{teamkey}/event/{eventkey}/awards | *EventApi* | getteameventmatches | GET /team/{teamkey}/event/{eventkey}/matches | EventApi | getteameventmatcheskeys | GET /team/{teamkey}/event/{eventkey}/matches/keys | EventApi | getteameventmatchessimple | GET /team/{teamkey}/event/{eventkey}/matches/simple | EventApi | getteameventstatus | GET /team/{teamkey}/event/{eventkey}/status | *EventApi* | getteamevents | GET /team/{teamkey}/events | EventApi | getteameventsbyyear | GET /team/{teamkey}/events/{year} | *EventApi* | getteameventsbyyearkeys | GET /team/{teamkey}/events/{year}/keys | *EventApi* | getteameventsbyyearsimple | GET /team/{teamkey}/events/{year}/simple | *EventApi* | getteameventskeys | GET /team/{teamkey}/events/keys | *EventApi* | getteameventssimple | GET /team/{teamkey}/events/simple | *EventApi* | getteameventsstatusesbyyear | GET /team/{teamkey}/events/{year}/statuses | *ListApi* | getdistrictevents | GET /district/{districtkey}/events | ListApi | getdistricteventskeys | GET /district/{districtkey}/events/keys | ListApi | getdistricteventssimple | GET /district/{districtkey}/events/simple | ListApi | getdistrictrankings | GET /district/{districtkey}/rankings | *ListApi* | getdistrictteams | GET /district/{districtkey}/teams | ListApi | getdistrictteamskeys | GET /district/{districtkey}/teams/keys | ListApi | getdistrictteamssimple | GET /district/{districtkey}/teams/simple | ListApi | geteventteams | GET /event/{eventkey}/teams | *ListApi* | geteventteamskeys | GET /event/{eventkey}/teams/keys | *ListApi* | geteventteamssimple | GET /event/{eventkey}/teams/simple | *ListApi* | geteventteamsstatuses | GET /event/{eventkey}/teams/statuses | *ListApi* | geteventsbyyear | GET /events/{year} | ListApi | geteventsbyyearkeys | GET /events/{year}/keys | ListApi | geteventsbyyearsimple | GET /events/{year}/simple | ListApi | getteameventsstatusesbyyear | GET /team/{teamkey}/events/{year}/statuses | ListApi | getteams | GET /teams/{pagenum} | ListApi | getteamsbyyear | GET /teams/{year}/{pagenum} | ListApi | getteamsbyyearkeys | GET /teams/{year}/{pagenum}/keys | *ListApi* | getteamsbyyearsimple | GET /teams/{year}/{pagenum}/simple | ListApi | getteamskeys | GET /teams/{pagenum}/keys | *ListApi* | getteamssimple | GET /teams/{pagenum}/simple | MatchApi | geteventmatchtimeseries | GET /event/{eventkey}/matches/timeseries | MatchApi | geteventmatches | GET /event/{eventkey}/matches | *MatchApi* | geteventmatcheskeys | GET /event/{eventkey}/matches/keys | *MatchApi* | geteventmatchessimple | GET /event/{eventkey}/matches/simple | *MatchApi* | getmatch | GET /match/{matchkey} | *MatchApi* | getmatchsimple | GET /match/{matchkey}/simple | MatchApi | getmatchtimeseries | GET /match/{matchkey}/timeseries | *MatchApi* | getmatchzebra | GET /match/{matchkey}/zebramotionworks | *MatchApi* | getteameventmatches | GET /team/{teamkey}/event/{eventkey}/matches | MatchApi | getteameventmatcheskeys | GET /team/{teamkey}/event/{eventkey}/matches/keys | MatchApi | getteameventmatchessimple | GET /team/{teamkey}/event/{eventkey}/matches/simple | MatchApi | getteammatchesbyyear | GET /team/{teamkey}/matches/{year} | *MatchApi* | getteammatchesbyyearkeys | GET /team/{teamkey}/matches/{year}/keys | *MatchApi* | getteammatchesbyyearsimple | GET /team/{teamkey}/matches/{year}/simple | *TbaApi* | getstatus | GET /status | TeamApi | getdistrictrankings | GET /district/{districtkey}/rankings | *TeamApi* | getdistrictteams | GET /district/{districtkey}/teams | TeamApi | getdistrictteamskeys | GET /district/{districtkey}/teams/keys | TeamApi | getdistrictteamssimple | GET /district/{districtkey}/teams/simple | TeamApi | geteventteams | GET /event/{eventkey}/teams | *TeamApi* | geteventteamskeys | GET /event/{eventkey}/teams/keys | *TeamApi* | geteventteamssimple | GET /event/{eventkey}/teams/simple | *TeamApi* | geteventteamsstatuses | GET /event/{eventkey}/teams/statuses | *TeamApi* | getteam | GET /team/{teamkey} | *TeamApi* | getteamawards | GET /team/{teamkey}/awards | TeamApi | getteamawardsbyyear | GET /team/{teamkey}/awards/{year} | *TeamApi* | getteamdistricts | GET /team/{teamkey}/districts | TeamApi | getteameventawards | GET /team/{teamkey}/event/{eventkey}/awards | *TeamApi* | getteameventmatches | GET /team/{teamkey}/event/{eventkey}/matches | TeamApi | getteameventmatcheskeys | GET /team/{teamkey}/event/{eventkey}/matches/keys | TeamApi | getteameventmatchessimple | GET /team/{teamkey}/event/{eventkey}/matches/simple | TeamApi | getteameventstatus | GET /team/{teamkey}/event/{eventkey}/status | *TeamApi* | getteamevents | GET /team/{teamkey}/events | TeamApi | getteameventsbyyear | GET /team/{teamkey}/events/{year} | *TeamApi* | getteameventsbyyearkeys | GET /team/{teamkey}/events/{year}/keys | *TeamApi* | getteameventsbyyearsimple | GET /team/{teamkey}/events/{year}/simple | *TeamApi* | getteameventskeys | GET /team/{teamkey}/events/keys | *TeamApi* | getteameventssimple | GET /team/{teamkey}/events/simple | *TeamApi* | getteameventsstatusesbyyear | GET /team/{teamkey}/events/{year}/statuses | *TeamApi* | getteammatchesbyyear | GET /team/{teamkey}/matches/{year} | TeamApi | getteammatchesbyyearkeys | GET /team/{teamkey}/matches/{year}/keys | TeamApi | getteammatchesbyyearsimple | GET /team/{teamkey}/matches/{year}/simple | TeamApi | getteammediabytag | GET /team/{teamkey}/media/tag/{mediatag} | TeamApi | getteammediabytagyear | GET /team/{teamkey}/media/tag/{mediatag}/{year} | *TeamApi* | getteammediabyyear | GET /team/{teamkey}/media/{year} | TeamApi | getteamrobots | GET /team/{teamkey}/robots | *TeamApi* | getteamsimple | GET /team/{teamkey}/simple | TeamApi | getteamsocialmedia | GET /team/{teamkey}/socialmedia | *TeamApi* | getteamyearsparticipated | GET /team/{teamkey}/yearsparticipated | TeamApi | getteams | GET /teams/{pagenum} | TeamApi | getteamsbyyear | GET /teams/{year}/{pagenum} | TeamApi | getteamsbyyearkeys | GET /teams/{year}/{pagenum}/keys | *TeamApi* | getteamsbyyearsimple | GET /teams/{year}/{pagenum}/simple | TeamApi | getteamskeys | GET /teams/{pagenum}/keys | *TeamApi* | getteamssimple | GET /teams/{pagenum}/simple |

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author