Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Suggestion] Include season data from FRC Event Web in API Status endpoint #5248

Open
LoganAyers3461 opened this issue May 5, 2023 · 0 comments

Comments

@LoganAyers3461
Copy link

Expected Behavior

In the current version of the API, the status endpoint returns the current_season as the year of the current season
could you also return the season data from the FRC Event Web below it?

Current Behavior

sending an authorized call to https://www.thebluealliance.com/api/v3/status returns
{ "android": { "latest_app_version": 6000199, "min_app_version": 5000000 }, "current_season": 2023, "down_events": [], "ios": { "latest_app_version": -1, "min_app_version": -1 }, "is_datafeed_down": false, "max_season": 2023 }

Possible Solution

A way I see the data being returned could look something like this;
upon sending an authorized call to https://www.thebluealliance.com/api/v3/status the api returns
{ "android": { "latest_app_version": 6000199, "min_app_version": 5000000 }, "current_season": 2020, "current_season_data": { "eventCount": 200, "gameName": "INFINITE RECHARGE", "kickoff": "2020-01-04T15:30:00Z", "rookieStart": 8002, "teamCount": 4782, "frcChampionships": [ { "name": "FIRST Championship - Detroit - FIRST Robotics Competition (Cancelled)", "startDate": "2020-04-29T00:00:00", "location": "Detroit, MI USA" }, { "name": "FIRST Championship - Houston - FIRST Robotics Competition (Cancelled)", "startDate": "2020-04-15T00:00:00", "location": "Houston, TX USA" } ] } "down_events": [], "ios": { "latest_app_version": -1, "min_app_version": -1 }, "is_datafeed_down": false, "max_season": 2023 }

or perhaps a dedicated endpoint just to return this data https://www.thebluealliance.com/api/v3/status/season

Context

My reason for making this suggestion is because I am working on a backend for our team's new website and Id like to be able to pull all the data I need all at once. The ability to get the game name and kickoff date could be very useful in other projects by other authors as well, as The Blue Alliance's API is far more user friendly then the FRC Event Web's own API which was why I originally started programming using the TBA API.

Thank you for reading, and for spending the time to implement this suggestion if you do decide to!
Love all of you and your hard work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant