Feature / Update API Spec to v2.2.1 (#78)

Author: EnricoBausenhart

api/changelogs/changelog_v2_0.md api/changelogs/changelog_v2_0._0mdapi/changelogs/changelog_v2_0.md renamed to api/changelogs/changelog_v2_0._0md

@@ -1,6 +1,6 @@
 ## Info
 ### Version
-v2.0
+v2.0.0
 ### Date
 2025-06-26
 ### Autor

api/changelogs/changelog_v2_1.md api/changelogs/changelog_v2_1_0.mdapi/changelogs/changelog_v2_1.md renamed to api/changelogs/changelog_v2_1_0.md

@@ -1,6 +1,6 @@
 ## Info
 ### Version
-v2.1
+v2.1.0
 ### Date
 2025-06-27
 ### Autor

api/changelogs/changelog_v2_1_1.md

@@ -1,6 +1,6 @@
 ## Info
 ### Version
-v2.1
+v2.1.1
 ### Date
 2025-06-27
 ### Autor

api/changelogs/changelog_v2_1_5.md

@@ -1,6 +1,6 @@
 ## Info
 ### Version
-v2.1.4
+v2.1.5
 ### Date
 2025-07-01
 ### Autor

api/changelogs/changelog_v2_1_6.md

@@ -1,6 +1,6 @@
 ## Info
 ### Version
-v2.1.4
+v2.1.6
 ### Date
 2025-07-01
 ### Autor

api/changelogs/changelog_v2_2_0.md

@@ -0,0 +1,34 @@
+## Info
+### Version
+v2.2.0
+### Date
+2025-07-07
+### Autor
+James Stark & Enrico Bausenhart
+## Changelog:
+
+### Models
+- Add authID field to userNew
+
+``` diff
+
+@@ UserNew @@
++ create field authID
+# This means that newly created users will be tied to their Auth0 accounds
+
+
+```
+
+### Paths
+- Add new Endpoint GET@user/me to allow a user to retrieve their own ID based on auth0 sub
+
+
+``` diff
+
+@@ get-api-v2-user-me-auth-id @@
++ create new path /api/v2/user/me/{auth-id}
++ create new endpoint GET@/api/v2/user/me/{auth-id}
++ Add responses 200 (User)
++ Add responses 400, 403, 404
+
+```

api/changelogs/changelog_v2_2_1.md

@@ -0,0 +1,19 @@
+## Info
+### Version
+v2.2.1
+### Date
+2025-07-07
+### Autor
+James Stark & Enrico Bausenhart
+## Changelog:
+
+### Paths
+- Fix: add tag to GET@api/v2/user/me/{auth-id}
+
+
+``` diff
+
+@@ get-api-v2-user-me-auth-id @@
++ create new tag "User"
+
+```

api/flags/flags.yaml

@@ -3,4 +3,4 @@
 
 # DO NOT CHANGE
 info:
-  version: 2.1.6
+  version: 2.2.1

api/openapi.yaml

@@ -3,7 +3,7 @@ x-stoplight:
   id: ceylawji1yc2t
 info:
   title: MeetAtMensa
-  version: 2.1.6
+  version: 2.2.1
   description: |-
     This OpenAPI specification defines the endpoints, schemas, and security mechanisms
     for the Meet@Mensa User micro-service. 
@@ -58,6 +58,13 @@ components:
         type: string
         format: uuid
       description: UUID associated with a given match
+    auth-id:
+      name: auth-id
+      in: path
+      required: true
+      schema:
+        type: string
+      description: User's Auth0 sub ID
   schemas:
     ConversationStarter:
       title: ConversationStarter
@@ -568,6 +575,7 @@ components:
       type: object
       description: Object representing a student user in the Meet@Mensa system.
       required:
+        - authID
         - email
         - firstname
         - lastname
@@ -578,6 +586,11 @@ components:
         - interests
         - bio
       properties:
+        authID:
+          type: string
+          x-stoplight:
+            id: gtbfgvrafpds9
+          description: "Auth0 user.sub, used as a unique key\r\n"
         email:
           type: string
           x-stoplight:
@@ -1027,6 +1040,29 @@ paths:
         description: Request Conversation starter for these users
       description: Request a series of conversation starter prompts from the GenAI microservice. Provide infomation about users on request.
     parameters: []
+  '/api/v2/user/me/{auth-id}':
+    parameters:
+      - $ref: '#/components/parameters/auth-id'
+    get:
+      summary: Retrieve User based on AuthID
+      tags:
+        - User
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/User'
+        '400':
+          description: Bad Request
+        '403':
+          description: Forbidden
+        '404':
+          description: Not Found
+      operationId: get-api-v2-user-me-auth-id
+      x-stoplight:
+        id: 3fke7st84x7x9
 tags:
   - name: GenAI
     description: Paths belonging to the GenAI microservice

client/src/api.ts

@@ -214,6 +214,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v2/user/me/{auth-id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description User's Auth0 sub ID */
+                "auth-id": components["parameters"]["auth-id"];
+            };
+            cookie?: never;
+        };
+        /** Retrieve User based on AuthID */
+        get: operations["get-api-v2-user-me-auth-id"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -489,6 +509,9 @@ export interface components {
          * @description Object representing a student user in the Meet@Mensa system.
          */
         UserNew: {
+            /** @description Auth0 user.sub, used as a unique key
+             *      */
+            authID: string;
             /**
              * Format: email
              * @description Users's e-mail
@@ -614,6 +637,8 @@ export interface components {
         "request-id": string;
         /** @description UUID associated with a given match */
         "match-id": string;
+        /** @description User's Auth0 sub ID */
+        "auth-id": string;
     };
     requestBodies: never;
     headers: never;
@@ -1038,4 +1063,48 @@ export interface operations {
             };
         };
     };
+    "get-api-v2-user-me-auth-id": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description User's Auth0 sub ID */
+                "auth-id": components["parameters"]["auth-id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["User"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
 }