swagger docs

This commit is contained in:
Ravi Prasad
2025-04-30 21:36:44 -05:00
parent e269bc5145
commit 80e4823b35
7 changed files with 438 additions and 8 deletions
+78
View File
@@ -0,0 +1,78 @@
{
"swagger": "2.0",
"info": {
"contact": {}
},
"paths": {
"/api/playerstats": {
"get": {
"description": "Returns filtered and paginated player stats",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"PlayerStats"
],
"summary": "Get player stats",
"parameters": [
{
"type": "integer",
"description": "Season (e.g., 2025)",
"name": "season",
"in": "query"
},
{
"type": "string",
"description": "Team abbreviation (e.g., MIL)",
"name": "team",
"in": "query"
},
{
"type": "string",
"description": "Player ID (e.g., greenaj01)",
"name": "playerId",
"in": "query"
},
{
"type": "integer",
"default": 1,
"description": "Page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"default": 20,
"description": "Page size",
"name": "pageSize",
"in": "query"
},
{
"type": "string",
"description": "Field to sort by (e.g., per, games, winShares)",
"name": "sortBy",
"in": "query"
},
{
"type": "boolean",
"description": "Sort ascending (default false)",
"name": "ascending",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
}
}
}