Merge pull request #299 from tors42/timeline

Add /api/timeline documentation
lichess-org · Jan 24, 2024 · 872283a · 872283a
2 parents f62df1f + 0c73de2
commit 872283a
Showing 1 changed file with 194 additions and 0 deletions.
diff --git a/doc/specs/lichess-api.yaml b/doc/specs/lichess-api.yaml
@@ -906,6 +906,44 @@ paths:
               schema:
                 $ref: '#/components/schemas/Ok'
 
+  /api/timeline:
+    get:
+      operationId: timeline
+      summary: Get my timeline
+      description: |
+        Get the timeline events of the logged in user.
+      tags:
+        - Account
+      security:
+        - OAuth2: []
+      parameters:
+        - in: query
+          name: since
+          description: Show events since this timestamp.
+          schema:
+            type: integer
+            minimum: 1356998400070
+        - in: query
+          name: nb
+          description: Max number of events to fetch.
+          schema:
+            type: integer
+            default: 15
+            minimum: 1
+            maximum: 30
+      responses:
+        "200":
+          description: The events in the timeline of the logged in user.
+          headers:
+            Access-Control-Allow-Origin:
+              schema:
+                type: string
+                default: "'*'"
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Timeline'
+
   /game/export/{gameId}:
     get:
       operationId: gamePgn
@@ -11089,6 +11127,162 @@ components:
         - initialFen
         - moves
 
+    Timeline:
+      type: object
+      properties:
+        entries:
+          type: array
+        users:
+          type: object
+      example: {
+        "entries": [
+          {
+            "type": "follow",
+            "data": {
+              "u1": "neio",
+              "u2": "chess-network"
+            },
+            "date": 1644232201429
+          },
+          {
+            "type": "team-join",
+            "data": {
+              "userId": "neio",
+              "teamId": "coders"
+            },
+            "date": 1644232201429
+          },
+          {
+            "type": "team-create",
+            "data": {
+              "userId": "neio",
+              "teamId": "coders"
+            },
+            "date": 1644232201429
+          },
+          {
+            "type": "forum-post",
+            "data": {
+              "userId": "neio",
+              "topicId": "AAAAAAAN",
+              "topicName": "World's Tallest LEGO Tower Completed in City Square",
+              "postId": "AAAAAAAL"
+            },
+            "date": 1644232201429
+          },
+          {
+            "type": "ublog-post",
+            "data": {
+              "userId": "neio",
+              "id": "og5pkt1c",
+              "slug": "gotta-go-fast",
+              "title": "Gotta Go Fast"
+            },
+            "date": 1644232201429
+          },
+          {
+            "type": "tour-join",
+            "data": {
+              "userId": "chess-network",
+              "tourId": "Z24oxqgU",
+              "tourName": "Daily Blitz Arena"
+            },
+            "date": 1644232201429
+          },
+          {
+            "type": "game-end",
+            "data": {
+              "fullId": "iGkAXUdEfLZC",
+              "perf": "correspondence",
+              "opponent": "chess-network",
+              "win": false
+            },
+            "date": 1644232201429
+          },
+          {
+            "type": "simul-create",
+            "data": {
+              "userId": "neio",
+              "simulId": "m3c0Wvu3",
+              "simulName": "RCA 1st Jan simul"
+            },
+            "date": 1644232201429
+          },
+          {
+            "type": "simul-join",
+            "data": {
+              "userId": "chess-network",
+              "simulId": "m3c0Wvu3",
+              "simulName": "RCA 1st Jan simul"
+            },
+            "date": 1644232201429
+          },
+          {
+            "type": "study-like",
+            "data": {
+              "userId": "neio",
+              "studyId": "ma5AvZ7o",
+              "studyName": "Free wins | Danish Gambit"
+            },
+            "date": 1644232201429
+          },
+          {
+            "type": "plan-start",
+            "data": {
+              "userId": "chess-network",
+            },
+            "date": 1644232201429
+          },
+          {
+            "type": "plan-renew",
+            "data": {
+              "userId": "chess-network",
+              "months": 64
+            },
+            "date": 1644232201429
+          },
+          {
+            "type": "blog-post",
+            "data": {
+              "id": "ZUviXRIAACYAVtMm",
+              "slug": "lichess-development-made-easy-with-gitpod",
+              "title": "Lichess Development Made Easy With Gitpod"
+            },
+            "date": 1644232201429
+          },
+          {
+            "type": "ublog-post-like",
+            "data": {
+              "userId": "neio",
+              "id": "ZUviXRIAACYAVtMm",
+              "title": "Lichess Development Made Easy With Gitpod"
+            },
+            "date": 1644232201429
+          },
+          {
+            "type": "stream-start",
+            "data": {
+              "userId": "chess-network",
+              "title": "Streamers Battle December !team | lichess.org"
+            },
+            "date": 1644232201429
+          }
+      ],
+      "users": {
+        "neio": {
+          "id": "neio",
+          "name": "Neio",
+          "title": "NM"
+        },
+        "chess-network": {
+          "id": "chess-network",
+          "name": "Chess-Network",
+          "title": "NM",
+          "patron": true
+        }
+      }
+    }
+
   securitySchemes:
     OAuth2:
       type: oauth2