Skip to content

Commit

Permalink
Added documentation for the /broadcast/by/:user endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthewTave committed Feb 9, 2024
1 parent 266355f commit cbf9be3
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
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
28 changes: 28 additions & 0 deletions doc/specs/tags/broadcasts/broadcast-by-user.yaml
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

View workflow job for this annotation

GitHub Actions / Lint OpenAPI spec

oas3-schema "1" property must match "then" schema.

Check failure on line 15 in doc/specs/tags/broadcasts/broadcast-by-user.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI spec

path-params Path parameter "page" must have "required" property that is set to "true".

Check failure on line 15 in doc/specs/tags/broadcasts/broadcast-by-user.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI spec

path-params Parameter "page" must be used in path "/broadcast/by/{username}".
name: page
required: false

Check failure on line 17 in doc/specs/tags/broadcasts/broadcast-by-user.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI spec

oas3-schema "required" property must be equal to constant.
description: Selects the desired page of results.
schema:
type: integer
minimum: 1
maximum: 19
default: 1
responses:
"200":

Check failure on line 25 in doc/specs/tags/broadcasts/broadcast-by-user.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI spec

oas3-schema "200" property must match "else" schema.
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

Check failure on line 28 in doc/specs/tags/broadcasts/broadcast-by-user.yaml

View workflow job for this annotation

GitHub Actions / Lint OpenAPI spec

oas3-schema "text~1html" property type must be object.

0 comments on commit cbf9be3

Please sign in to comment.