fix: update doc to encompose all response codes hopefully

.gitignore

@@ -2,4 +2,6 @@
 .idea
 keycloak/CAS/target
 docker-compose.yaml
-postgres/data
+node_modules
+.vscode
+postgres/data

config/backdev.docker-compose.yaml

@@ -48,4 +48,4 @@ services:
   #  container_name: MyINPulse-back
   #  ports:
   #    - "8081:8080"
-  
+  #

config/frontdev.docker-compose.yaml

@@ -42,11 +42,11 @@ services:
   #  ports:
   #    - "8080:80"
 
-  back:
-    build:
-      context: ./MyINPulse-back/
-      dockerfile: Dockerfile
-    container_name: MyINPulse-back
-    ports:
-      - "8081:8080"
+  #back:
+  #  build:
+  #    context: ./MyINPulse-back/
+  #    dockerfile: Dockerfile
+  #  container_name: MyINPulse-back
+  #  ports:
+  #    - "8081:8080"
   

config/prod.docker-compose.yaml

@@ -45,11 +45,11 @@ services:
     ports:
       - "8080:80"
 
-  back:
-    build:
-      context: ./MyINPulse-back/
-      dockerfile: Dockerfile
-    container_name: MyINPulse-back
-    #ports:
-    #  - "8081:8080"
+  #back:
+  #  build:
+  #    context: ./MyINPulse-back/
+  #    dockerfile: Dockerfile
+  #  container_name: MyINPulse-back
+  #  #ports:
+  #  #  - "8081:8080"
   

documentation/openapi/notes.md

@@ -0,0 +1,13 @@
+## API Endpoints notes
+
+### EntrepreneurApi and SharedApi
+#### Endpoint Name Changes
+- `/entrepreneur/lcsection/modify/{sectionId}` → `/entrepreneur/sectionCell/modify/{sectionId}`
+
+### Admin api
+- `/admin/appointments/report/{appointmentId}` has no PUT and DELETE
+- `/admin/request-join` and `/admin/request-join/decision/{joinRequestId}` have not yet been implemented
+
+### Unauth api
+- `/unauth/request-join/{projectId}` has not yet been implemented
+

documentation/openapi/run_doc.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+cd ./swagger-ui
+
+if [ ! -d "./node_modules/" ]
+then
+    npm install
+    npm install swagger-cli
+fi
+
+npm start

documentation/openapi/src/adminApi.yaml

