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

zou/app/blueprints/entities/resources.py

@@ -15,21 +15,23 @@ class EntityNewsResource(Resource):
     @jwt_required()
     def get(self, entity_id):
         """
-        Retrieve all news linked to a given entity.
+        Get entity news
         ---
+        description: Retrieve all news entries that are linked to a specific
+          entity.
         tags:
           - Entities
         parameters:
           - in: path
             name: entity_id
             required: true
-            schema:
-              type: string
-              format: uuid
+            type: string
+            format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
+            description: Unique identifier of the entity
         responses:
-          '200':
-            description: All news linked to given entity
+          200:
+            description: List of entity news successfully retrieved
             content:
               application/json:
                 schema:
@@ -40,21 +42,42 @@ class EntityNewsResource(Resource):
                       id:
                         type: string
                         format: uuid
-                      title:
-                        type: string
-                      content:
+                        description: News unique identifier
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      change:
+                        type: boolean
+                        description: Whether this news represents a change
+                        example: true
+                      author_id:
                         type: string
-                      created_at:
+                        format: uuid
+                        description: Author person identifier
+                        example: b35b7fb5-df86-5776-b181-68564193d36
+                      comment_id:
                         type: string
-                        format: date-time
-                      author_id:
+                        format: uuid
+                        description: Comment identifier
+                        example: c46c8gc6-eg97-6887-c292-79675204e47
+                      task_id:
                         type: string
                         format: uuid
-                      entity_id:
+                        description: Task identifier
+                        example: d57d9hd7-fh08-7998-d403-80786315f58
+                      preview_file_id:
                         type: string
                         format: uuid
-          '404':
-            description: Entity not found
+                        description: Preview file identifier
+                        example: e68e0ie8-gi19-8009-e514-91897426g69
+                      created_at:
+                        type: string
+                        format: date-time
+                        description: Creation timestamp
+                        example: "2023-01-01T12:00:00Z"
+                      updated_at:
+                        type: string
+                        format: date-time
+                        description: Last update timestamp
+                        example: "2023-01-01T12:30:00Z"
         """
         entity = entities_service.get_entity(entity_id)
         user_service.check_project_access(entity["project_id"])
@@ -65,21 +88,24 @@ class EntityPreviewFilesResource(Resource):
     @jwt_required()
     def get(self, entity_id):
         """
-        Retrieve all preview files linked to a given entity.
+        Get entity preview files
         ---
+        description: Retrieve all preview files that are linked to a specific
+          entity. This includes images, videos, and other preview media
+          associated with the entity.
         tags:
           - Entities
         parameters:
           - in: path
             name: entity_id
             required: true
-            schema:
-              type: string
-              format: uuid
+            type: string
+            format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
+            description: Unique identifier of the entity
         responses:
-          '200':
-            description: All preview files linked to given entity
+          200:
+            description: List of entity preview files successfully retrieved
             content:
               application/json:
                 schema:
@@ -90,23 +116,35 @@ class EntityPreviewFilesResource(Resource):
                       id:
                         type: string
                         format: uuid
+                        description: Preview file unique identifier
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
                       name:
                         type: string
+                        description: Preview file name
+                        example: "preview_001.jpg"
                       path:
                         type: string
+                        description: File path
+                        example: "/previews/entity/preview_001.jpg"
                       revision:
                         type: integer
+                        description: File revision number
+                        example: 1
                       created_at:
                         type: string
                         format: date-time
+                        description: Creation timestamp
+                        example: "2023-01-01T12:00:00Z"
                       entity_id:
                         type: string
                         format: uuid
+                        description: Entity identifier
+                        example: b35b7fb5-df86-5776-b181-68564193d36
                       task_id:
                         type: string
                         format: uuid
-          '404':
-            description: Entity not found
+                        description: Task identifier
+                        example: c46c8gc6-eg97-6887-c292-79675204e47
         """
         entity = entities_service.get_entity(entity_id)
         user_service.check_project_access(entity["project_id"])
