zou 0.20.82__py3-none-any.whl → 0.20.84__py3-none-any.whl

zou/app/blueprints/source/csv/assets.py

@@ -22,28 +22,66 @@ from zou.app.utils import events, cache, string
 class AssetsCsvImportResource(BaseCsvProjectImportResource):
     def post(self, project_id):
         """
-        Import project assets via a .csv file.
+        Import assets csv
         ---
         tags:
           - Import
+        description: Import project assets from a CSV file. Creates or updates
+          assets based on CSV rows. Supports metadata descriptors and task
+          status updates.
         consumes:
           - multipart/form-data
         parameters:
           - in: path
             name: project_id
-            required: True
-            type: string
-            format: uuid
+            required: true
+            schema:
+              type: string
+              format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: query
+            name: update
+            required: false
+            schema:
+              type: boolean
+            default: false
+            example: false
+            description: Whether to update existing assets
           - in: formData
             name: file
             type: file
             required: true
+            description: CSV file with asset data
         responses:
             201:
-                description: The lists of imported assets.
+              description: Assets imported successfully
+              content:
+                application/json:
+                  schema:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        id:
+                          type: string
+                          format: uuid
+                          example: a24a6ea4-ce75-4665-a070-57453082c25
+                        name:
+                          type: string
+                          example: Character A
+                        project_id:
+                          type: string
+                          format: uuid
+                          example: b24a6ea4-ce75-4665-a070-57453082c25
+                        entity_type_id:
+                          type: string
+                          format: uuid
+                          example: c24a6ea4-ce75-4665-a070-57453082c25
+                        description:
+                          type: string
+                          example: Main character asset
             400:
-                description: The .csv file is not properly formatted.
+              description: Invalid CSV format or missing required columns
         """
         return super().post(project_id)
 

zou/app/blueprints/source/csv/casting.py

@@ -15,28 +15,65 @@ from zou.app.utils import events
 class CastingCsvImportResource(BaseCsvProjectImportResource):
     def post(self, project_id):
         """
-        Import project casting links via a .csv file.
+        Import casting csv
         ---
         tags:
           - Import
+        description: Import project casting links from a CSV file. Links assets
+          to shots, sequences, or episodes based on CSV rows.
         consumes:
           - multipart/form-data
         parameters:
           - in: path
             name: project_id
-            required: True
-            type: string
-            format: uuid
+            required: true
+            schema:
+              type: string
+              format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: query
+            name: update
+            required: false
+            schema:
+              type: boolean
+            default: false
+            example: false
+            description: Whether to update existing casting links
           - in: formData
             name: file
             type: file
             required: true
+            description: CSV file with casting link data
         responses:
             201:
-                description: The lists of imported casting links.
+              description: Casting links imported successfully
+              content:
+                application/json:
+                  schema:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        id:
+                          type: string
+                          format: uuid
+                          example: a24a6ea4-ce75-4665-a070-57453082c25
+                        entity_in_id:
+                          type: string
+                          format: uuid
+                          example: b24a6ea4-ce75-4665-a070-57453082c25
+                        entity_out_id:
+                          type: string
+                          format: uuid
+                          example: c24a6ea4-ce75-4665-a070-57453082c25
+                        nb_occurences:
+                          type: integer
+                          example: 1
+                        label:
+                          type: string
+                          example: fixed
             400:
-                description: The .csv file is not properly formatted.
+              description: Invalid CSV format or missing required columns
         """
         return super().post(project_id)
 

zou/app/blueprints/source/csv/edits.py