@@ -0,0 +1,353 @@
+# Admin API Endpoints
+paths:
+  /admin/projects:
+    get:
+      operationId: getAdminProjects
+      summary: Get projects associated with the admin
+      tags:
+        - Admin API
+      security:
+        - MyINPulse: [MyINPulse-admin]
+      description: Retrieves a list of projects managed by the requesting admin, including details for overview.
+      responses:
+        "200":
+          description: OK - List of projects returned successfully.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "./main.yaml#/components/schemas/project"
+        "400":
+          description: Bad Request - Invalid project data provided (e.g., missing required fields).
+        "401":
+          description: Unauthorized - Authentication required or invalid token.
+          
+    post:
+      operationId: addProjectManually
+      summary: Manually add a new project
+      description: Creates a new project with the provided details. (NOTE that this meant for manually inserting projects, for example importing already existing projects).
+      tags:
+        - Admin API
+      security:
+        - MyINPulse: [MyINPulse-admin]
+      requestBody:
+        required: true
+        description: Project details to create. `idProject` and `creationDate` will be ignored if sent and set by the server.
+        content:
+          application/json:
+            schema:
+              $ref: "./main.yaml#/components/schemas/project"
+      responses:
+        "201": # Use 201 Created for successful creation
+          description: Created - Project added successfully. Returns the created project.
+          content:
+            application/json:
+              schema:
+                $ref: "./main.yaml#/components/schemas/project"
+        "409":
+          description: Bad Request - Project already exists.
+        "401":
+          description: Unauthorized.
+          
+
+  /admin/projects/pending:
+    get:
+      operationId: getPendingProjects
+      summary: Get projects awaiting validation
+      tags:
+        - Admin API
+      security:
+        - MyINPulse: [MyINPulse-admin]
+      description: Retrieves a list of projects submitted by entrepreneurs that are pending admin approval.
+      responses:
+        "200":
+          description: OK - List of pending projects returned.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "./main.yaml#/components/schemas/project" # Assuming pending projects use the same schema
+        "401":
+          description: Unauthorized.        
+
+  /admin/request-join:
+    get:
+      operationId: getPendingProjects
+      summary: Get entrepreneurs project join requests
+      tags:
+        - Admin API
+      security:
+        - MyINPulse: [MyINPulse-admin]
+      description:  Retrieves a list of pending requests from entrepreneurs to join an existing project.
+      responses:
+        "200":
+          description: OK - List of pending project join requests.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "./main.yaml#/components/schemas/joinRequest"
+        "401":
+          description: Unauthorized.
+  
+  /admin/request-join/decision/{joinRequestId}:
+    post:
+      summary: Approve or reject a pending project join request
+      tags:
+        - Admin API
+      security:
+        - MyINPulse: [MyINPulse-admin]
+      parameters:
+        - in: path
+          name: joinRequestId
+          required: true
+          schema:
+            type: integer
+          description: The ID of the pending join request to decide upon.
+        
+      description: |-
+        Allows an admin to make a decision on an ebtrepreneur's request to join an existing project awaiting validation.
+        If approved (isAccepted=true), the entrepreneur is linked to the project with ID joinRequestId.
+        If rejected (isAccepted=false), the pending request data might be archived or deleted based on business logic.
+      responses:
+        "200":
+          description: OK - No Content, decision processed successfully..
+          content:
+            application/json:
+              $ref: "./main.yaml#/components/schemas/joinRequestDecision"
+        "400":
+          description: Bad Request - Invalid input (e.g., missing decision).
+        "401":
+          description: Unauthorized.     
+
+
+  /admin/projects/pending/decision:
+    post:
+      operationId: decidePendingProject
+      summary: Approve or reject a pending project
+      tags:
+        - Admin API
+      description: |-
+        Allows an admin to make a decision on a project awaiting validation.
+        If approved (isAccepted=true), the project status changes, and it's linked to the involved users.
+        If rejected (isAccepted=false), the pending project data might be archived or deleted based on business logic.
+      security:
+          - MyINPulse: [MyINPulse-admin]
+      parameters:
+        - in: path
+          name: pendingProjectId # Corrected typo and name change
+          required: true
+          schema:
+            type: integer
+          description: The ID of the pending project to decide upon.
+          example: 7
+      requestBody:
+        required: true
+        description: Decision payload.
+        content:
+          application/json:
+            schema:
+              $ref: './main.yaml#/components/schemas/projectDecision'
+      responses:
+        "204": # Use 204 No Content for successful action with no body
+          description: No Content - Decision processed successfully.
+        "400":
+          description: Bad Request - Invalid input (e.g., missing decision).
+        "401":
+          description: Unauthorized.
+          
+
+  /admin/pending-accounts: # Path updated
+    get:
+      operationId: getPendingAccounts
+      summary: Get accounts awaiting validation
+      description: Retrieves a list of entrepreneur user accounts that are pending admin validation.
+      tags:
+        - Admin API
+      security:
+          - MyINPulse: [MyINPulse-admin]
+      responses:
+        "200":
+          description: OK - List of pending accounts returned.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "./main.yaml#/components/schemas/user-entrepreneur"
+        "401":
+          description: Unauthorized.
+
+  /admin/accounts/validate/{userId}:
+    post: # Changed to POST as it changes state
+      operationId: validateUserAccount
+      summary: Validate a pending user account
+      description: Marks the user account specified by userId as validated/active.
+      tags:
+        - Admin API
+      security:
+          - MyINPulse: [MyINPulse-admin]
+      parameters:
+        - in: path
+          name: userId
+          required: true
+          schema:
+            type: integer
+          description: The ID of the user account to validate.
+          example: 102
+      responses:
+        "204":
+          description: No Content - Account validated successfully.
+        "400":
+          description: Bad Request - Invalid user ID format.
+          
+        "401":
+          description: Unauthorized.
+
+  /admin/appointments/upcoming:
+    get:
+      operationId: getUpcomingAppointments
+      summary: Get upcoming appointments for an admin
+      tags:
+        - Admin API
+      security:
+        - MyINPulse: [MyINPulse-admin]
+      description: Retrieves a list of appointments scheduled for an admin in the future.
+      responses:
+        "200":
+          description: OK - List of upcoming appointments.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "./main.yaml#/components/schemas/appointment"
+        "404":
+          description: no appointments found.
+        "401":
+          description: Unauthorized.
+
+  /admin/appointments/report/{appointmentId}:
+    post:
+      operationId: createAppointmentReport
+      summary: Create a report for an appointment
+      description: Creates and links a new report (e.g., meeting minutes) to the specified appointment using the provided content.
+      tags:
+        - Admin API
+      security:
+        - MyINPulse: [MyINPulse-admin]
+      parameters:
+        - in: path
+          name: appointmentId
+          required: true
+          schema:
+            type: integer
+          description: ID of the appointment to add a report to.
+          example: 303
+      requestBody:
+        required: true
+        description: Report content. `idReport` will be ignored if sent.
+        content:
+          application/json:
+            schema:
+              $ref: "./main.yaml#/components/schemas/report"
+      responses:
+        "201":
+          description: Created - Report created and linked successfully. Returns the created report.
+          content:
+             application/json:
+                schema: { $ref: "./main.yaml#/components/schemas/report" }
+        "400":
+          description: Bad Request - Invalid input (e.g., missing content, invalid appointment ID format).
+        "401":
+          description: Unauthorized.
+          
+    put: # Changed to PUT for update/replacement
+      operationId: updateAppointmentReport
+      summary: Update an existing appointment report
+      description: Updates the content of an existing report linked to the specified appointment. Replaces the entire report content.
+      tags:
+        - Admin API
+      security:
+        - MyINPulse: [MyINPulse-admin]
+      parameters:
+        - in: path
+          name: appointmentId
+          required: true
+          schema:
+            type: integer
+          description: ID of the appointment whose report needs updating.
+          example: 303
+      requestBody:
+        required: true
+        description: New report content. `idReport` in the body should match the existing report's ID or will be ignored.
+        content:
+          application/json:
+            schema:
+              $ref: "./main.yaml#/components/schemas/report"
+      responses:
+        "200":
+          description: OK - Report updated successfully. Returns the updated report.
+          content:
+             application/json:
+                schema: { $ref: "./main.yaml#/components/schemas/report" }
+        "400":
+          description: Bad Request - Invalid input (e.g., missing content).
+        "401":
+          description: Unauthorized.
+
+
+  /admin/projects/{projectId}:
+    delete:
+      operationId: removeProject
+      summary: Remove a project
+      description: Permanently removes the project specified by projectId and potentially related data (use with caution).
+      tags:
+        - Admin API
+      security:
+          - MyINPulse: [MyINPulse-admin]
+      parameters:
+        - in: path
+          name: projectId
+          required: true
+          schema:
+            type: integer
+          description: The ID of the project to remove.
+          example: 12
+      responses:
+        "204":
+          description: No Content - Project removed successfully.
+        "400":
+          description: Bad Request - Invalid project ID format.
+        "401":
+          description: Unauthorized.
+          
+
+
+  /admin/make-admin/{userId}:
+    post:
+      operationId: grantAdminRights
+      summary: Grant admin rights to a user
+      tags:
+        - Admin API
+      security:
+        - MyINPulse: [MyINPulse-admin]
+      description: Elevates the specified user to also have administrator privileges. Assumes the user already exists.
+      parameters:
+        - in: path
+          name: userId
+          required: true
+          schema:
+            type: integer
+          description: The ID of the user to grant admin rights.
+          example: 103
+      responses:
+        "204": # Use 204 No Content
+          description: No Content - Admin rights granted successfully.
+        "400":
+          description: Bad Request - Invalid user ID format or user is already an admin.     
+        "401":
+          description: Unauthorized.  