@@ -117,21 +155,23 @@ class EntityTimeSpentsResource(Resource):
     @jwt_required()
     def get(self, entity_id):
         """
-        Retrieve all time spents linked to a given entity.
+        Get entity time spent
         ---
+        description: Retrieve all time spent entries that are linked to a
+          specific entity.
         tags:
           - Entities
         parameters:
           - in: path
             name: entity_id
             required: true
-            schema:
-              type: string
-              format: uuid
+            type: string
+            format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
+            description: Unique identifier of the entity
         responses:
-          '200':
-            description: All time spents linked to given entity
+          200:
+            description: List of entity time spent entries successfully retrieved
             content:
               application/json:
                 schema:
@@ -142,25 +182,33 @@ class EntityTimeSpentsResource(Resource):
                       id:
                         type: string
                         format: uuid
+                        description: Time spent unique identifier
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
                       duration:
                         type: number
                         format: float
+                        description: Time duration in hours
                         example: 2.5
                       date:
                         type: string
                         format: date
+                        description: Date when time was spent
                         example: "2023-12-07"
                       created_at:
                         type: string
                         format: date-time
+                        description: Creation timestamp
+                        example: "2023-01-01T12:00:00Z"
                       person_id:
                         type: string
                         format: uuid
+                        description: Person identifier who spent the time
+                        example: b35b7fb5-df86-5776-b181-68564193d36
                       entity_id:
                         type: string
                         format: uuid
-          '404':
-            description: Entity not found
+                        description: Entity identifier
+                        example: c46c8gc6-eg97-6887-c292-79675204e47
         """
         entity = entities_service.get_entity(entity_id)
         user_service.check_project_access(entity["project_id"])
@@ -171,21 +219,24 @@ class EntitiesLinkedWithTasksResource(Resource):
     @jwt_required()
     def get(self, entity_id):
         """
-        Resource to retrieve the entities linked on a given entity.
+        Get linked entities
         ---
+        description: Retrieve all entities that are linked to a specific entity
+          along with their associated tasks. This includes related entities,
+          dependencies, and hierarchical relationships.
         tags:
           - Entities
         parameters:
           - in: path
             name: entity_id
             required: true
-            schema:
-              type: string
-              format: uuid
+            type: string
+            format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
+            description: Unique identifier of the entity
         responses:
-          '200':
-            description: Entities linked on given entity
+          200:
+            description: List of linked entities successfully retrieved
             content:
               application/json:
                 schema:
@@ -196,17 +247,27 @@ class EntitiesLinkedWithTasksResource(Resource):
                       id:
                         type: string
                         format: uuid
+                        description: Entity unique identifier
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
                       name:
                         type: string
+                        description: Entity name
+                        example: "Character Model"
                       entity_type_id:
                         type: string
                         format: uuid
+                        description: Entity type identifier
+                        example: b35b7fb5-df86-5776-b181-68564193d36
                       project_id:
                         type: string
                         format: uuid
+                        description: Project identifier
+                        example: c46c8gc6-eg97-6887-c292-79675204e47
                       parent_id:
                         type: string
                         format: uuid
+                        description: Parent entity identifier
+                        example: d57d9hd7-fh08-7998-d403-80786315f58
                       tasks:
                         type: array
                         items:
@@ -215,13 +276,17 @@ class EntitiesLinkedWithTasksResource(Resource):
                             id:
                               type: string
                               format: uuid
+                              description: Task unique identifier
+                              example: e68e0ie8-gi19-8009-e514-91897426g69
                             name:
                               type: string
+                              description: Task name
+                              example: "Modeling Task"
                             task_type_id:
                               type: string
                               format: uuid
-          '404':
-            description: Entity not found
+                              description: Task type identifier
+                              example: f79f1jf9-hj20-9010-f625-02998537h80
         """
         entity = entities_service.get_entity(entity_id)
         user_service.check_project_access(entity["project_id"])

zou/app/blueprints/events/resources.py

