Skip to content

Commit

Permalink
Update documentation example for user performance statistics
Browse files Browse the repository at this point in the history
When calling the API it can be observed that
- opInt has been changed to opRating
- a field user.name has been added
- stat.id has been added
- stat.userId.{id, name, title}, have been added
  • Loading branch information
EpokTarren committed Sep 10, 2024
1 parent 99b2e54 commit e956b1b
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions doc/specs/schemas/PerfStat.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
example:
{
'user': { 'name': 'thibault' },
'perf':
{
'glicko': { 'rating': 1672.42, 'deviation': 45.13, 'provisional': false },
Expand All @@ -13,36 +14,37 @@ example:
'perfType': { 'key': 'bullet', 'name': 'Bullet' },
'highest': { 'int': 1902, 'at': '2021-05-31T08:58:53.701Z', 'gameId': 'YEDqtwig' },
'lowest': { 'int': 1417, 'at': '2016-06-28T13:54:39.656Z', 'gameId': 'rNM4J1GJ' },
'id': 'thibault/1',
'bestWins':
{
'results':
[
{
'opInt': 2238,
'opRating': 2238,
'opId': { 'id': 'hyperdragon84', 'name': 'HyperDragon84' },
'at': '2019-06-19T17:09:05.187Z',
'gameId': 'DGB53z9w',
},
{
'opInt': 2089,
'opRating': 2089,
'opId': { 'id': 'osipov', 'name': 'osipov' },
'at': '2017-06-18T09:46:05.016Z',
'gameId': 'gurRhuMi',
},
{
'opInt': 2071,
'opRating': 2071,
'opId': { 'id': 'spark50', 'name': 'Spark50' },
'at': '2020-07-04T08:36:12.948Z',
'gameId': 'a93Dk1mv',
},
{
'opInt': 2045,
'opRating': 2045,
'opId': { 'id': 'yasha43', 'name': 'Yasha43' },
'at': '2021-05-17T14:01:41.098Z',
'gameId': 'j3jZnGTr',
},
{
'opInt': 2034,
'opRating': 2034,
'opId': { 'id': 'midedu', 'name': 'midedu' },
'at': '2020-06-27T17:32:47.001Z',
'gameId': 'OiaMVLQ8',
Expand All @@ -54,31 +56,31 @@ example:
'results':
[
{
'opInt': 1186,
'opRating': 1186,
'opId': { 'id': 'happy0', 'name': 'Happy0' },
'at': '2016-07-07T19:48:29.077Z',
'gameId': 'Q01bbiN4',
},
{
'opInt': 1197,
'opRating': 1197,
'opId': { 'id': 'kazmankiller86', 'name': 'KazmanKiller86' },
'at': '2016-10-16T14:21:37.748Z',
'gameId': 'Aivqh9Sp',
},
{
'opInt': 1201,
'opRating': 1201,
'opId': { 'id': 'artem555', 'name': 'artem555' },
'at': '2016-08-28T16:21:30.923Z',
'gameId': 'tiRAbhnX',
},
{
'opInt': 1265,
'opRating': 1265,
'opId': { 'id': 'arcenuu', 'name': 'Arcenuu' },
'at': '2016-12-24T14:28:03.866Z',
'gameId': 'A68wUOoh',
},
{
'opInt': 1283,
'opRating': 1283,
'opId': { 'id': 'amritalib76', 'name': 'Amritalib76' },
'at': '2018-06-26T09:55:39.354Z',
'gameId': 'sbNVikmo',
Expand Down Expand Up @@ -126,6 +128,7 @@ example:
},
},
},
'userId': { 'id': 'thibault', 'name': 'thibault', 'title': null },
'playStreak':
{
'nb':
Expand Down

0 comments on commit e956b1b

Please sign in to comment.