@@ -27,28 +27,66 @@ from zou.app.utils import events, string
 class EditsCsvImportResource(BaseCsvProjectImportResource):
     def post(self, project_id):
         """
-        Import project edits.
+        Import edits csv
         ---
         tags:
           - Import
+        description: Import project edits from a CSV file. Creates or updates
+          edits based on CSV rows. Supports metadata descriptors and task
+          status updates.
         consumes:
           - multipart/form-data
         parameters:
+          - in: path
+            name: project_id
+            required: true
+            schema:
+              type: string
+              format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: query
+            name: update
+            required: false
+            schema:
+              type: boolean
+            default: false
+            example: false
+            description: Whether to update existing edits
           - in: formData
             name: file
             type: file
             required: true
-          - in: path
-            name: project_id
-            required: True
-            type: string
-            format: uuid
-            example: a24a6ea4-ce75-4665-a070-57453082c25
+            description: CSV file with edit data
         responses:
             201:
-                description: Edits imported
+              description: Edits imported successfully
+              content:
+                application/json:
+                  schema:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        id:
+                          type: string
+                          format: uuid
+                          example: a24a6ea4-ce75-4665-a070-57453082c25
+                        name:
+                          type: string
+                          example: Edit_001
+                        project_id:
+                          type: string
+                          format: uuid
+                          example: b24a6ea4-ce75-4665-a070-57453082c25
+                        parent_id:
+                          type: string
+                          format: uuid
+                          example: c24a6ea4-ce75-4665-a070-57453082c25
+                        description:
+                          type: string
+                          example: Edit description
             400:
-                description: Format error
+              description: Invalid CSV format or missing required columns
         """
         return super().post(project_id)
 

zou/app/blueprints/source/csv/persons.py

@@ -10,22 +10,61 @@ from zou.app.utils.string import strtobool
 class PersonsCsvImportResource(BaseCsvImportResource):
     def post(self):
         """
-        Import persons via a .csv file.
+        Import persons csv
         ---
         tags:
-            - Import
+          - Import
+        description: Import persons from a CSV file. Creates or updates
+          persons based on CSV rows. Supports role, contract type, and
+          active status updates.
         consumes:
           - multipart/form-data
         parameters:
+          - in: query
+            name: update
+            required: false
+            schema:
+              type: boolean
+            default: false
+            example: false
+            description: Whether to update existing persons
           - in: formData
             name: file
             type: file
             required: true
+            description: CSV file with person data
         responses:
             201:
-                description: The lists of imported persons.
+              description: Persons imported successfully
+              content:
+                application/json:
+                  schema:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        id:
+                          type: string
+                          format: uuid
+                          example: a24a6ea4-ce75-4665-a070-57453082c25
+                        first_name:
+                          type: string
+                          example: John
+                        last_name:
+                          type: string
+                          example: Doe
+                        email:
+                          type: string
+                          format: email
+                          example: john.doe@example.com
+                        phone:
+                          type: string
+                          example: +1234567890
+                        active:
+                          type: boolean
+                          example: true
             400:
-                description: The .csv file is not properly formatted.
+              description: Invalid CSV format or missing required columns
         """
         return super().post()
 

zou/app/blueprints/source/csv/shots.py

@@ -27,28 +27,69 @@ from zou.app.utils import events, string
 class ShotsCsvImportResource(BaseCsvProjectImportResource):
     def post(self, project_id):
         """
-        Import project shots via a .csv file.
+        Import shots csv
         ---
         tags:
           - Import
+        description: Import project shots from a CSV file. Creates or updates
+          shots based on CSV rows. Supports sequences, episodes, and task
+          status updates.
         consumes:
           - multipart/form-data
         parameters:
           - in: path
             name: project_id
-            required: True
-            type: string
-            format: uuid
+            required: true
+            schema:
+              type: string
+              format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: query
+            name: update
+            required: false
+            schema:
+              type: boolean
+            default: false
+            example: false
+            description: Whether to update existing shots
           - in: formData
             name: file
             type: file
             required: true
+            description: CSV file with shot data
         responses:
             201:
-                description: The lists of imported assets.
+              description: Shots imported successfully
+              content:
+                application/json:
+                  schema:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        id:
+                          type: string
+                          format: uuid
+                          example: a24a6ea4-ce75-4665-a070-57453082c25
+                        name:
+                          type: string
+                          example: SH010
+                        project_id:
+                          type: string
+                          format: uuid
+                          example: b24a6ea4-ce75-4665-a070-57453082c25
+                        parent_id:
+                          type: string
+                          format: uuid
+                          example: c24a6ea4-ce75-4665-a070-57453082c25
+                        nb_frames:
+                          type: integer
+                          example: 120
+                        description:
+                          type: string
+                          example: Shot description
             400:
-                description: The .csv file is not properly formatted.
+              description: Invalid CSV format or missing required columns
         """
         return super().post(project_id)
 

zou/app/blueprints/source/csv/task_type_estimations.py

