feat: openapi spec for /v1/user/@me

ZleedApp · Aug 1, 2024 · 409df9e · 409df9e
1 parent e3009a0
commit 409df9e
Show file tree

Hide file tree

Showing 2 changed files with 153 additions and 1 deletion.
diff --git a/data/swagger.json b/data/swagger.json
@@ -72,7 +72,7 @@
             }
           },
           "405": {
-            "description": "Not Acceptable",
+            "description": "Method Not Allowed",
             "content": {
               "application/json": {
                 "schema": {
@@ -93,6 +93,23 @@
           }
         }
       }
+    },
+    "/v1/user/@me": {
+      "get": {
+        "description": "User info.",
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/User"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {
@@ -160,6 +177,81 @@
             "type": "string"
           }
         }
+      },
+      "User": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "integer"
+          },
+          "username": {
+            "type": "string"
+          },
+          "displayName": {
+            "type": "string"
+          },
+          "email": {
+            "type": "string"
+          },
+          "avatar": {
+            "type": "string"
+          },
+          "banner": {
+            "type": "string"
+          },
+          "badges": {
+            "type": "array",
+            "items": {
+              "type": "integer"
+            }
+          },
+          "connections": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "integer"
+                },
+                "url": {
+                  "type": "string"
+                },
+                "createdAt": {
+                  "type": "integer"
+                }
+              }
+            }
+          },
+          "streamTitle": {
+            "type": "string"
+          },
+          "streamKeys": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "integer"
+                },
+                "key": {
+                  "type": "string"
+                },
+                "createdAt": {
+                  "type": "integer"
+                }
+              }
+            }
+          },
+          "lastLive": {
+            "type": "string"
+          },
+          "createdAt": {
+            "type": "integer"
+          },
+          "updatedAt": {
+            "type": "integer"
+          }
+        }
       }
     }
   }

diff --git a/src/routes/v1/user/@me.ts b/src/routes/v1/user/@me.ts
@@ -6,8 +6,16 @@ import { User } from '../../../interfaces/user';
 
 import { verify } from 'jsonwebtoken';
 
+import {
+  OpenApiBuilder,
+  OpenApiMethod,
+  OpenApiResponse
+} from '../../../util/openapi_builder';
+
 import Database from '../../../util/database';
 
+import type { OpenApi } from '../../../util/openapi_builder';
+
 interface ZleedJWT {
   id: bigint;
   email: string;
@@ -16,6 +24,58 @@ interface ZleedJWT {
   exp: number;
 }
 
+export const openapi = (): OpenApi => {
+  return new OpenApiBuilder()
+    .addMethod(
+      Method.GET,
+      new OpenApiMethod().description('User info.').addResponse(
+        Status.OK,
+        new OpenApiResponse<User>()
+          .description('Ok')
+          .name('User')
+          .schema({
+            type: 'object',
+            properties: {
+              id: { type: 'integer' },
+              username: { type: 'string' },
+              displayName: { type: 'string' },
+              email: { type: 'string' },
+              avatar: { type: 'string' },
+              banner: { type: 'string' },
+              badges: { type: 'array', items: { type: 'integer' } },
+              connections: {
+                type: 'array',
+                items: {
+                  type: 'object',
+                  properties: {
+                    id: { type: 'integer' },
+                    url: { type: 'string' },
+                    createdAt: { type: 'integer' }
+                  }
+                }
+              },
+              streamTitle: { type: 'string' },
+              streamKeys: {
+                type: 'array',
+                items: {
+                  type: 'object',
+                  properties: {
+                    id: { type: 'integer' },
+                    key: { type: 'string' },
+                    createdAt: { type: 'integer' }
+                  }
+                }
+              },
+              lastLive: { type: 'string' },
+              createdAt: { type: 'integer' },
+              updatedAt: { type: 'integer' }
+            }
+          })
+      )
+    )
+    .build();
+};
+
 export default function handler(req: Request, res: Response<User>) {
   const jwtToken = req.getHeader('Authorization');