-
-
Notifications
You must be signed in to change notification settings - Fork 152
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added documentation for the /broadcast/by/:user endpoint
- Loading branch information
1 parent
266355f
commit cbf9be3
Showing
2 changed files
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
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: path | ||
Check failure on line 15 in doc/specs/tags/broadcasts/broadcast-by-user.yaml GitHub Actions / Lint OpenAPI spec
Check failure on line 15 in doc/specs/tags/broadcasts/broadcast-by-user.yaml GitHub Actions / Lint OpenAPI spec
|
||
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: any | ||