feat: updated doc to reflect details of server, still not done editing it
This commit is contained in:
@ -1,254 +1,218 @@
|
||||
# ____ _ _ _ ____ ___
|
||||
# / ___|| |__ __ _ _ __ ___ __| | / \ | _ \_ _|
|
||||
# \___ \| '_ \ / _` | '__/ _ \/ _` | / _ \ | |_) | |
|
||||
# ___) | | | | (_| | | | __/ (_| | / ___ \| __/| |
|
||||
# |____/|_| |_|\__,_|_| \___|\__,_| /_/ \_\_| |___|
|
||||
#
|
||||
# Shared API Endpoints
|
||||
paths:
|
||||
/shared/appointments/upcoming:
|
||||
get:
|
||||
summary: Retourne la list des prochains rendez-vous de l'utilisateur
|
||||
tags:
|
||||
- Shared API
|
||||
security:
|
||||
- MyINPulse:
|
||||
- MyINPulse-admin
|
||||
- MyINPulse-entrepreneur
|
||||
description:
|
||||
JSON array of upcoming appointment data (name, date, time etc..) for a user.
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: "main.yaml#/components/schemas/appointement"
|
||||
"400":
|
||||
description: Bad request
|
||||
"401":
|
||||
description: Authorization information is missing or invalid
|
||||
|
||||
/shared/projects/sectionCell/{projectId}/{sectionId}/{date}:
|
||||
get:
|
||||
summary: Retourne la liste de sections de LC avec un titre donné
|
||||
tags:
|
||||
- Shared API
|
||||
security:
|
||||
- MyINPulse:
|
||||
- MyINPulse-admin
|
||||
- MyINPulse-entrepreneur
|
||||
description:
|
||||
JSON array containing Lean Canvas
|
||||
section data with a title for the
|
||||
current date (or given date if the
|
||||
date parameter is passed)
|
||||
parameters:
|
||||
- in: path
|
||||
required: true
|
||||
name: projectId
|
||||
schema:
|
||||
type: integer
|
||||
- in: path
|
||||
required: true
|
||||
description: this number can be 1, 2,...,8. It is associated with the title of the sectionCell
|
||||
name: sectionId
|
||||
schema:
|
||||
type: integer
|
||||
enum: [1, 2, 3, 4, 5, 6, 7, 8]
|
||||
- in: path
|
||||
required: true
|
||||
name: date
|
||||
description: the date corresponding to the wanted version of lc section. "Nan" for the latest version
|
||||
example: "NaN"
|
||||
schema:
|
||||
type: string
|
||||
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: "main.yaml#/components/schemas/sectionCell"
|
||||
"400":
|
||||
description: Bad request
|
||||
"401":
|
||||
description: Authorization information is missing or invalid
|
||||
|
||||
/shared/projects/entrepreneurs/{projectId}:
|
||||
get:
|
||||
summary: Retourne la liste d'entrepreneurs associée à un projet donné
|
||||
tags:
|
||||
- Shared API
|
||||
security:
|
||||
- MyINPulse:
|
||||
- MyINPulse-admin
|
||||
- MyINPulse-entrepreneur
|
||||
description:
|
||||
JSON array of entrepreneur
|
||||
names associated with a project
|
||||
parameters:
|
||||
- in: path
|
||||
name: projectId
|
||||
schema:
|
||||
type: integer
|
||||
required: true
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: "main.yaml#/components/schemas/user-entrepreneur"
|
||||
"400":
|
||||
description: Bad request
|
||||
"401":
|
||||
description: Authorization information is missing or invalid
|
||||
|
||||
/shared/projects/admin/{projectId}:
|
||||
get:
|
||||
summary: Retourne les informations de l'admin qui accompagne le projet
|
||||
tags:
|
||||
- Shared API
|
||||
security:
|
||||
- MyINPulse:
|
||||
- MyINPulse-admin
|
||||
- MyINPulse-entrepreneur
|
||||
description:
|
||||
JSON object containing information (name, gmail, tel, etc..)
|
||||
the admin supervising the project with id projectID.
|
||||
parameters:
|
||||
- in: path
|
||||
name: projectId
|
||||
schema:
|
||||
type: integer
|
||||
required: true
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "main.yaml#/components/schemas/user-admin"
|
||||
"400":
|
||||
description: Bad request
|
||||
"401":
|
||||
description: Authorization information is
|
||||
missing or invalid
|
||||
|
||||
/shared/projects/appointments/{projectId}:
|
||||
get:
|
||||
summary: Retourne les rendez-vous du projet
|
||||
tags:
|
||||
- Shared API
|
||||
security:
|
||||
- MyINPulse:
|
||||
- MyINPulse-admin
|
||||
- MyINPulse-entrepreneur
|
||||
description:
|
||||
JSON array of upcoming and past appointment
|
||||
data for the project with id projectID.
|
||||
parameters:
|
||||
- in: path
|
||||
name: projectId
|
||||
schema:
|
||||
type: integer
|
||||
required: true
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: "main.yaml#/components/schemas/appointement"
|
||||
"400":
|
||||
description: Bad request
|
||||
"401":
|
||||
description: Authorization information is
|
||||
missing or invalid
|
||||
/shared/projects/appointments/report/{appointmentId}:
|
||||
get:
|
||||
summary: Retourne le rapport pdf du rendez-vous
|
||||
tags:
|
||||
- Shared API
|
||||
security:
|
||||
- MyINPulse:
|
||||
- MyINPulse-admin
|
||||
- MyINPulse-entrepreneur
|
||||
description:
|
||||
PDF file containing the ap-
|
||||
pointment report
|
||||
parameters:
|
||||
- in: path
|
||||
name: apointementId
|
||||
schema:
|
||||
type: integer
|
||||
required: true
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/pdf:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
"400":
|
||||
description: Bad request
|
||||
"401":
|
||||
description: Authorization information is
|
||||
missing or invalid
|
||||
|
||||
/shared/appointments/request:
|
||||
post:
|
||||
summary: demander un rendez-vous
|
||||
description:
|
||||
will add an appointement request request by the applicant
|
||||
to have an appointment to be confirmed or denied by the
|
||||
specified participants of the appointement.
|
||||
operationId: getUpcomingAppointments
|
||||
summary: Get upcoming appointments for the user
|
||||
tags:
|
||||
- Shared API
|
||||
security:
|
||||
- MyINPulse:
|
||||
- MyINPulse-entrepreneur
|
||||
- MyINPulse-admin
|
||||
- MyINPulse: [MyINPulse-entrepreneur, MyINPulse-admin] # Accessible by both
|
||||
description: Retrieves a list of appointments scheduled for the authenticated user (either entrepreneur or 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"
|
||||
"401":
|
||||
description: Unauthorized.
|
||||
|
||||
|
||||
/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).
|
||||
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/admins/{projectId}: # Path updated
|
||||
get:
|
||||
operationId: getProjectAdmins
|
||||
summary: Get admins 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 - List of admins.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$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 content returned.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "./main.yaml#/components/schemas/report"
|
||||
"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:
|
||||
description: \"participants\" property is an array containing userids of the participants in the appointement
|
||||
required: true
|
||||
description: Details of the appointment request.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
title:
|
||||
type: string
|
||||
start_time:
|
||||
type: string
|
||||
end_time:
|
||||
type: string
|
||||
place:
|
||||
type: string
|
||||
applicantId:
|
||||
type: integer
|
||||
participants:
|
||||
#/* */
|
||||
type: array
|
||||
items:
|
||||
type: integer
|
||||
|
||||
$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:
|
||||
"200":
|
||||
description: OK
|
||||
"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
|
||||
description: Bad Request - Invalid appointment details.
|
||||
|
||||
"401":
|
||||
description: Authorization information is
|
||||
missing or invalid
|
||||
|
||||
description: Unauthorized.
|
||||
|
||||
Reference in New Issue
Block a user