fix(routes): Mettre à jour les descriptions des statuts des projets et des vidéos pour plus de clarté
All checks were successful
SSH Backend Deploy / ssh-deploy (push) Successful in 11s

This commit is contained in:
2025-04-27 14:51:40 +02:00
parent aa7f901442
commit 3d65ccb7fc
3 changed files with 8 additions and 11 deletions

View File

@@ -51,7 +51,7 @@ router.get('/camera/status', CameraController.getCameraStatus);
* example: 48 * example: 48
* status: * status:
* type: integer * type: integer
* description: Statut du projet (0: brouillon, 1: capturing, 2: idle, 3: stopping) * description: "Statut du projet: 0=brouillon, 1=capturing, 2=idle, 3=stopping"
* required: * required:
* - project_id * - project_id
* - interval * - interval
@@ -104,7 +104,7 @@ router.post('/procedure/start', CameraController.startProcedure);
* example: Procédure d'arrêt de la caméra initiée avec succès * example: Procédure d'arrêt de la caméra initiée avec succès
* status: * status:
* type: integer * type: integer
* description: Statut du projet (0: brouillon, 1: capturing, 2: idle, 3: stopping) * description: "Statut du projet: 0=brouillon, 1=capturing, 2=idle, 3=stopping"
* 500: * 500:
* $ref: '#/components/responses/ServerError' * $ref: '#/components/responses/ServerError'
*/ */
@@ -131,7 +131,7 @@ router.post('/procedure/stop', CameraController.stopProcedure);
* example: Caméra arrêtée avec succès * example: Caméra arrêtée avec succès
* status: * status:
* type: integer * type: integer
* description: Statut du projet (0: brouillon, 1: capturing, 2: idle, 3: stopping) * description: "Statut du projet: 0=brouillon, 1=capturing, 2=idle, 3=stopping"
* 500: * 500:
* $ref: '#/components/responses/ServerError' * $ref: '#/components/responses/ServerError'
*/ */
@@ -158,7 +158,7 @@ router.post('/camera/stop', CameraController.confirmStopProcedure);
* example: Caméra en mode maintenance * example: Caméra en mode maintenance
* status: * status:
* type: integer * type: integer
* description: Statut du projet (0: brouillon, 1: capturing, 2: idle, 3: stopping) * description: "Statut du projet: 0=brouillon, 1=capturing, 2=idle, 3=stopping"
* 500: * 500:
* $ref: '#/components/responses/ServerError' * $ref: '#/components/responses/ServerError'
*/ */
@@ -185,7 +185,7 @@ router.post('/camera/maintenance', CameraController.activateMaintenance);
* example: Caméra sortie du mode maintenance * example: Caméra sortie du mode maintenance
* status: * status:
* type: integer * type: integer
* description: Statut du projet (0: brouillon, 1: capturing, 2: idle, 3: stopping) * description: "Statut du projet: 0=brouillon, 1=capturing, 2=idle, 3=stopping"
* 500: * 500:
* $ref: '#/components/responses/ServerError' * $ref: '#/components/responses/ServerError'
*/ */

View File

@@ -147,7 +147,7 @@ router.get('/projects/:id/measurements', ProjectController.getProjectMeasurement
* description: Description détaillée du projet * description: Description détaillée du projet
* status: * status:
* type: integer * type: integer
* description: Statut du projet (0: draft, 1: capture, 2: idle, 3: stopping) * description: "Statut du projet: 0=brouillon, 1=capturing, 2=idle, 3=stopping"
* required: * required:
* - name * - name
* - description * - description

View File

@@ -220,12 +220,9 @@ router.get('/videos/file/:video_id', VideoController.getVideoFile);
* description: Temps estimé restant (secondes) * description: Temps estimé restant (secondes)
* example: 150 * example: 150
* status: * status:
* type: string
* description: État actuel du rendu
* example: En cours
* status:
* type: integer * type: integer
* description: Statut de la vidéo (0: waiting, 1: in_progress, 2: completed, 3: failed) * description: "Statut de la vidéo: 0=rendering, 1=completed, 2=error"
* example: 1
* 404: * 404:
* $ref: '#/components/responses/NotFound' * $ref: '#/components/responses/NotFound'
* 500: * 500: