Skip to content

Commit

Permalink
specify uri format for urls
Browse files Browse the repository at this point in the history
  • Loading branch information
fitztrev committed Oct 13, 2024
1 parent 35c3a80 commit 6be30e7
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 6 deletions.
1 change: 1 addition & 0 deletions doc/specs/schemas/ArenaPosition.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ oneOf:
example: 'rnbqkbnr/ppp2ppp/3p4/4p3/4P3/5N2/PPPP1PPP/RNBQKB1R w KQkq -'
url:
type: string
format: uri
example: 'https://lichess.org/opening/Philidor_Defense'
- type: object
title: Custom position
Expand Down
13 changes: 7 additions & 6 deletions doc/specs/schemas/BroadcastRoundForm.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,11 @@ properties:
Example: `Round 1`
syncUrl:
type: string
format: uri
description: |
URL that Lichess will poll to get updates about the games. It must be publicly accessible from the Internet.
Example:
Example:
```txt
https://myserver.org/myevent/round-10/games.pgn
```
Expand All @@ -21,9 +22,9 @@ properties:
syncUrls:
type: string
description: |
URLs that Lichess will poll to get updates about the games. It must be publicly accessible from the Internet.
URLs that Lichess will poll to get updates about the games, separated by newlines. They must be publicly accessible from the Internet.
Example:
Example:
```txt
https://myserver.org/myevent/round-10/game-1.pgn
https://myserver.org/myevent/round-10/game-2.pgn
Expand All @@ -34,7 +35,7 @@ properties:
type: string
description: |
Lichess game IDs - Up to 64 Lichess game IDs, separated by spaces.
on
Choose one between `syncUrl`, `syncUrls` and `syncIds`, if it is missing, the broadcast needs to be fed by [pushing PGN to it](#operation/broadcastPush)
onlyRound:
type: integer
Expand Down Expand Up @@ -97,6 +98,6 @@ properties:
(Only for Admins) Waiting time for each poll.
minimum: 2
maximum: 60

required:
- name
- name
1 change: 1 addition & 0 deletions doc/specs/schemas/BroadcastRoundInfo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ properties:
type: boolean
url:
type: string
format: uri
delay:
type: integer
format: int64
Expand Down
2 changes: 2 additions & 0 deletions doc/specs/schemas/BroadcastTour.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ properties:
description: "Used to designate featured tournaments on Lichess"
image:
type: string
format: uri
description:
type: string
description: "Full tournament description in markdown format, or in HTML if the html=1 query parameter is set."
Expand All @@ -64,6 +65,7 @@ properties:
type: boolean
url:
type: string
format: uri

required:
- id
Expand Down
1 change: 1 addition & 0 deletions doc/specs/schemas/ChallengeJson.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ properties:
type: string
url:
type: string
format: uri
status:
type: string
enum:
Expand Down
1 change: 1 addition & 0 deletions doc/specs/schemas/ChallengeOpenJson.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ properties:
type: string
url:
type: string
format: uri
status:
type: string
enum:
Expand Down

0 comments on commit 6be30e7

Please sign in to comment.