Skip to content

Commit

Permalink
Upload openapi.json file
Browse files Browse the repository at this point in the history
  • Loading branch information
MeganSilvey1 authored Apr 14, 2024
1 parent 56d07ed commit 9fa89d9
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions openapi.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"openapi":"3.1.0","info":{"title":"Sports World Central (SWC) Fantasy Football API","description":"\nThis API provides read-only access to info from the Sports World Central (SWC) Fantasy Football API. 🏈.\nThe endpoints are grouped into the following categories:\n\n## Player\nYou can get a list of an NFL players, or search for an individual player by player_id.\n\n## Scoring\nYou can get a list of NFL player performances, including the fantasy points they scored using SWC league scoring.\n\n## Membership\nGet information about all the SWC fantasy football leagues and the teams in them.\n","version":"0.1"},"paths":{"/":{"get":{"tags":["general"],"summary":"Root","operationId":"root__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v0/players/":{"get":{"tags":["player"],"summary":"Read Players","operationId":"read_players_v0_players__get","parameters":[{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Skip"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Player"},"title":"Response Read Players V0 Players Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/players/{player_id}":{"get":{"tags":["player"],"summary":"Get players by Player ID","description":"Get an individual NFL player by the SWC Player ID","operationId":"get_players_by_player_id","parameters":[{"name":"player_id","in":"path","required":true,"schema":{"type":"integer","title":"Player Id"}}],"responses":{"200":{"description":"One NFL player","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Player"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/performances/":{"get":{"tags":["scoring"],"summary":"Read Performances","operationId":"read_performances_v0_performances__get","parameters":[{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Skip"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Performance"},"title":"Response Read Performances V0 Performances Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/leagues/":{"get":{"tags":["membership"],"summary":"Read Leagues","operationId":"read_leagues_v0_leagues__get","parameters":[{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Skip"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/League"},"title":"Response Read Leagues V0 Leagues Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v0/teams/":{"get":{"tags":["membership"],"summary":"Read Teams","operationId":"read_teams_v0_teams__get","parameters":[{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Skip"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Team"},"title":"Response Read Teams V0 Teams Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"League":{"properties":{"league_id":{"type":"integer","title":"League Id"},"league_name":{"type":"string","title":"League Name"},"scoring_type":{"type":"string","title":"Scoring Type"},"teams":{"items":{"$ref":"#/components/schemas/TeamBase"},"type":"array","title":"Teams","default":[]}},"type":"object","required":["league_id","league_name","scoring_type","teams"],"title":"League"},"Performance":{"properties":{"performance_id":{"type":"integer","title":"Performance Id"},"player_id":{"type":"integer","title":"Player Id"},"week_number":{"type":"string","title":"Week Number"},"fantasy_points":{"type":"number","title":"Fantasy Points"}},"type":"object","required":["performance_id","player_id","week_number","fantasy_points"],"title":"Performance"},"Player":{"properties":{"player_id":{"type":"integer","title":"Player Id"},"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"},"performances":{"items":{"$ref":"#/components/schemas/Performance"},"type":"array","title":"Performances","default":[]}},"type":"object","required":["player_id","first_name","last_name","performances"],"title":"Player"},"PlayerBase":{"properties":{"player_id":{"type":"integer","title":"Player Id"},"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"}},"type":"object","required":["player_id","first_name","last_name"],"title":"PlayerBase"},"Team":{"properties":{"league_id":{"type":"integer","title":"League Id"},"team_id":{"type":"integer","title":"Team Id"},"team_name":{"type":"string","title":"Team Name"},"players":{"items":{"$ref":"#/components/schemas/PlayerBase"},"type":"array","title":"Players","default":[]}},"type":"object","required":["league_id","team_id","team_name","players"],"title":"Team"},"TeamBase":{"properties":{"league_id":{"type":"integer","title":"League Id"},"team_id":{"type":"integer","title":"Team Id"},"team_name":{"type":"string","title":"Team Name"}},"type":"object","required":["league_id","team_id","team_name"],"title":"TeamBase"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}

0 comments on commit 9fa89d9

Please sign in to comment.