fix: aadded changes, doc is ssomewhat coherent still need to change some endpoint names in controller and some minor changes
This commit is contained in:
documentation/openapi/src
@ -11,7 +11,7 @@ tags:
|
||||
description: API endpoints restricted to Admin users for management tasks.
|
||||
- name: Shared API
|
||||
description: API endpoints accessible by both Entrepreneurs and Admins.
|
||||
- name: Account Management API
|
||||
- name: Unauth API
|
||||
description: API endpoints related to user account management.
|
||||
|
||||
components:
|
||||
@ -32,32 +32,8 @@ components:
|
||||
$ref: "models.yaml#/appointment"
|
||||
joinRequest:
|
||||
$ref: "models.yaml#/joinRequest"
|
||||
ApiError:
|
||||
type: object
|
||||
properties:
|
||||
timestamp:
|
||||
type: string
|
||||
format: date-time
|
||||
description: Timestamp when the error occurred.
|
||||
status:
|
||||
type: integer
|
||||
description: HTTP status code.
|
||||
error:
|
||||
type: string
|
||||
description: High-level error description (e.g., Bad Request, Not Found).
|
||||
message:
|
||||
type: string
|
||||
description: A human-readable description of the error specific to this occurrence.
|
||||
example: Required field 'projectName' is missing.
|
||||
path:
|
||||
type: string
|
||||
description: The path of the request that triggered the error.
|
||||
required:
|
||||
- timestamp
|
||||
- status
|
||||
- error
|
||||
- message
|
||||
- path
|
||||
projectDecision:
|
||||
$ref: "models.yaml#/projectDecision"
|
||||
|
||||
securitySchemes:
|
||||
MyINPulse:
|
||||
@ -97,8 +73,10 @@ paths:
|
||||
# \___/|_| |_|\__,_|\__,_|\__|_| |_/_/ \_\ .__/|_|
|
||||
# |_|
|
||||
|
||||
/accounts/finalize:
|
||||
$ref: "./unauthApi.yaml#/paths/~1accounts~1finalize"
|
||||
/unauth/finalize:
|
||||
$ref: "./unauthApi.yaml#/paths/~1unauth~1finalize"
|
||||
/unauth/request-join/{projectId}:
|
||||
$ref: "./unauthApi.yaml#/paths/~1unauth~1request-join~1{projectId}"
|
||||
|
||||
# _ ____ __ __ ___ _ _ _ ____ ___
|
||||
# / \ | _ \| \/ |_ _| \ | | / \ | _ \_ _|
|
||||
@ -135,8 +113,8 @@ paths:
|
||||
$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/admins/{projectId}:
|
||||
$ref: "./sharedApi.yaml#/paths/~1shared~1projects~1admins~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}:
|
||||
@ -154,8 +132,6 @@ paths:
|
||||
# / ___ \| __/| |
|
||||
# /_/ \_\_| |___|
|
||||
#
|
||||
/entrepreneur/projects/request-join/{projectId}:
|
||||
$ref: "./entrepreneurApi.yaml#/paths/~1entrepreneur~1projects~1request-join~1{projectId}"
|
||||
/entrepreneur/projects/request:
|
||||
$ref: "./entrepreneurApi.yaml#/paths/~1entrepreneur~1projects~1request"
|
||||
/entrepreneur/sectionCells:
|
||||
|
Reference in New Issue
Block a user