From b99da32483def2299183d0be73ebe31623d9428b Mon Sep 17 00:00:00 2001 From: Trevor Fitzgerald Date: Wed, 12 Feb 2025 19:47:14 -0500 Subject: [PATCH] Use openapi string data validation to show character lengths --- .../arenatournaments/api-tournament-team-battle-id.yaml | 4 +++- .../api-broadcast-broadcastTournamentId.pgn.yaml | 4 +++- ...ournamentSlug-broadcastRoundSlug-broadcastRoundId.yaml | 4 +++- .../api-broadcast-round-broadcastRoundId.pgn.yaml | 4 +++- .../api-stream-broadcast-round-broadcastRoundId.pgn.yaml | 4 +++- .../broadcasts/broadcast-broadcastTournamentId-edit.yaml | 4 +++- .../broadcast-broadcastTournamentId-players.yaml | 4 +++- .../tags/broadcasts/broadcast-broadcastTournamentId.yaml | 4 +++- .../broadcasts/broadcast-round-broadcastRoundId-edit.yaml | 4 +++- .../broadcasts/broadcast-round-broadcastRoundId-push.yaml | 4 +++- .../broadcast-round-broadcastRoundId-reset.yaml | 4 +++- doc/specs/tags/games/game-export-gameId.yaml | 4 +++- .../tags/studies/api-study-studyId-chapterId.pgn.yaml | 8 ++++++-- doc/specs/tags/studies/api-study-studyId-chapterId.yaml | 8 ++++++-- doc/specs/tags/studies/api-study-studyId.pgn.yaml | 8 ++++++-- 15 files changed, 54 insertions(+), 18 deletions(-) diff --git a/doc/specs/tags/arenatournaments/api-tournament-team-battle-id.yaml b/doc/specs/tags/arenatournaments/api-tournament-team-battle-id.yaml index c49dce0e..7ff587c7 100644 --- a/doc/specs/tags/arenatournaments/api-tournament-team-battle-id.yaml +++ b/doc/specs/tags/arenatournaments/api-tournament-team-battle-id.yaml @@ -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: diff --git a/doc/specs/tags/broadcasts/api-broadcast-broadcastTournamentId.pgn.yaml b/doc/specs/tags/broadcasts/api-broadcast-broadcastTournamentId.pgn.yaml index 8994b14d..20d6861a 100644 --- a/doc/specs/tags/broadcasts/api-broadcast-broadcastTournamentId.pgn.yaml +++ b/doc/specs/tags/broadcasts/api-broadcast-broadcastTournamentId.pgn.yaml @@ -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. diff --git a/doc/specs/tags/broadcasts/api-broadcast-broadcastTournamentSlug-broadcastRoundSlug-broadcastRoundId.yaml b/doc/specs/tags/broadcasts/api-broadcast-broadcastTournamentSlug-broadcastRoundSlug-broadcastRoundId.yaml index c42edfe9..4c6743a7 100644 --- a/doc/specs/tags/broadcasts/api-broadcast-broadcastTournamentSlug-broadcastRoundSlug-broadcastRoundId.yaml +++ b/doc/specs/tags/broadcasts/api-broadcast-broadcastTournamentSlug-broadcastRoundSlug-broadcastRoundId.yaml @@ -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. diff --git a/doc/specs/tags/broadcasts/api-broadcast-round-broadcastRoundId.pgn.yaml b/doc/specs/tags/broadcasts/api-broadcast-round-broadcastRoundId.pgn.yaml index d6f3da0d..cd7048e8 100644 --- a/doc/specs/tags/broadcasts/api-broadcast-round-broadcastRoundId.pgn.yaml +++ b/doc/specs/tags/broadcasts/api-broadcast-round-broadcastRoundId.pgn.yaml @@ -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. diff --git a/doc/specs/tags/broadcasts/api-stream-broadcast-round-broadcastRoundId.pgn.yaml b/doc/specs/tags/broadcasts/api-stream-broadcast-round-broadcastRoundId.pgn.yaml index 39fba191..8b045622 100644 --- a/doc/specs/tags/broadcasts/api-stream-broadcast-round-broadcastRoundId.pgn.yaml +++ b/doc/specs/tags/broadcasts/api-stream-broadcast-round-broadcastRoundId.pgn.yaml @@ -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. diff --git a/doc/specs/tags/broadcasts/broadcast-broadcastTournamentId-edit.yaml b/doc/specs/tags/broadcasts/broadcast-broadcastTournamentId-edit.yaml index f1fb044e..f1e9cdd9 100644 --- a/doc/specs/tags/broadcasts/broadcast-broadcastTournamentId-edit.yaml +++ b/doc/specs/tags/broadcasts/broadcast-broadcastTournamentId-edit.yaml @@ -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: diff --git a/doc/specs/tags/broadcasts/broadcast-broadcastTournamentId-players.yaml b/doc/specs/tags/broadcasts/broadcast-broadcastTournamentId-players.yaml index e97bb56b..757e2614 100644 --- a/doc/specs/tags/broadcasts/broadcast-broadcastTournamentId-players.yaml +++ b/doc/specs/tags/broadcasts/broadcast-broadcastTournamentId-players.yaml @@ -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 diff --git a/doc/specs/tags/broadcasts/broadcast-broadcastTournamentId.yaml b/doc/specs/tags/broadcasts/broadcast-broadcastTournamentId.yaml index 71797c67..e52314b6 100644 --- a/doc/specs/tags/broadcasts/broadcast-broadcastTournamentId.yaml +++ b/doc/specs/tags/broadcasts/broadcast-broadcastTournamentId.yaml @@ -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. diff --git a/doc/specs/tags/broadcasts/broadcast-round-broadcastRoundId-edit.yaml b/doc/specs/tags/broadcasts/broadcast-round-broadcastRoundId-edit.yaml index 2ede7067..4d8b2f5b 100644 --- a/doc/specs/tags/broadcasts/broadcast-round-broadcastRoundId-edit.yaml +++ b/doc/specs/tags/broadcasts/broadcast-round-broadcastRoundId-edit.yaml @@ -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: diff --git a/doc/specs/tags/broadcasts/broadcast-round-broadcastRoundId-push.yaml b/doc/specs/tags/broadcasts/broadcast-round-broadcastRoundId-push.yaml index f74d07ed..7ba35dd5 100644 --- a/doc/specs/tags/broadcasts/broadcast-round-broadcastRoundId-push.yaml +++ b/doc/specs/tags/broadcasts/broadcast-round-broadcastRoundId-push.yaml @@ -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 diff --git a/doc/specs/tags/broadcasts/broadcast-round-broadcastRoundId-reset.yaml b/doc/specs/tags/broadcasts/broadcast-round-broadcastRoundId-reset.yaml index 95550a91..985cc7b7 100644 --- a/doc/specs/tags/broadcasts/broadcast-round-broadcastRoundId-reset.yaml +++ b/doc/specs/tags/broadcasts/broadcast-round-broadcastRoundId-reset.yaml @@ -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. diff --git a/doc/specs/tags/games/game-export-gameId.yaml b/doc/specs/tags/games/game-export-gameId.yaml index cc41761d..bb3cc4b3 100644 --- a/doc/specs/tags/games/game-export-gameId.yaml +++ b/doc/specs/tags/games/game-export-gameId.yaml @@ -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. diff --git a/doc/specs/tags/studies/api-study-studyId-chapterId.pgn.yaml b/doc/specs/tags/studies/api-study-studyId-chapterId.pgn.yaml index 6cedaee7..89d5ac2e 100644 --- a/doc/specs/tags/studies/api-study-studyId-chapterId.pgn.yaml +++ b/doc/specs/tags/studies/api-study-studyId-chapterId.pgn.yaml @@ -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: | diff --git a/doc/specs/tags/studies/api-study-studyId-chapterId.yaml b/doc/specs/tags/studies/api-study-studyId-chapterId.yaml index 65d44184..feee446e 100644 --- a/doc/specs/tags/studies/api-study-studyId-chapterId.yaml +++ b/doc/specs/tags/studies/api-study-studyId-chapterId.yaml @@ -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, diff --git a/doc/specs/tags/studies/api-study-studyId.pgn.yaml b/doc/specs/tags/studies/api-study-studyId.pgn.yaml index 1077dff5..9952dd1a 100644 --- a/doc/specs/tags/studies/api-study-studyId.pgn.yaml +++ b/doc/specs/tags/studies/api-study-studyId.pgn.yaml @@ -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: | @@ -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.