@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/
@returns(200) {currentSeason: int, maxSeason: int, name: str, apiVersion: str, status: str}

@endpoint GET /v3.0/:season
@returns(500) {code: int, message: str}

@endpoint GET /v3.0/:season/events
@returns(200) {Events: [map], eventCount: int}

@endpoint GET /v3.0/:season/districts
@returns(500) {code: int, message: str}

@endpoint GET /v3.0/:season/teams
@returns(500) {code: int, message: str}

@endpoint GET /v3.0/:season/avatars
@returns(500) {code: int, message: str}

@endpoint GET /v3.0/:season/awards/event/:eventCode
@returns(200) {Awards: [map]}

@endpoint GET /v3.0/:season/awards/list
@returns(500) {code: int, message: str}

@endpoint GET /v3.0/:season/awards/team/:teamNumber
@returns(200) {Awards: [map]}

@endpoint GET /v3.0/:season/awards/eventteam/:eventCode/:teamNumber
@returns(200) {Awards: [map]}

@endpoint GET /v3.0/:season/scores/:eventCode/:tournamentLevel
@returns(200) {MatchScores: [map]}

@endpoint GET /v3.0/:season/matches/:eventCode
@returns(200) {Matches: [map]}

@endpoint GET /v3.0/:season/rankings/district/qualPerformanceCalculation

@endpoint GET /v3.0/:season/rankings/district/allianceSelectionCalculation

@endpoint GET /v3.0/:season/rankings/district/playoffAdvancementCalculation

@endpoint GET /v3.0/:season/rankings/:eventCode
@returns(200) {Rankings: [map]}

@endpoint GET /v3.0/:season/rankings/district
@returns(200) {districtRanks: [map], rankingCountTotal: int, rankingCountPage: int, pageCurrent: int, pageTotal: int}

@endpoint GET /v3.0/:season/schedule/:eventCode
@returns(200) {Schedule: [map]}

@endpoint GET /v3.0/:season/alliances/:eventCode

@end