@@ -12,8 +12,11 @@ class EventsResource(Resource, ArgsMixin):
     @jwt_required()
     def get(self):
         """
-        Retrieve last events.
+        Get events
         ---
+        description: Retrieve last events with filtering support. Filters can be
+          specified in the query string to narrow down results by date range,
+          project, or other criteria.
         tags:
           - Events
         parameters:
@@ -22,28 +25,74 @@ class EventsResource(Resource, ArgsMixin):
             type: string
             format: date
             example: "2022-07-12"
+            description: Filter events after this date
           - in: query
             name: before
             type: string
             format: date
             example: "2022-07-12"
+            description: Filter events before this date
           - in: query
             name: only_files
             type: boolean
-            default: False
+            default: false
+            description: Return only file-related events
+            example: false
           - in: query
             name: limit
             type: integer
             default: 100
             example: 100
+            description: Maximum number of events to return
           - in: query
             name: project_id
             type: string
             format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
+            description: Filter events by specific project
+          - in: query
+            name: name
+            type: string
+            example: "user_login"
+            description: Filter events by event name
         responses:
-            200:
-                description: All login logs
+          200:
+            description: List of events successfully retrieved
+            content:
+              application/json:
+                schema:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        description: Event unique identifier
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        description: Event name
+                        example: "user_login"
+                      data:
+                        type: object
+                        description: Event data content
+                        example: {"user_id": "b35b7fb5-df86-5776-b181-68564193d36"}
+                      project_id:
+                        type: string
+                        format: uuid
+                        description: Project identifier
+                        example: c46c8gc6-eg97-6887-c292-79675204e47
+                      created_at:
+                        type: string
+                        format: date-time
+                        description: Event timestamp
+                        example: "2023-01-01T12:00:00Z"
+                      user_id:
+                        type: string
+                        format: uuid
+                        description: User identifier who triggered the event
+                        example: d57d9hd7-fh08-7998-d403-80786315f58
         """
         args = self.get_args(
             [
@@ -82,23 +131,62 @@ class LoginLogsResource(Resource, ArgsMixin):
     @jwt_required()
     def get(self):
         """
-        Retrieve all login logs.
+        Get login logs
         ---
+        description: Retrieve all login logs with filtering support. Filters can
+          be specified in the query string to narrow down results by date range
+          and limit.
         tags:
           - Events
         parameters:
           - in: query
             name: before
             type: string
-            format: date
+            format: date-time
             example: "2022-07-12T00:00:00"
+            description: Filter logs before this date and time
           - in: query
             name: limit
             type: integer
             example: 100
+            description: Maximum number of login logs to return
         responses:
-            200:
-                description: All login logs
+          200:
+            description: List of login logs successfully retrieved
+            content:
+              application/json:
+                schema:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        description: Login log unique identifier
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      user_id:
+                        type: string
+                        format: uuid
+                        description: User identifier
+                        example: b35b7fb5-df86-5776-b181-68564193d36
+                      ip_address:
+                        type: string
+                        description: IP address of the login
+                        example: "192.168.1.100"
+                      user_agent:
+                        type: string
+                        description: User agent string
+                        example: "Mozilla/5.0 (Windows NT 10.0; Win64; x64)"
+                      success:
+                        type: boolean
+                        description: Whether the login was successful
+                        example: true
+                      created_at:
+                        type: string
+                        format: date-time
+                        description: Login timestamp
+                        example: "2023-01-01T12:00:00Z"
         """
         args = self.get_args(["before", ("limit", 100)])
 

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

@@ -17,20 +17,30 @@ class AssetsCsvExport(Resource):
     @jwt_required()
     def get(self, project_id):
         """
-        Export assets linked to a given project as csv.
+        Export assets csv
         ---
         tags:
           - Export
+        description: Export project assets as CSV file. Includes asset
+          information, task statuses, assignments, and metadata.
+        produces:
+          - text/csv
         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
         responses:
             200:
-                description: Assets exported as csv
+              description: Assets exported as CSV successfully
+              content:
+                text/csv:
+                  schema:
+                    type: string
+                  example: "Project,Type,Name,Description,Time Spent\nProject A,Character,Asset1,Description,10.50"
         """
         project = projects_service.get_project(project_id)
         self.check_permissions(project["id"])

zou/app/blueprints/export/csv/base.py

@@ -20,13 +20,22 @@ class BaseCsvExport(Resource):
     @jwt_required()
     def get(self):
         """
-        Export as csv.
+        Export csv
         ---
         tags:
-            - Export
+          - Export
+        description: Export data as CSV file. Returns a CSV file with
+          formatted data based on the resource type.
+        produces:
+          - text/csv
         responses:
             200:
-                description: Exported as csv
+              description: CSV file exported successfully
+              content:
+                text/csv:
+                  schema:
+                    type: string
+                  example: "Header1,Header2\nValue1,Value2"
         """
         self.prepare_import()
         try:

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

@@ -16,20 +16,47 @@ class CastingCsvExport(Resource, ArgsMixin):
     @jwt_required()
     def get(self, project_id):
         """
-        Export casting linked to a given project as csv.
+        Export casting csv
         ---
         tags:
           - Export
+        description: Export project casting links as CSV file. Includes
+          links between assets and shots, sequences, or episodes with
+          occurrence counts and labels.
+        produces:
+          - text/csv
         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: episode_id
+            required: false
+            schema:
+              type: string
+              format: uuid
+            example: b24a6ea4-ce75-4665-a070-57453082c25
+            description: Episode ID to filter casting links
+          - in: query
+            name: is_shot_casting
+            required: false
+            schema:
+              type: boolean
+            default: false
+            example: false
+            description: Whether to export shot casting only
         responses:
             200:
-                description: Casting exported as csv
+              description: Casting exported as CSV successfully
+              content:
+                text/csv:
+                  schema:
+                    type: string
+                  example: "Parent,Name,Asset Type,Asset,Occurences,Label\nSequence1,SH010,Character,Asset1,1,fixed"
         """
         project = projects_service.get_project(project_id)  # Check existence
         self.check_permissions(project_id)

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

@@ -16,20 +16,30 @@ class EditsCsvExport(Resource):
     @jwt_required()
     def get(self, project_id):
         """
-        Export edits linked to a given project as csv.
+        Export edits csv
         ---
         tags:
           - Export
+        description: Export project edits as CSV file. Includes edit
+          information, task statuses, assignments, and metadata.
+        produces:
+          - text/csv
         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
         responses:
             200:
-                description: Edits exported as csv
+              description: Edits exported as CSV successfully
+              content:
+                text/csv:
+                  schema:
+                    type: string
+                  example: "Project,Episode,Name,Description,Time Spent\nProject A,EP01,Edit_001,Description,8.75"
         """
         self.task_type_map = tasks_service.get_task_type_map()
         self.task_status_map = tasks_service.get_task_status_map()

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

@@ -1,4 +1,5 @@
 from zou.app.blueprints.export.csv.base import BaseCsvExport
+from flask_jwt_extended import jwt_required
 
 from zou.app.models.person import Person
 
@@ -8,6 +9,29 @@ class PersonsCsvExport(BaseCsvExport):
         BaseCsvExport.__init__(self)
         self.file_name = "people_export"
 
+    @jwt_required()
+    def get(self):
+        """
+        Export persons csv
+        ---
+        tags:
+          - Export
+        description: Export persons as CSV file. Includes person information
+          with last name, first name, email, phone, role, contract type,
+          and active status. Excludes bot accounts.
+        produces:
+          - text/csv
+        responses:
+            200:
+              description: Persons exported as CSV successfully
+              content:
+                text/csv:
+                  schema:
+                    type: string
+                  example: "Last Name,First Name,Email,Phone,Role,Contract Type,Active\nDoe,John,john.doe@example.com,+1234567890,user,freelance,yes"
+        """
+        return super().get()
+
     def build_headers(self):
         return [
             "Last Name",

zou/app/blueprints/export/csv/playlists.py

@@ -22,20 +22,31 @@ class PlaylistCsvExport(Resource):
     @jwt_required()
     def get(self, playlist_id):
         """
-        Export a given playlist as csv.
+        Export playlist csv
         ---
         tags:
           - Export
+        description: Export playlist as CSV file. Includes playlist shots
+          with preview information, task statuses, comments, and revision
+          details.
+        produces:
+          - text/csv
         parameters:
           - in: path
             name: playlist_id
-            required: True
-            type: string
-            format: uuid
+            required: true
+            schema:
+              type: string
+              format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
             200:
-                description: Playlist exported as csv
+              description: Playlist exported as CSV successfully
+              content:
+                text/csv:
+                  schema:
+                    type: string
+                  example: "Entity name,Nb Frames,Task Type,Retake count,Revision,Task Status,Last comment author,Last comment date,Last comment\nSH010,120,Animation,2,10,WIP,John Doe,2024-01-15,Good work"
         """
         user_service.block_access_to_vendor()
         playlist = playlists_service.get_playlist(playlist_id)