Skip to content

Add GET /api/leagues endpoint to OpenAPI spec #47

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.

Sign up for GitHub

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

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add GET /api/leagues endpoint to OpenAPI spec #47

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions api-reference/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
{ "name": "Logout", "description": "Session logout" },
{ "name": "Mobile auth", "description": "OAuth flow for native apps" },
{ "name": "Teams", "description": "Teams list and follow/unfollow" },
{ "name": "Leagues", "description": "Leagues list and metadata" },
{ "name": "Leaderboard", "description": "Leaderboards, seasons, winners, stats" },
{ "name": "Locker room", "description": "Social feed posts, comments, reactions" },
{ "name": "Packs", "description": "Packs list, purchase, open" },
Expand Down Expand Up @@ -159,6 +160,61 @@
"responses": { "200": { "description": "{ success }" } }
}
},
"/api/leagues": {
"get": {
"tags": ["Leagues", "Platform and infrastructure"],
"summary": "List leagues",
"description": "Returns all leagues with colors, metadata, and team counts. Optionally filter by country (case-insensitive).",
"parameters": [
{ "name": "country", "in": "query", "description": "Filter leagues by country (case-insensitive).", "schema": { "type": "string" } }
],
"security": [],
"responses": {
"200": {
"description": "{ success, data: { leagues } }",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": { "type": "boolean" },
"data": {
"type": "object",
"properties": {
"leagues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string" },
"slug": { "type": "string" },
"name": { "type": "string" },
"fullName": { "type": "string", "nullable": true },
"country": { "type": "string" },
"logo": { "type": "string", "nullable": true },
"logoFormat": { "type": "string", "nullable": true },
"colors": { "type": "object", "description": "League brand colors." },
"source": { "type": "string", "nullable": true },
"createdAt": { "type": "string", "format": "date-time" },
"updatedAt": { "type": "string", "format": "date-time" },
"_count": {
"type": "object",
"properties": { "teams": { "type": "integer" } }
}
}
}
}
}
}
}
}
}
}
},
"500": { "description": "Failed to list leagues" }
}
}
},
"/api/leaderboard": {
"get": {
"tags": ["Leaderboard", "Gamification"],
Expand Down
Loading