Skip to content

Update FIDE player schemas and examples #442

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
May 3, 2025
Merged

Update FIDE player schemas and examples #442

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
10 changes: 10 additions & 0 deletions doc/specs/examples/fide-getFidePlayer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"id": 35009192,
"name": "Erigaisi Arjun",
"federation": "IND",
"year": 2003,
"title": "GM",
"standard": 2782,
"rapid": 2708,
"blitz": 2738
}
18 changes: 18 additions & 0 deletions doc/specs/examples/fide-searchFidePlayers.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
[
{
"id": 35009192,
"name": "Erigaisi Arjun",
"federation": "IND",
"year": 2003,
"title": "GM",
"standard": 2782,
"rapid": 2708,
"blitz": 2738
},
{
"id": 35009060,
"name": "Erigaisi Keerthana",
"federation": "IND",
"year": 2002
}
]
8 changes: 0 additions & 8 deletions doc/specs/schemas/FIDEPlayer.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,22 @@ type: object
properties:
id:
type: number
example: 35009192
name:
type: string
example: "Erigaisi Arjun"
title:
$ref: "./Title.yaml"
federation:
type: string
example: "IND"
year:
type: number
example: 2003
inactive:
type: boolean
example: true
standard:
type: number
example: 2797
rapid:
type: number
example: 2698
blitz:
type: number
example: 2738
required:
- id
- name
Expand Down
2 changes: 2 additions & 0 deletions doc/specs/tags/fide/api-fide-player-playerId.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,5 @@ get:
application/json:
schema:
$ref: "../../schemas/FIDEPlayer.yaml"
example:
$ref: "../../examples/fide-getFidePlayer.json"
2 changes: 2 additions & 0 deletions doc/specs/tags/fide/api-fide-player-search.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,5 @@ get:
type: array
items:
$ref: "../../schemas/FIDEPlayer.yaml"
example:
$ref: "../../examples/fide-searchFidePlayers.json"
25 changes: 25 additions & 0 deletions scripts/update-examples/fide.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { example, prodClient } from "./config";

example(
"fide",
"getFidePlayer",
await prodClient().GET("/api/fide/player/{playerId}", {
params: {
path: {
playerId: 35009192,
},
},
}),
);

example(
"fide",
"searchFidePlayers",
await prodClient().GET("/api/fide/player", {
params: {
query: {
q: "Erigaisi",
},
},
}),
);