Merge pull request #377 from EpokTarren/update_perf_stat

Update documentation example for user performance statistics
lichess-org · Sep 10, 2024 · 32ce9b2 · 32ce9b2
2 parents 99b2e54 + e956b1b
commit 32ce9b2
Showing 1 changed file with 13 additions and 10 deletions.
diff --git a/doc/specs/schemas/PerfStat.yaml b/doc/specs/schemas/PerfStat.yaml
@@ -1,5 +1,6 @@
 example:
   {
+    'user': { 'name': 'thibault' },
     'perf':
       {
         'glicko': { 'rating': 1672.42, 'deviation': 45.13, 'provisional': false },
@@ -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',
@@ -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',
@@ -126,6 +128,7 @@ example:
                   },
               },
           },
+        'userId': { 'id': 'thibault', 'name': 'thibault', 'title': null },
         'playStreak':
           {
             'nb':