documentation/openapi/src/entrepreneurApi.yaml

@@ -0,0 +1,112 @@
+# Entrepreneur API Endpoints
+paths:
+  /entrepreneur/projects/request:
+    post:
+      operationId: requestProjectCreation
+      summary: Request creation and validation of a new project
+      tags:
+        - Entrepreneurs API
+      description: |-
+        Submits a request for a new project. The project details are provided in the request body.
+        The requesting entrepreneur (identified by the token) will be associated to it.
+        The project is created with a 'pending' status, awaiting admin approval.
+      security:
+        - MyINPulse: [MyINPulse-entrepreneur]
+      requestBody:
+        required: true
+        description: Project details for the request. `status`, `creationDate` are required by the model when being sent but is ignored by the server; 
+          primarily expects a valid `projectId`, `name`, `logo`.
+        content:
+          application/json:
+            schema:
+              $ref: "./main.yaml#/components/schemas/project"
+      responses:
+        "202":
+          description: Accepted - Project creation request received and is pending validation.
+        "400":
+          description: Bad Request - Invalid input (e.g., missing name).
+        "401":
+          description: Unauthorized.
+        
+  /entrepreneur/sectionCells: # Base path
+    post:
+      operationId: addSectionCell
+      summary: Add a cell to a Lean Canvas section
+      description: Adds a new cell (like a sticky note) with the provided content to a specific section of the entrepreneur's project's Lean Canvas. Assumes project context is known based on user's token.
+        `idSectionCell` and `modificationDate` are server-generated so they're values in the request are ignored by the server.
+      tags:
+       - Entrepreneurs API
+      security:
+        - MyINPulse: [MyINPulse-entrepreneur]
+      requestBody:
+        required: true
+        description: Section cell details. `idSectionCell` and `modificationDate` will be ignored if sent.
+        content:
+          application/json:
+            schema:
+              $ref: "./main.yaml#/components/schemas/sectionCell"
+      responses:
+        "201":
+          description: Created - Section cell added successfully. Returns the created cell.
+        "400":
+          description: Bad Request - Invalid input (e.g., missing content or sectionId).
+        "401":
+          description: Unauthorized.
+          
+  /entrepreneur/sectionCells/{sectionCellId}:
+    put:
+      operationId: modifySectionCell
+      summary: Modify data in a Lean Canvas section cell
+      description: Updates the content of an existing Lean Canvas section cell specified by `sectionCellId`. The server "updates" (it keeps a record of the previous version to keep a history of all the sectionCells and creates a new ones with the specified modifications) the `modificationDate`.
+      tags:
+       - Entrepreneurs API
+      security:
+        - MyINPulse: [MyINPulse-entrepreneur]
+      parameters:
+        - in: path
+          name: sectionCellId
+          required: true
+          schema:
+            type: integer
+          description: The ID of the section cell to modify.
+          example: 508
+      requestBody:
+        required: true
+        description: Updated section cell details. `sectionCellId` "the path parameter" is the only id that's consideredn the `sectionCellId` id in the request body is ignored. `modificationDate` should be updated by the server.
+        content:
+          application/json:
+            schema:
+              $ref: "./main.yaml#/components/schemas/sectionCell"
+      responses:
+        "200":
+          description: OK - Section cell updated successfully. Returns the updated cell.
+        "404":
+          description: Bad Request - Invalid input or ID mismatch.
+        "401":
+          description: Unauthorized.
+
+    delete:
+      operationId: removeSectionCell
+      summary: Remove a Lean Canvas section cell
+      description: Deletes the Lean Canvas section cell specified by `sectionCellId`.
+      tags:
+        - Entrepreneurs API
+      security:
+        - MyINPulse: [MyINPulse-entrepreneur]
+      parameters:
+        - in: path
+          name: sectionCellId
+          required: true
+          schema:
+            type: integer
+          description: The ID of the section cell to remove.
+          example: 509
+      responses:
+        "204":
+          description: No Content - Section cell removed successfully.
+        "400":
+          description: Bad Request - Invalid ID format.
+        "404":
+          description: Bad Request - sectionCell not found.
+        "401":
+          description: Unauthorized.

