Skip to content
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.

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

Added documentation for the /broadcast/by/:user endpoint #310

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions doc/specs/lichess-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,9 @@ paths:
/broadcast/new:
$ref: './tags/broadcasts/broadcast-new.yaml'

/broadcast/by/{username}:
$ref: './tags/broadcasts/broadcast-by-user.yaml'

/broadcast/{slug}/{broadcastTournamentId}:
$ref: './tags/broadcasts/broadcast-slug-broadcastTournamentId.yaml'

Expand Down
30 changes: 30 additions & 0 deletions doc/specs/tags/broadcasts/broadcast-by-user.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
get:
operationId: broadcastByUser
summary: Get broadcasts by a user
description: |
Returns all of the tournaments being broadcast by a user. Results are paginated.
tags:
- Broadcasts
security: []
parameters:
- in: path
name: username
required: true
schema:
type: string
- in: query
name: page
required: false
description: Selects the desired page of results.
schema:
type: integer
minimum: 1
maximum: 19
default: 1
responses:
"200":
description: The list of tournaments being broadcast by a user. Returns html for the webpage that shows all tournaments that are being broadcast by the user.
content:
text/html:
schema:
type: object