Skip to content

Use openapi string data validation to show character lengths #419

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

Merged
merged 1 commit into from
Feb 13, 2025
Merged

Use openapi string data validation to show character lengths #419

Show file tree
Hide file tree
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
4 changes: 3 additions & 1 deletion doc/specs/tags/arenatournaments/api-tournament-team-battle-id.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@ post:
parameters:
- in: path
name: id
description: The tournament ID (8 characters)..
description: The tournament ID
required: true
schema:
type: string
minLength: 8
maxLength: 8
requestBody:
required: true
content:
Expand Down
4 changes: 3 additions & 1 deletion doc/specs/tags/broadcasts/api-broadcast-broadcastTournamentId.pgn.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@ get:
parameters:
- in: path
name: broadcastTournamentId
description: The broadcast tournament ID (8 characters).
description: The broadcast tournament ID
required: true
schema:
type: string
minLength: 8
maxLength: 8
responses:
"200":
description: The PGN representation of the broadcast.
Expand Down
4 changes: 3 additions & 1 deletion ...broadcasts/api-broadcast-broadcastTournamentSlug-broadcastRoundSlug-broadcastRoundId.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,12 @@ get:
type: string
- in: path
name: broadcastRoundId
description: The broadcast Round ID (8 characters).
description: The broadcast Round ID
required: true
schema:
type: string
minLength: 8
maxLength: 8
responses:
"200":
description: The information about the broadcast round.
Expand Down
4 changes: 3 additions & 1 deletion doc/specs/tags/broadcasts/api-broadcast-round-broadcastRoundId.pgn.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@ get:
parameters:
- in: path
name: broadcastRoundId
description: The round ID (8 characters).
description: The round ID
required: true
schema:
type: string
minLength: 8
maxLength: 8
responses:
"200":
description: The PGN representation of the round.
Expand Down
4 changes: 3 additions & 1 deletion doc/specs/tags/broadcasts/api-stream-broadcast-round-broadcastRoundId.pgn.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@ get:
parameters:
- in: path
name: broadcastRoundId
description: The broadcast round ID (8 characters).
description: The broadcast round ID
required: true
schema:
type: string
minLength: 8
maxLength: 8
responses:
"200":
description: The PGN representation of the tournament games, then the PGNs of games as they are updated.
Expand Down
4 changes: 3 additions & 1 deletion doc/specs/tags/broadcasts/broadcast-broadcastTournamentId-edit.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,12 @@ post:
parameters:
- in: path
name: broadcastTournamentId
description: The broadcast ID (8 characters).
description: The broadcast ID
required: true
schema:
type: string
minLength: 8
maxLength: 8
requestBody:
required: true
content:
Expand Down
4 changes: 3 additions & 1 deletion doc/specs/tags/broadcasts/broadcast-broadcastTournamentId-players.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,12 @@ get:
parameters:
- in: path
name: broadcastTournamentId
description: The broadcast tournament ID (8 characters).
description: The broadcast tournament ID
required: true
schema:
type: string
minLength: 8
maxLength: 8
responses:
"200":
description: The broadcast players
Expand Down
4 changes: 3 additions & 1 deletion doc/specs/tags/broadcasts/broadcast-broadcastTournamentId.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,12 @@ get:
parameters:
- in: path
name: broadcastTournamentId
description: The broadcast tournament ID (8 characters).
description: The broadcast tournament ID
required: true
schema:
type: string
minLength: 8
maxLength: 8
responses:
'200':
description: The information about the broadcast tournament.
Expand Down
4 changes: 3 additions & 1 deletion doc/specs/tags/broadcasts/broadcast-round-broadcastRoundId-edit.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@ post:
parameters:
- in: path
name: broadcastRoundId
description: The broadcast round ID (8 characters).
description: The broadcast round ID
required: true
schema:
type: string
minLength: 8
maxLength: 8
requestBody:
required: true
content:
Expand Down
4 changes: 3 additions & 1 deletion doc/specs/tags/broadcasts/broadcast-round-broadcastRoundId-push.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@ post:
parameters:
- in: path
name: broadcastRoundId
description: The broadcast round ID (8 characters).
description: The broadcast round ID
required: true
schema:
type: string
minLength: 8
maxLength: 8
requestBody:
description: The PGN. It can contain up to 64 games, separated by a double new line.
required: true
Expand Down
4 changes: 3 additions & 1 deletion doc/specs/tags/broadcasts/broadcast-round-broadcastRoundId-reset.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,12 @@ post:
parameters:
- in: path
name: broadcastRoundId
description: The broadcast round ID (8 characters).
description: The broadcast round ID
required: true
schema:
type: string
minLength: 8
maxLength: 8
responses:
"200":
description: The broadcast round was successfully reset.
Expand Down
4 changes: 3 additions & 1 deletion doc/specs/tags/games/game-export-gameId.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,12 @@ get:
parameters:
- in: path
name: gameId
description: The game ID (8 characters).
description: The game ID
required: true
schema:
type: string
minLength: 8
maxLength: 8
- in: query
name: moves
description: Include the PGN moves.
Expand Down
8 changes: 6 additions & 2 deletions doc/specs/tags/studies/api-study-studyId-chapterId.pgn.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,20 @@ get:
parameters:
- in: path
name: studyId
description: The study ID (8 characters).
description: The study ID
required: true
schema:
type: string
minLength: 8
maxLength: 8
- in: path
name: chapterId
description: The chapter ID (8 characters).
description: The chapter ID
required: true
schema:
type: string
minLength: 8
maxLength: 8
- in: query
name: clocks
description: |
Expand Down
8 changes: 6 additions & 2 deletions doc/specs/tags/studies/api-study-studyId-chapterId.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,20 @@ delete:
parameters:
- in: path
name: studyId
description: The study ID (8 characters).
description: The study ID
required: true
schema:
type: string
minLength: 8
maxLength: 8
- in: path
name: chapterId
description: The chapter ID (8 characters).
description: The chapter ID
required: true
schema:
type: string
minLength: 8
maxLength: 8
description: |
Delete a chapter of a study you own. This is definitive.
A study must have at least one chapter; so if you delete the last chapter,
Expand Down
8 changes: 6 additions & 2 deletions doc/specs/tags/studies/api-study-studyId.pgn.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,12 @@ get:
parameters:
- in: path
name: studyId
description: The study ID (8 characters).
description: The study ID
required: true
schema:
type: string
minLength: 8
maxLength: 8
- in: query
name: clocks
description: |
Expand Down Expand Up @@ -80,10 +82,12 @@ head:
parameters:
- in: path
name: studyId
description: The study ID (8 characters).
description: The study ID
required: true
schema:
type: string
minLength: 8
maxLength: 8
responses:
"204":
description: The study headers.
Expand Down