@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api FRC Events
@base https://frc-api.firstinspires.org/v3.0
@auth Basic
@endpoints 19
@toc v3.0(19)

@endpoint GET /v3.0/
@desc Root level call with no parameters
@returns(200) {currentSeason: int, maxSeason: int, name: str, apiVersion: str, status: str}

@endpoint GET /v3.0/:season
@desc The season summary API returns a high level glance of a particular FRC season
@returns(500) {code: int, message: str}

@endpoint GET /v3.0/:season/events
@desc The event listings API returns all FRC official district and regional events in a particular season
@returns(200) {Events: [map], eventCount: int}

@endpoint GET /v3.0/:season/districts
@desc The district listings API returns all FRC official districts of a particular season
@returns(500) {code: int, message: str}

@endpoint GET /v3.0/:season/teams
@desc The team listings API returns all FRC official teams in a particular season
@returns(500) {code: int, message: str}

@endpoint GET /v3.0/:season/avatars
@desc This endpoint applies only to the 2018 or later seasons
@returns(500) {code: int, message: str}

@endpoint GET /v3.0/:season/awards/event/:eventCode
@desc The event awards API returns details about awards presented at a particular event in a particular season
@returns(200) {Awards: [map]}

@endpoint GET /v3.0/:season/awards/list
@desc The award listings API returns a listing of the various awards that can be distributed in the requested season
@returns(500) {code: int, message: str}

@endpoint GET /v3.0/:season/awards/team/:teamNumber
@desc The team awards API returns details about awards presented for a particular team in a particular season
@returns(200) {Awards: [map]}

@endpoint GET /v3.0/:season/awards/eventteam/:eventCode/:teamNumber
@desc The event team awards API returns details about awards presented at a particular event in a particular season for a particular team
@returns(200) {Awards: [map]}

@endpoint GET /v3.0/:season/scores/:eventCode/:tournamentLevel
@desc The score details API returns the score detail for all matches of a particular event in a particular season and a particular tournament level
@returns(200) {MatchScores: [map]}

@endpoint GET /v3.0/:season/matches/:eventCode
@desc The match results API returns the match results for all matches of a particular event in a particular season
@returns(200) {Matches: [map]}

@endpoint GET /v3.0/:season/rankings/district/qualPerformanceCalculation
@desc Qual Performance Points is one of three endpoints to assist teams in figuring out how to improve their performance to achieve the desired district ranking placement

@endpoint GET /v3.0/:season/rankings/district/allianceSelectionCalculation
@desc Alliance Selection Points is one of three endpoints to assist teams in figuring out how to improve their performance to achieve the desired district ranking placement

@endpoint GET /v3.0/:season/rankings/district/playoffAdvancementCalculation
@desc Playoff Advancement Points is one of three endpoints to assist teams in figuring out how to improve their performance to achieve the desired district ranking placement

@endpoint GET /v3.0/:season/rankings/:eventCode
@desc The rankings API returns team ranking detail from a particular event in a particular season
@returns(200) {Rankings: [map]}

@endpoint GET /v3.0/:season/rankings/district
@desc The district rankings API returns team ranking detail from a particular team in a particular season
@returns(200) {districtRanks: [map], rankingCountTotal: int, rankingCountPage: int, pageCurrent: int, pageTotal: int}

@endpoint GET /v3.0/:season/schedule/:eventCode
@desc The schedule API returns the match schedule for the desired tournament level of a particular event in a particular season
@returns(200) {Schedule: [map]}

@endpoint GET /v3.0/:season/alliances/:eventCode
@desc The alliances API returns details about alliance selection at a particular event in a particular season

@end