documentation/openapi/src/main.yaml

@@ -0,0 +1,146 @@
+openapi: 3.0.3
+info:
+  title: MyInpulse Backend API
+  description: This serves as an OpenAPI documentation for the MyInpulse backend service, covering operations for Entrepreneurs, Admins, and shared functionalities.
+  version: 0.2.1
+
+tags:
+  - name: Entrepreneurs API
+    description: API endpoints primarily for Entrepreneur users.
+  - name: Admin API
+    description: API endpoints restricted to Admin users for management tasks.
+  - name: Shared API
+    description: API endpoints accessible by both Entrepreneurs and Admins.
+  - name: Unauth API
+    description: API endpoints related to user account management.
+
+components:
+  schemas:
+    user:
+      $ref: "models.yaml#/user"
+    user-entrepreneur:
+      $ref: "models.yaml#/user-entrepreneur"
+    user-admin:
+      $ref: "models.yaml#/user-admin"
+    sectionCell:
+      $ref: "models.yaml#/sectionCell"
+    project:
+      $ref: "models.yaml#/project"
+    report:
+      $ref: "models.yaml#/report"
+    appointment:
+      $ref: "models.yaml#/appointment"
+    joinRequest:
+      $ref: "models.yaml#/joinRequest"
+    projectDecision:
+      $ref: "models.yaml#/projectDecision"
+    joinRequestDecision:
+      $ref: "models.yaml#/joinRequestDecision"
+
+  securitySchemes:
+      MyINPulse:
+        type: oauth2
+        description: OAuth2 authentication using Keycloak.
+        flows:
+          implicit:
+            authorizationUrl: '{keycloakBaseUrl}/realms/{keycloakRealm}/protocol/openid-connect/auth'
+            scopes:
+              MyINPulse-admin: Grants administrator access.
+              MyINPulse-entrepreneur: Grants standard entrepreneur user access.
+
+servers:
+    - url: '{serverProtocol}://{serverHost}:{serverPort}'
+      description: API Server
+      variables:
+        serverProtocol:
+          enum: [http, https]
+          default: http
+        serverHost:
+          default: localhost
+        serverPort:
+          enum: ['8081'] 
+          default: '8081'
+        keycloakBaseUrl:
+          default: http://localhost:7080
+          description: Base URL for the Keycloak server.
+        keycloakRealm:
+          default: MyInpulseRealm 
+          description: Keycloak realm name.
+
+paths:
+  #       _   _                   _   _        _          _ 
+  #      | | | |_ __   __ _ _   _| |_| |__    / \   _ __ (_)
+  #      | | | | '_ \ / _` | | | | __| '_ \  / _ \ | '_ \| |
+  #      | |_| | | | | (_| | |_| | |_| | | |/ ___ \| |_) | |
+  #       \___/|_| |_|\__,_|\__,_|\__|_| |_/_/   \_\ .__/|_|
+  #                                                |_|      
+
+  /unauth/finalize:
+    $ref: "./unauthApi.yaml#/paths/~1unauth~1finalize"
+  /unauth/request-join/{projectId}:
+    $ref: "./unauthApi.yaml#/paths/~1unauth~1request-join~1{projectId}"
+
+  #          _    ____  __  __ ___ _   _      _    ____ ___
+  #         / \  |  _ \|  \/  |_ _| \ | |    / \  |  _ \_ _|
+  #        / _ \ | | | | |\/| || ||  \| |   / _ \ | |_) | |
+  #       / ___ \| |_| | |  | || || |\  |  / ___ \|  __/| |
+  #      /_/   \_\____/|_|  |_|___|_| \_| /_/   \_\_|  |___|
+  #
+  /admin/pending-accounts:
+    $ref: "./adminApi.yaml#/paths/~1admin~1pending-accounts"
+  /admin/accounts/validate/{userId}:
+    $ref: "./adminApi.yaml#/paths/~1admin~1accounts~1validate~1{userId}"
+  /admin/request-join:
+    $ref: "./adminApi.yaml#/paths/~1admin~1request-join"
+  /admin/request-join/decision/{joinRequestId}:
+    $ref: "./adminApi.yaml#/paths/~1admin~1request-join~1decision~1{joinRequestId}"
+  /admin/projects:
+    $ref: "./adminApi.yaml#/paths/~1admin~1projects"
+  /admin/projects/pending:
+    $ref: "./adminApi.yaml#/paths/~1admin~1projects~1pending"
+  /admin/projects/pending/decision:
+    $ref: "./adminApi.yaml#/paths/~1admin~1projects~1pending~1decision"
+  /admin/appointments/report/{appointmentId}:
+    $ref: "./adminApi.yaml#/paths/~1admin~1appointments~1report~1{appointmentId}"
+  /admin/appointments/upcoming:
+    $ref: "./adminApi.yaml#/paths/~1admin~1appointments~1upcoming"
+  /admin/projects/{projectId}:
+    $ref: "./adminApi.yaml#/paths/~1admin~1projects~1{projectId}" 
+  /admin/make-admin/{userId}:
+    $ref: "./adminApi.yaml#/paths/~1admin~1make-admin~1{userId}"
+
+  #       ____  _                        _      _    ____ ___
+  #      / ___|| |__   __ _ _ __ ___  __| |    / \  |  _ \_ _|
+  #      \___ \| '_ \ / _` | '__/ _ \/ _` |   / _ \ | |_) | |
+  #       ___) | | | | (_| | | |  __/ (_| |  / ___ \|  __/| |
+  #      |____/|_| |_|\__,_|_|  \___|\__,_| /_/   \_\_|  |___|
+  #
+  /shared/projects/sectionCells/{projectId}/{sectionId}/{date}:
+    $ref: "./sharedApi.yaml#/paths/~1shared~1projects~1sectionCells~1{projectId}~1{sectionId}~1{date}"
+  /shared/projects/entrepreneurs/{projectId}:
+    $ref: "./sharedApi.yaml#/paths/~1shared~1projects~1entrepreneurs~1{projectId}"
+  /shared/projects/admin/{projectId}:
+    $ref: "./sharedApi.yaml#/paths/~1shared~1projects~1admin~1{projectId}"
+  /shared/projects/appointments/{projectId}:
+    $ref: "./sharedApi.yaml#/paths/~1shared~1projects~1appointments~1{projectId}"
+  /shared/appointments/report/{appointmentId}:
+    $ref: "./sharedApi.yaml#/paths/~1shared~1appointments~1report~1{appointmentId}"
+  /shared/appointments/request:
+    $ref: "./sharedApi.yaml#/paths/~1shared~1appointments~1request"
+
+  #      _____ _   _ _____ ____  _____ ____  ____  _____ _   _ _____ _   _ ____
+  #     | ____| \ | |_   _|  _ \| ____|  _ \|  _ \| ____| \ | | ____| | | |  _ \
+  #     |  _| |  \| | | | | |_) |  _| | |_) | |_) |  _| |  \| |  _| | | | | |_) |
+  #     | |___| |\  | | | |  _ <| |___|  __/|  _ <| |___| |\  | |___| |_| |  _ <
+  #     |_____|_|_\_| |_| |_| \_\_____|_|   |_| \_\_____|_| \_|_____|\___/|_| \_\
+  #        / \  |  _ \_ _|
+  #       / _ \ | |_) | |
+  #      / ___ \|  __/| |
+  #     /_/   \_\_|  |___|
+  #
+  /entrepreneur/projects/request:
+    $ref: "./entrepreneurApi.yaml#/paths/~1entrepreneur~1projects~1request"
+  /entrepreneur/sectionCells:
+    $ref: "./entrepreneurApi.yaml#/paths/~1entrepreneur~1sectionCells"
+  /entrepreneur/sectionCells/{sectionCellId}:
+    $ref: "./entrepreneurApi.yaml#/paths/~1entrepreneur~1sectionCells~1{sectionCellId}"