@@ -16,9 +16,6 @@ from zou.app.utils import date_helpers
 
 
 class TaskTypeEstimationsCsvImportResource(BaseCsvProjectImportResource):
-    """
-    Import the estimations of task-types for given project.
-    """
 
     def check_permissions(self, project_id, task_type, episode_id=None):
         return user_service.check_supervisor_project_task_type_access(
@@ -27,34 +24,65 @@ class TaskTypeEstimationsCsvImportResource(BaseCsvProjectImportResource):
 
     def post(self, project_id, task_type_id, episode_id=None):
         """
-        Import the estimations of task-types for given project.
+        Import task type estimations csv
         ---
         tags:
           - Import
+        description: Import task type estimations from a CSV file. Updates
+          estimations, dates, and other task properties for assets or shots
+          based on CSV rows.
         consumes:
           - multipart/form-data
         parameters:
-          - in: formData
-            name: file
-            type: file
-            required: true
           - in: path
             name: project_id
-            required: True
-            type: string
-            format: uuid
+            required: true
+            schema:
+              type: string
+              format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
           - in: path
             name: task_type_id
-            required: True
-            type: string
-            format: uuid
-            example: a24a6ea4-ce75-4665-a070-57453082c25
+            required: true
+            schema:
+              type: string
+              format: uuid
+            example: b24a6ea4-ce75-4665-a070-57453082c25
+          - in: formData
+            name: file
+            type: file
+            required: true
+            description: CSV file with task estimation data
         responses:
             201:
-                description: Estimations imported
+              description: Task estimations imported successfully
+              content:
+                application/json:
+                  schema:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        id:
+                          type: string
+                          format: uuid
+                          example: a24a6ea4-ce75-4665-a070-57453082c25
+                        name:
+                          type: string
+                          example: Asset Modeling
+                        estimation:
+                          type: integer
+                          example: 480
+                        start_date:
+                          type: string
+                          format: date
+                          example: "2024-01-15"
+                        due_date:
+                          type: string
+                          format: date
+                          example: "2024-01-25"
             400:
-                description: Format error
+              description: Invalid CSV format or entity not found
         """
         task_type = tasks_service.get_task_type(task_type_id)
         return super().post(project_id, task_type, episode_id)
@@ -151,39 +179,71 @@ class TaskTypeEstimationsEpisodeCsvImportResource(
 ):
     def post(self, project_id, task_type_id, episode_id):
         """
-        Import the estimations of task-types for given episode of given project.
+        Import episode task type estimations csv
         ---
         tags:
           - Import
+        description: Import task type estimations from a CSV file for a
+          specific episode. Updates estimations, dates, and other task
+          properties for assets or shots based on CSV rows.
         consumes:
           - multipart/form-data
         parameters:
-          - in: formData
-            name: file
-            type: file
-            required: true
           - in: path
             name: project_id
-            required: True
-            type: string
-            format: uuid
+            required: true
+            schema:
+              type: string
+              format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
           - in: path
             name: task_type_id
-            required: True
-            type: string
-            format: uuid
-            example: a24a6ea4-ce75-4665-a070-57453082c25
+            required: true
+            schema:
+              type: string
+              format: uuid
+            example: b24a6ea4-ce75-4665-a070-57453082c25
           - in: path
             name: episode_id
-            required: True
-            type: string
-            format: uuid
-            example: a24a6ea4-ce75-4665-a070-57453082c25
+            required: true
+            schema:
+              type: string
+              format: uuid
+            example: c24a6ea4-ce75-4665-a070-57453082c25
+          - in: formData
+            name: file
+            type: file
+            required: true
+            description: CSV file with task estimation data
         responses:
             201:
-                description: Estimations imported
+              description: Task estimations imported successfully
+              content:
+                application/json:
+                  schema:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        id:
+                          type: string
+                          format: uuid
+                          example: a24a6ea4-ce75-4665-a070-57453082c25
+                        name:
+                          type: string
+                          example: Asset Modeling
+                        estimation:
+                          type: integer
+                          example: 480
+                        start_date:
+                          type: string
+                          format: date
+                          example: "2024-01-15"
+                        due_date:
+                          type: string
+                          format: date
+                          example: "2024-01-25"
             400:
-                description: Format error
+              description: Invalid CSV format or entity not found
         """
         return super().post(project_id, task_type_id, episode_id)