feat: added doc for upcoming endpoints to finish up entrepreneur join, response codes remaining to update
All checks were successful
Format / formatting (push) Successful in 6s
Build / build (push) Successful in 39s
CI / build (push) Successful in 10s

This commit is contained in:
2025-04-21 10:54:50 +02:00
parent dfea20b9c4
commit 832539f43b
6 changed files with 179 additions and 47 deletions

View File

@@ -91,7 +91,7 @@ sectionCell:
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: "2025-04-15"
example: "yyyy-MM-dd HH:mm"
project:
type: object
@@ -111,7 +111,7 @@ project:
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: "2024-11-20"
example: "yyyy-MM-dd HH:mm"
logo:
type: string
format: byte
@@ -124,6 +124,18 @@ project:
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.
@@ -171,17 +183,6 @@ appointment: # Corrected typo
example: "Q3 Roadmap Planning"
# Consider adding project ID or user IDs if relevant association exists
joinRequest:
type: object
description: Represents a request from an entrepreneur to join an existing project.
properties:
projectId:
type: integer
description: The ID of the project the entrepreneur wants to join.
example: 12
# Consider adding userId if the requester isn't implicit from auth context
# Consider adding a message field
projectDecision:
type: object
description: Represents a decision from an admin to accept a pending project.
@@ -194,6 +195,15 @@ projectDecision:
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.