diff --git a/MyINPulse-back/src/main/resources/openapi/main.yaml b/Documentation/openapi/main.yaml similarity index 83% rename from MyINPulse-back/src/main/resources/openapi/main.yaml rename to Documentation/openapi/main.yaml index fd8d645..00dc3d4 100644 --- a/MyINPulse-back/src/main/resources/openapi/main.yaml +++ b/Documentation/openapi/main.yaml @@ -59,6 +59,14 @@ components: MyINPulse-entrepreneur: Utilisateur paths: + +# _ ____ __ __ ___ _ _ _ ____ ___ +# / \ | _ \| \/ |_ _| \ | | / \ | _ \_ _| +# / _ \ | | | | |\/| || || \| | / _ \ | |_) | | +# / ___ \| |_| | | | || || |\ | / ___ \| __/| | +# /_/ \_\____/|_| |_|___|_| \_| /_/ \_\_| |___| +# + /admin/projects: get: summary: Retourne la liste of projets associés à l'admin @@ -90,37 +98,182 @@ paths: description: Bad request "401": description: Authorization information is missing or invalid - - /admin/appointments/upcoming: - get: - summary: Retourne la list des prochains rendez-vous de l'admin - tags: + /admin/projects/pending/decision: + post: + summary: valider un projet en attente de validation + tags: - Admin API - security: - - MyINPulse: - - MyINPulse-admin description: - JSON array of upcoming appointment data (name, date, time etc..) for an admin. + if the request is accepted the status of the + project is changed to ongoing, entrepreneur + account is confirmed and the project is linked + to the admin accepting the request and the + entrepreneur requesting it. Else the pending + project and user info are deleted. + security: + - MyINPulse: + - MyINPulse-admin + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pedingProjectId: + type: integer + decision: + type: boolean + responses: - "200": + "200": description: OK - content: - application/json: - schema: - type: array - items: - type: object - properties: - name: - type: string - date: - type: string - time: - type: string "400": description: Bad request "401": - description: Authorization information is missing or invalid + description: Authorization information is + missing or invalid + + /admin/projects/add: + post: + summary: Ajout manuel d'un projet + description: + Adds a project with the + inputed details + tags: + - Admin API + security: + - MyINPulse: + - MyINPulse-admin + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + founder: + $ref: "#/components/schemas/user-entrepreneur" + + responses: + "200": + description: OK + "400": + description: Bad request + "401": + description: Authorization information is + missing or invalid + + /admin/appointments/report/{appointmentId}: + put: + summary: enregistrer un rapport du rendez-vous + description: + Generate a PDF file formatted + from input text and links it + to the appointement. + tags: + - Admin API + security: + - MyINPulse: + - MyINPulse-admin + parameters: + - in: path + name: appointmentId + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + title: + type: string + body: + type: string + conclusion: + type: string + + responses: + "200": + description: OK + "400": + description: Bad request + "401": + description: Authorization information is + missing or invalid + post: + summary: modifier un rapport déja éxistant du rendez-vous + description: + Modifies the report file to input + text and links it to the appointement. + tags: + - Admin API + security: + - MyINPulse: + - MyINPulse-admin + parameters: + - in: path + name: appointmentId + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + title: + type: string + body: + type: string + conclusion: + type: string + + responses: + "200": + description: OK + "400": + description: Bad request + "401": + description: Authorization information is + missing or invalid + + + /admin/projects/remove/{projectId}: + delete: + summary: supression d'un project + description: + Removes the project + with the inputed id projectId + tags: + - Admin API + security: + - MyINPulse: + - MyINPulse-admin + parameters: + - in: path + name: projectId + required: true + schema: + type: integer + + responses: + "200": + description: OK + "400": + description: Bad request + "401": + description: Authorization information is + missing or invalid + + /admin/projects/pending: get: summary: Retourne la liste des projets en attente de validation @@ -151,8 +304,48 @@ paths: description: Bad request "401": description: Authorization information is missing or invalid - - /shared/projects/lcsection/{projectId}/{title}/{date}: + +# +# ____ _ _ _ ____ ___ +# / ___|| |__ __ _ _ __ ___ __| | / \ | _ \_ _| +# \___ \| '_ \ / _` | '__/ _ \/ _` | / _ \ | |_) | | +# ___) | | | | (_| | | | __/ (_| | / ___ \| __/| | +# |____/|_| |_|\__,_|_| \___|\__,_| /_/ \_\_| |___| +# + + /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: + type: object + properties: + name: + type: string + date: + type: string + time: + type: string + "400": + description: Bad request + "401": + description: Authorization information is missing or invalid + + /shared/projects/lcsection/{projectId}: get: summary: Retourne la liste de sections de LC avec un titre donné tags: @@ -172,18 +365,19 @@ paths: schema: type: integer required: true - - in: path - name: title - schema: - type: string - required: true - description: the name of lc section - - in: path - name: date - required: false - schema: - type: string - description: the date corresponding to the wanted version of lc section + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + title: + type: integer + description: the number associated with the title of the lcsection + date: + type: string + description: the date corresponding to the wanted version of lc section responses: "200": description: OK @@ -239,7 +433,7 @@ paths: /shared/projects/admin/{projectId}: get: - summary: Retourne les inforùations de l'admin qui accompagne le projet + summary: Retourne les informations de l'admin qui accompagne le projet tags: - Shared API security: @@ -340,7 +534,65 @@ paths: "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. + tags: + - Shared API + security: + - MyINPulse: + - MyINPulse-entrepreneur + - MyINPulse-admin + requestBody: + required: true + 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 + + responses: + "200": + description: OK + "400": + description: Bad request + "401": + description: Authorization information is + missing or invalid + + + +# _____ _ _ _____ ____ _____ ____ ____ _____ _ _ _____ _ _ ____ +# | ____| \ | |_ _| _ \| ____| _ \| _ \| ____| \ | | ____| | | | _ \ +# | _| | \| | | | | |_) | _| | |_) | |_) | _| | \| | _| | | | | |_) | +# | |___| |\ | | | | _ <| |___| __/| _ <| |___| |\ | |___| |_| | _ < +# |_____|_|_\_| |_| |_| \_\_____|_| |_| \_\_____|_| \_|_____|\___/|_| \_\ +# / \ | _ \_ _| +# / _ \ | |_) | | +# / ___ \| __/| | +# /_/ \_\_| |___| +# + + /entrepreneur/projects/request: post: summary: demander la création et validation d'un projet @@ -373,101 +625,7 @@ paths: description: Authorization information is missing or invalid - /admin/projects/pending/decision: - post: - summary: valider un projet en attente de validation - tags: - - Admin API - description: - if the request is accepted the status of the - project is changed to ongoing, entrepreneur - account is confirmed and the project is linked - to the admin accepting the request and the - entrepreneur requesting it. Else the pending - project and user info are deleted. - security: - - MyINPulse: - - MyINPulse-admin - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - pedingProjectId: - type: integer - decision: - type: boolean - - responses: - "200": - description: OK - "400": - description: Bad request - "401": - description: Authorization information is - missing or invalid - - /admin/projects/add: - post: - summary: Ajout mannuel d'un projet - description: - Adds a project with the - inputed details - tags: - - Admin API - security: - - MyINPulse: - - MyINPulse-admin - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - founder: - $ref: "#/components/schemas/user-entrepreneur" - - responses: - "200": - description: OK - "400": - description: Bad request - "401": - description: Authorization information is - missing or invalid - - /admin/projects/remove/{projectId}: - delete: - summary: supression d'un project - description: - Removes the project - with the inputed id projectId - tags: - - Admin API - security: - - MyINPulse: - - MyINPulse-admin - parameters: - - in: path - name: projectId - required: true - schema: - type: integer - - responses: - "200": - description: OK - "400": - description: Bad request - "401": - description: Authorization information is - missing or invalid - + /entrepreneur/lcsection/add/{projectId}: post: summary: ajouter une sections au LC @@ -567,88 +725,6 @@ paths: description: Authorization information is missing or invalid - /shared/appointments/request: - post: - summary: demander une 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. - tags: - - Shared API - security: - - MyINPulse: - - MyINPulse-entrepreneur - - MyINPulse-admin - requestBody: - required: true - 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 - - responses: - "200": - description: OK - "400": - description: Bad request - "401": - description: Authorization information is - missing or invalid - - /admin/appointments/report/{appointmentId}: - post: - summary: enregistrer une rapport du rendez-vous - description: - Generate a PDF file formatted - from input text and links it - to the appointement. - tags: - - Admin API - security: - - MyINPulse: - - MyINPulse-admin - parameters: - - in: path - name: appointmentId - required: true - schema: - type: integer - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - title: - type: string - body: - type: string - conclusion: - type: string - - responses: - "200": - description: OK - "400": - description: Bad request - "401": - description: Authorization information is - missing or invalid + + \ No newline at end of file