documentation/openapi/src/models.yaml

@@ -0,0 +1,210 @@
+# models.yaml
+user:
+  type: object
+  properties:
+    idUser:
+      type: integer
+      description: Unique identifier for the user.
+      #readOnly: true # Typically generated by the server
+      example: 101
+    userSurname:
+      type: string
+      description: User's surname (last name).
+      example: "Doe"
+    userName:
+      type: string
+      description: User's given name (first name).
+      example: "John"
+    primaryMail:
+      type: string
+      format: email
+      description: User's primary email address.
+      example: "john.doe@example.com"
+    secondaryMail:
+      type: string
+      format: email
+      description: User's secondary email address (optional).
+      example: "j.doe@personal.com"
+    phoneNumber:
+      type: string
+      description: User's phone number.
+      example: "+33612345678" # Example using international format
+
+user-entrepreneur:
+  allOf:
+    - $ref: "#/user"
+    - type: object
+      properties:
+        school:
+          type: string
+          description: The school the entrepreneur attends/attended.
+          example: "ENSEIRB-MATMECA"
+        course:
+          type: string
+          description: The specific course or program of study.
+          example: "Electronics"
+        sneeStatus:
+          type: boolean
+          description: Indicates if the user has SNEE status (Statut National d'Étudiant-Entrepreneur).
+          example: true
+  example: # Added full object example
+    idUser: 101
+    userSurname: "Doe"
+    userName: "John"
+    primaryMail: "john.doe@example.com"
+    secondaryMail: "j.doe@personal.com"
+    phoneNumber: "+33612345678"
+    school: "ENSEIRB-MATMECA"
+    course: "Electronics"
+    sneeStatus: true
+
+user-admin:
+  allOf:
+    - $ref: "#/user"
+  # No additional properties needed for this example
+  example: # Added full object example
+    idUser: 55
+    userSurname: "Admin"
+    userName: "Super"
+    primaryMail: "admin@myinpulse.com"
+    phoneNumber: "+33512345678"
+
+sectionCell:
+  type: object
+  description: Represents a cell (like a sticky note) within a specific section of a project's Lean Canvas.
+  properties:
+    idSectionCell:
+      type: integer
+      description: Unique identifier for the section cell.
+      #readOnly: true # Generated by server
+      example: 508
+    sectionId:
+      type: integer
+      description: Identifier of the Lean Canvas section this cell belongs to (e.g., 1 for Problem, 2 for Solution).
+      example: 1
+    contentSectionCell:
+      type: string
+      description: The text content of the section cell.
+      example: "Users find it hard to track project progress."
+    modificationDate:
+      type: string
+      format: date # Using Java LocalDate -> YYYY-MM-DD
+      description: The date when this cell was last modified.
+      #readOnly: true # Typically updated by the server on modification
+      example: "yyyy-MM-dd HH:mm"
+
+project:
+  type: object
+  description: Represents a project being managed or developed.
+  properties:
+    idProject:
+      type: integer
+      description: Unique identifier for the project.
+      #readOnly: true # Generated by server
+      example: 12
+    projectName:
+      type: string
+      description: The name of the project.
+      example: "MyInpulse Mobile App"
+    creationDate:
+      type: string
+      format: date # Using Java LocalDate -> YYYY-MM-DD
+      description: The date when the project was created in the system.
+      #readOnly: true # Set by server
+      example: "yyyy-MM-dd HH:mm"
+    logo:
+      type: string
+      format: byte
+      description: Base64 encoded string representing the project logo image.
+      example: "/*Base64 encoded string representing the project logo image*/"
+    status:
+      type: string
+      enum: [PENDING, ACTIVE, ENDED, ABORTED, REJECTED]
+      description: Corresponds to a status enum internal to the backend, it's value in in requests
+        incoming to the server should be ignored as the client shouldn't be specifying them.
+      example: "NaN"
+
+joinRequest:
+  type: object
+  description: Represents a request from an entrepreneur to join an already existing project.
+  properties:
+    idProject:
+      type: integer
+      description: the ID of the project the entrepreneur wants to join.
+      example: 42
+    entrepreneur:
+      $ref: "#/user-entrepreneur"
+      
+
+report:
+  type: object
+  description: Represents a report associated with an appointment.
+  properties:
+    idReport:
+      type: integer
+      description: Unique identifier for the report.
+      #readOnly: true # Generated by server
+      example: 987
+    reportContent:
+      type: string
+      description: The textual content of the report. Could be plain text or Markdown (specify if known).
+      example: "Discussed roadmap milestones for Q3. Agreed on preliminary UI mockups."
+
+appointment: # Corrected typo
+  type: object
+  description: Represents a scheduled meeting or appointment.
+  properties:
+    idAppointment: # Assuming there's an ID
+        type: integer
+        description: Unique identifier for the appointment.
+        #readOnly: true
+        example: 303
+    appointmentDate:
+      type: string
+      format: date # Using Java LocalDate -> YYYY-MM-DD
+      description: The date of the appointment.
+      example: "2025-05-10"
+    appointmentTime:
+      type: string
+      format: time # Using Java LocalTime -> HH:mm:ss
+      description: The time of the appointment (local time).
+      example: "14:30:00"
+    appointmentDuration:
+      type: string
+      description: Duration of the appointment in ISO 8601 duration format (e.g., PT1H30M for 1 hour 30 minutes).
+      example: "PT1H" # Example for 1 hour
+    appointmentPlace:
+      type: string
+      description: Location or meeting link for the appointment.
+      example: "Meeting Room 3 / https://meet.example.com/abc-def-ghi"
+    appointmentSubject:
+      type: string
+      description: The main topic or subject of the appointment.
+      example: "Q3 Roadmap Planning"
+    # Consider adding project ID or user IDs if relevant association exists
+
+projectDecision:
+  type: object
+  description: Represents a decision from an admin to accept a pending project.
+  properties:
+    projectId:
+      type: integer
+      description: The ID of the project the entrepreneur wants to join.
+      example: 12
+    adminId: 
+      type: integer
+      description: The ID of the project the admin who will supervise the project in case of admission.
+      example: 2
+    isAccepted:
+      type: boolean
+      description: The boolean value of the decision.
+      example: "true"
+
+joinRequestDecision:
+  type: object
+  description: Represents a decision from an admin to accept a pending project join request.
+  properties:
+    isAccepted:
+      type: boolean
+      description: The boolean value of the decision.
+      example: "true"

documentation/openapi/src/sharedApi.yaml

@@ -0,0 +1,197 @@
+# Shared API Endpoints
+paths:    
+
+  /shared/projects/sectionCells/{projectId}/{sectionId}/{date}: 
+    get:
+      operationId: getSectionCellsByDate
+      summary: Get project section cells modified on a specific date
+      tags:
+        - Shared API
+      security:
+        - MyINPulse: [MyINPulse-entrepreneur, MyINPulse-admin]
+      description: Retrieves section cells belonging to a specific section of a project, filtered by the last modification date. Requires user to have access to the project.
+      parameters:
+        - in: path
+          name: projectId
+          required: true
+          schema: { type: integer }
+          description: ID of the project.
+        - in: path
+          name: sectionId
+          required: true
+          schema: { type: integer }
+          description: ID of the Lean Canvas section.
+        - in: path
+          name: date
+          required: true
+          schema: { type: string, format: date } # Expect YYYY-MM-DD
+          description: The modification date to filter by (YYYY-MM-DD HH:mm).
+      responses:
+        "200":
+          description: OK - List of section cells matching the criteria.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "./main.yaml#/components/schemas/sectionCell"
+        "400":
+          description: Bad Request - Invalid parameter format.         
+        "401":
+          description: Unauthorized.
+          
+
+  /shared/projects/entrepreneurs/{projectId}:
+    get:
+      operationId: getProjectEntrepreneurs
+      summary: Get entrepreneurs associated with a project
+      tags:
+        - Shared API
+      security:
+        - MyINPulse: [MyINPulse-entrepreneur, MyINPulse-admin]
+      description: Retrieves a list of entrepreneur users associated with the specified project. Requires access to the project.
+      parameters:
+        - in: path
+          name: projectId
+          required: true
+          schema: { type: integer }
+          description: ID of the project.
+      responses:
+        "200":
+          description: OK - List of entrepreneurs.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "./main.yaml#/components/schemas/user-entrepreneur"
+        "401":
+          description: Unauthorized.       
+        "403":
+          description: Forbidden - User does not have access to this project.         
+        "404":
+          description: Not Found - Project not found.       
+
+  /shared/projects/admin/{projectId}: # Path updated
+    get:
+      operationId: getProjectAdmin
+      summary: Get admin associated with a project
+      tags:
+        - Shared API
+      security:
+        - MyINPulse: [MyINPulse-entrepreneur, MyINPulse-admin]
+      description: Retrieves a list of admin users associated with the specified project. Requires access to the project.
+      parameters:
+        - in: path
+          name: projectId
+          required: true
+          schema: { type: integer }
+          description: ID of the project.
+      responses:
+        "200":
+          description: OK - admin.
+          content:
+            application/json:
+              schema:
+                $ref: "./main.yaml#/components/schemas/user-admin"
+        "401":
+          description: Unauthorized.       
+        "403":
+          description: Forbidden - User does not have access to this project.    
+        "404":
+          description: Not Found - Project not found.
+          
+
+  /shared/projects/appointments/{projectId}:
+    get:
+      operationId: getProjectAppointments
+      summary: Get appointments related to a project
+      tags:
+        - Shared API
+      security:
+        - MyINPulse: [MyINPulse-entrepreneur, MyINPulse-admin]
+      description: Retrieves a list of appointments associated with the specified project. Requires access to the project.
+      parameters:
+        - in: path
+          name: projectId
+          required: true
+          schema: { type: integer }
+          description: ID of the project.
+      responses:
+        "200":
+          description: OK - List of appointments.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "./main.yaml#/components/schemas/appointment"
+        "401":
+          description: Unauthorized.
+          
+
+  /shared/appointments/report/{appointmentId}: # Path updated
+    get:
+      operationId: getAppointmentReport # Shared endpoint implies read-only access might be possible
+      summary: Get the report for an appointment
+      tags:
+        - Shared API
+      security:
+        - MyINPulse: [MyINPulse-entrepreneur, MyINPulse-admin]
+      description: Retrieves the report associated with a specific appointment. Requires user to have access to the appointment/project.
+      parameters:
+        - in: path
+          name: appointmentId
+          required: true
+          schema: { type: integer }
+          description: ID of the appointment.
+      responses:
+        "200":
+          description: OK - Report PDF returned.
+          content:
+            application/pdf:
+              schema:
+                schema:
+                type: string
+                format: binary
+        "401":
+          description: Unauthorized.
+          
+
+  /shared/appointments/request:
+    post:
+      operationId: requestAppointment
+      summary: Request a new appointment
+      tags:
+        - Shared API
+      security:
+        - MyINPulse: [MyINPulse-entrepreneur, MyINPulse-admin]
+      description: Allows a user (entrepreneur or admin) to request a new appointment, potentially with another user or regarding a project. Details in the body. The request might need confirmation or create a pending appointment.
+      requestBody:
+        required: true
+        description: Details of the appointment request.
+        content:
+          application/json:
+            schema:
+              $ref: "./main.yaml#/components/schemas/appointment" # Assuming request uses same model structure
+            example:
+              value:
+                appointmentDate: "2025-06-01"
+                appointmentTime: "10:00:00"
+                appointmentDuration: "PT1H"
+                appointmentPlace: "Online"
+                appointmentSubject: "Follow-up on prototype"
+                # Potentially add projectId or targetUserId here
+      responses:
+        "202": # Accepted seems appropriate for a request
+          description: Accepted - Appointment request submitted.
+          content:
+            application/json: # Optionally return the pending appointment data
+              schema:
+                 $ref: "./main.yaml#/components/schemas/appointment"
+        "400":
+          description: Bad Request - Invalid appointment details.
+          
+        "401":
+          description: Unauthorized.
+          

documentation/openapi/src/unauthApi.yaml

@@ -0,0 +1,62 @@
+
+#       _   _                   _   _        _          _ 
+#      | | | |_ __   __ _ _   _| |_| |__    / \   _ __ (_)
+#      | | | | '_ \ / _` | | | | __| '_ \  / _ \ | '_ \| |
+#      | |_| | | | | (_| | |_| | |_| | | |/ ___ \| |_) | |
+#       \___/|_| |_|\__,_|\__,_|\__|_| |_/_/   \_\ .__/|_|
+#                                                |_|      
+
+paths:
+  /unauth/finalize:
+    post:
+      summary: Finalize account setup using authentication token
+      description: |-
+        Completes the user account creation/setup process in the MyInpulse system.
+        This endpoint requires the user to be authenticated via Keycloak (e.g., after initial login).
+        User details (name, email, etc.) are extracted from the authenticated user's token (e.g., Keycloak JWT).
+        No request body is needed. The account is marked as pending admin validation upon successful finalization.
+      tags:
+        - Unauth API
+      responses:
+        "201":
+          description: Created - Account finalized and pending admin validation. Returns the user profile.
+        "400":
+          description: Bad Request - Problem processing the token or user data derived from it.
+        "401":
+          description: Unauthorized - Valid authentication token required.
+  /unauth/request-join/{projectId}:
+    post:
+      summary: Request to join an existing project
+      description: Submits a request for the authenticated user (keycloack authenticated) to join the project specified by projectId. Their role is then changed to entrepreneur in server and Keycloak. This requires approval from a project admin.
+      tags:
+       - Unauth API
+      parameters:
+        - in: path
+          name: projectId
+          required: true
+          schema:
+            type: integer
+          description: The ID of the project to request joining.
+          example: 15
+      responses: # Moved responses block to correct level
+        "202":
+          description: Accepted - Join request submitted and pending approval.
+        "400":
+          description: Bad Request - Invalid project ID format 
+        "409":
+          description: Already member/request pending.
+        "401":
+          description: Unauthorized.
+  /unauth/request-admin-role:
+    post:
+      summary: Request to join an existing project
+      description: Submits a request for the authenticated user (keycloack authenticated) to become an admin. Their role is then changed to admin in server and Keycloak. This requires approval from a project admin.
+      tags:
+       - Unauth API
+      responses:
+        "202":
+          description: Accepted - Become admin request submitted and pending approval.
+        "400":
+          description: Bad Request - Invalid project ID format or already member/request pending.
+        "401":
+          description: Unauthorized.

documentation/openapi/swagger-ui/main.js

@@ -0,0 +1,14 @@
+const express = require("express");
+const swaggerUi = require("swagger-ui-express");
+const yaml = require("js-yaml");
+const fs = require("fs");
+
+const app = express();
+
+const swaggerDocument = yaml.load(fs.readFileSync("../src/bundled.yaml", "utf8"));
+
+app.use("/api-docs", swaggerUi.serve, swaggerUi.setup(swaggerDocument));
+
+app.listen(3000, () => {
+    console.log("Swagger UI running at http://localhost:3000/api-docs");
+});

documentation/openapi/swagger-ui/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "swagger-ui",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "bundle": "swagger-cli bundle -o ../src/bundled.yaml -t yaml ../src/main.yaml",
+    "start": "npm run bundle; node main.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "dependencies": {
+    "express": "^4.21.2",
+    "js-yaml": "^4.1.0",
+    "package.json": "^2.0.1",
+    "swagger-cli": "^4.0.4",
+    "swagger-ui-express": "^5.0.1"
+  }
+}