Merge pull request #56 from ufosc/feature/api-docs

Feature/api docs
ufosc · Oct 1, 2024 · 5b52906 · 5b52906
2 parents 7397971 + 896821e
commit 5b52906
Show file tree

Hide file tree

Showing 4 changed files with 241 additions and 155 deletions.
diff --git a/server/docs/swagger.ts b/server/docs/swagger.ts
@@ -1,5 +1,5 @@
 import { BASE_URL } from 'server/config'
-import type { IGroup, IGroupFields } from 'server/models'
+import type { IGroup, IGroupFields, IUser } from 'server/models'
 import { ResponseCodes, formatJsonResponse } from 'server/utils'
 import swaggerAutogen from 'swagger-autogen'
 
@@ -44,7 +44,14 @@ const doc = {
   },
   definitions: {
     IGroupFields: { name: '', ownerId: '' } as IGroupFields,
-    IGroup: { id: '', name: '', ownerId: '' } as IGroup
+    IGroup: { id: '', name: '', ownerId: '' } as IGroup,
+    IUser: new class implements IUser {
+      id: string = 'some-id'
+      email: string = '[email protected]'
+      firstName?: string | undefined
+      lastName?: string | undefined
+      image?: string | undefined
+    }()
   }
 }
 const generateResponseDocs = () => {