zou 0.20.83__py3-none-any.whl → 0.20.85__py3-none-any.whl

zou/__init__.py

@@ -1 +1 @@
-__version__ = "0.20.83"
+__version__ = "0.20.85"

zou/app/blueprints/comments/resources.py

@@ -20,12 +20,14 @@ from zou.app import config
 
 
 class DownloadAttachmentResource(Resource):
+
     @jwt_required()
     def get(self, attachment_file_id, file_name):
         """
         Download attachment file
         ---
-        description: Download a specific attachment file from a comment or chat message. Supports various file types including images and documents.
+        description: Download a specific attachment file from a comment or chat
+          message. Supports various file types including images and documents.
         tags:
           - Comments
         produces:
@@ -96,17 +98,14 @@ class DownloadAttachmentResource(Resource):
 
 
 class AckCommentResource(Resource):
-    """
-    Acknowledge given comment. If it's already acknowledged, remove
-    acknowledgement.
-    """
 
     @jwt_required()
     def post(self, task_id, comment_id):
         """
         Acknowledge comment
         ---
-        description: Acknowledge a specific comment. If it's already acknowledged, remove the acknowledgement.
+        description: Acknowledge a specific comment. If it's already
+          acknowledged, remove the acknowledgement.
         tags:
           - Comments
         parameters:
@@ -147,19 +146,16 @@ class AckCommentResource(Resource):
 
 
 class CommentTaskResource(Resource):
-    """
-    Creates a new comment for given task. It requires a text, a task_status
-    and a person as arguments. This way, comments keep history of status
-    changes. When the comment is created, it updates the task status with
-    given task status.
-    """
 
     @jwt_required()
     def post(self, task_id):
         """
         Create task comment
         ---
-        description: Create a new comment for a specific task. It requires a text, a task_status and a person as arguments. This way, comments keep history of status changes. When the comment is created, it updates the task status with the given task status.
+        description: Create a new comment for a specific task. It requires a
+          text, a task_status and a person as arguments. This way, comments
+          keep history of status changes. When the comment is created, it
+          updates the task status with the given task status.
         tags:
           - Comments
         parameters:
@@ -326,7 +322,8 @@ class AttachmentResource(Resource):
         """
         Delete comment attachment
         ---
-        description: Delete a specific attachment file linked to a comment. Only the comment author or project managers can delete attachments.
+        description: Delete a specific attachment file linked to a comment. Only
+          the comment author or project managers can delete attachments.
         tags:
           - Comments
         parameters:
@@ -371,7 +368,8 @@ class AddAttachmentToCommentResource(Resource):
         """
         Add comment attachments
         ---
-        description: Add one or more files as attachments to a specific comment. Supports various file types including images and documents.
+        description: Add one or more files as attachments to a specific comment.
+          Supports various file types including images and documents.
         tags:
           - Comments
         consumes:
@@ -452,19 +450,17 @@ class AddAttachmentToCommentResource(Resource):
 
 
 class CommentManyTasksResource(Resource):
-    """
-    Create several comments at once. Each comment requires a text, a task id,
-    a task_status and a person as arguments. This way, comments keep history of
-    status changes. When the comment is created, it updates the task status with
-    given task status.
-    """
 
     @jwt_required()
     def post(self, project_id):
         """
         Create multiple comments
         ---
-        description: Create several comments at once for a specific project. Each comment requires a text, a task id, a task_status and a person as arguments. This way, comments keep history of status changes. When the comment is created, it updates the task status with the given task status.
+        description: Create several comments at once for a specific project.
+          Each comment requires a text, a task id, a task_status and a person as
+          arguments. This way, comments keep history of status changes. When
+          the comment is created, it updates the task status with the given
+          task status.
         tags:
           - Comments
         parameters:
@@ -614,16 +610,14 @@ class CommentManyTasksResource(Resource):
 
 
 class ReplyCommentResource(Resource, ArgsMixin):
-    """
-    Reply to given comment. Add comment to its replies list.
-    """
 
     @jwt_required()
     def post(self, task_id, comment_id):
         """
         Reply to comment
         ---
-        description: Add a reply to a specific comment. The reply will be added to the comment's replies list.
+        description: Add a reply to a specific comment. The reply will be added
+          to the comment's replies list.
         tags:
           - Comments
         parameters:
@@ -703,16 +697,14 @@ class ReplyCommentResource(Resource, ArgsMixin):
 
 
 class DeleteReplyCommentResource(Resource):
-    """
-    Delete given comment reply.
-    """
 
     @jwt_required()
     def delete(self, task_id, comment_id, reply_id):
         """
         Delete comment reply
         ---
-        description: Delete a specific reply from a comment. Only the reply author or administrators can delete replies.
+        description: Delete a specific reply from a comment.
+         Only the reply author or administrators can delete replies.
         tags:
           - Comments
         parameters:
@@ -749,12 +741,14 @@ class DeleteReplyCommentResource(Resource):
 
 
 class ProjectAttachmentFiles(Resource):
+
     @jwt_required()
     def get(self, project_id):
         """
         Get project attachment files
         ---
-        description: Retrieve all attachment files related to a specific project. Requires administrator permissions.
+        description: Retrieve all attachment files related to a specific
+          project. Requires administrator permissions.
         tags:
           - Comments
         parameters:
@@ -810,16 +804,14 @@ class ProjectAttachmentFiles(Resource):
 
 
 class TaskAttachmentFiles(Resource):
-    """
-    Return all attachment files related to given task.
-    """
 
     @jwt_required()
     def get(self, task_id):
         """
         Get task attachment files
         ---
-        description: Retrieve all attachment files related to a specific task. Requires administrator permissions.
+        description: Retrieve all attachment files related to a specific task.
+          Requires administrator permissions.
         tags:
           - Comments
         parameters:
@@ -867,6 +859,11 @@ class TaskAttachmentFiles(Resource):
                         format: uuid
                         description: Task identifier
                         example: a24a6ea4-ce75-4665-a070-57453082c25
+                      reply_id:
+                        type: string
+                        format: uuid
+                        description: Reply identifier if attached to a reply
+                        example: c46c8gc6-eg97-6887-c292-79675204e47
         """
         permissions.check_admin_permissions()
         return comments_service.get_all_attachment_files_for_task(task_id)

zou/app/blueprints/concepts/resources.py

@@ -16,12 +16,14 @@ from zou.app.utils import query, permissions
 
 
 class ConceptResource(Resource, ArgsMixin):
+
     @jwt_required()
     def get(self, concept_id):
         """
         Get concept
         ---
-        description: Retrieve detailed information about a specific concept including metadata, project context, and related data.
+        description: Retrieve detailed information about a specific concept
+          including metadata, project context, and related data.
         tags:
           - Concepts
         parameters:
@@ -84,7 +86,8 @@ class ConceptResource(Resource, ArgsMixin):
         """
         Delete concept
         ---
-        description: Permanently remove a concept from the system. Only concept creators or project managers can delete concepts.
+        description: Permanently remove a concept from the system. Only concept
+          creators or project managers can delete concepts.
         tags:
           - Concepts
         parameters:
@@ -116,12 +119,15 @@ class ConceptResource(Resource, ArgsMixin):
 
 
 class AllConceptsResource(Resource):
+
     @jwt_required()
     def get(self):
         """
         Get all concepts
         ---
-        description: Retrieve all concept entries with filtering support. Filters can be specified in the query string to narrow down results by project or parent concept.
+        description: Retrieve all concept entries with filtering support.
+          Filters can be specified in the query string to narrow down results by
+          project or parent concept.
         tags:
           - Concepts
         parameters:
@@ -194,12 +200,14 @@ class AllConceptsResource(Resource):
 
 
 class ConceptTaskTypesResource(Resource):
+
     @jwt_required()
     def get(self, concept_id):
         """
         Get concept task types
         ---
-        description: Retrieve all task types that are related to a specific concept.
+        description: Retrieve all task types that are related to a specific
+          concept.
         tags:
           - Concepts
         parameters:
@@ -251,6 +259,7 @@ class ConceptTaskTypesResource(Resource):
 
 
 class ConceptTasksResource(Resource, ArgsMixin):
+
     @jwt_required()
     def get(self, concept_id):
         """
@@ -335,12 +344,15 @@ class ConceptTasksResource(Resource, ArgsMixin):
 
 
 class ConceptPreviewsResource(Resource):
+
     @jwt_required()
     def get(self, concept_id):
         """
         Get concept previews
         ---
-        description: Retrieve all preview files related to a specific concept. Returns them as a dictionary where keys are related task type IDs and values are arrays of previews for that task type.
+        description: Retrieve all preview files related to a specific concept.
+          Returns them as a dictionary where keys are related task type IDs and
+          values are arrays of previews for that task type.
         tags:
           - Concepts
         parameters:
@@ -405,7 +417,8 @@ class ConceptsAndTasksResource(Resource):
         """
         Get concepts and tasks
         ---
-        description: Retrieve all concepts and all related tasks included in the response.
+        description: Retrieve all concepts and all related tasks included in the
+          response.
         tags:
           - Concepts
         parameters:
@@ -498,7 +511,8 @@ class ProjectConceptsResource(Resource, ArgsMixin):
         """
         Get project concepts
         ---
-        description: Retrieve all concepts that are related to a specific project.
+        description: Retrieve all concepts that are related to a specific
+          project.
         tags:
           - Concepts
         parameters:
@@ -564,7 +578,8 @@ class ProjectConceptsResource(Resource, ArgsMixin):
         """
         Create concept
         ---
-        description: Create a new concept for a specific project with name, description, and optional entity concept links.
+        description: Create a new concept for a specific project with name,
+          description, and optional entity concept links.
         tags:
           - Concepts
         parameters:

zou/app/blueprints/crud/asset_instance.py

@@ -1,3 +1,5 @@
+from flask_jwt_extended import jwt_required
+
 from zou.app.models.asset_instance import AssetInstance
 
 from zou.app.services import assets_service, user_service
@@ -10,12 +12,282 @@ class AssetInstancesResource(BaseModelsResource):
     def __init__(self):
         BaseModelsResource.__init__(self, AssetInstance)
 
+    @jwt_required()
+    def get(self):
+        """
+        Get asset instances
+        ---
+        tags:
+          - Crud
+        description: Retrieve all asset instances. Supports filtering via
+          query parameters and pagination.
+        parameters:
+          - in: query
+            name: page
+            required: false
+            schema:
+              type: integer
+            example: 1
+            description: Page number for pagination
+          - in: query
+            name: limit
+            required: false
+            schema:
+              type: integer
+            example: 50
+            description: Number of results per page
+          - in: query
+            name: relations
+            required: false
+            schema:
+              type: boolean
+            default: false
+            example: false
+            description: Whether to include relations
+        responses:
+            200:
+              description: Asset instances retrieved successfully
+              content:
+                application/json:
+                  schema:
+                    oneOf:
+                      - type: array
+                        items:
+                          type: object
+                      - type: object
+                        properties:
+                          data:
+                            type: array
+                            items:
+                              type: object
+                            example: []
+                          total:
+                            type: integer
+                            example: 100
+                          nb_pages:
+                            type: integer
+                            example: 2
+                          limit:
+                            type: integer
+                            example: 50
+                          offset:
+                            type: integer
+                            example: 0
+                          page:
+                            type: integer
+                            example: 1
+            400:
+              description: Invalid filter format or query error
+        """
+        return super().get()
+
+    @jwt_required()
+    def post(self):
+        """
+        Create asset instance
+        ---
+        tags:
+          - Crud
+        description: Create a new asset instance with data provided in the
+          request body. JSON format is expected.
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - asset_id
+                properties:
+                  asset_id:
+                    type: string
+                    format: uuid
+                    example: a24a6ea4-ce75-4665-a070-57453082c25
+                  name:
+                    type: string
+                    example: Instance Name
+        responses:
+            201:
+              description: Asset instance created successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      asset_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: Instance Name
+                      created_at:
+                        type: string
+                        format: date-time
+                        example: "2024-01-15T10:30:00Z"
+                      updated_at:
+                        type: string
+                        format: date-time
+                        example: "2024-01-15T10:30:00Z"
+            400:
+              description: Invalid data format or validation error
+        """
+        return super().post()
+
 
 class AssetInstanceResource(BaseModelResource):
     def __init__(self):
         BaseModelResource.__init__(self, AssetInstance)
         self.protected_fields.append("number")
 
+    @jwt_required()
+    def get(self, instance_id):
+        """
+        Get asset instance
+        ---
+        tags:
+          - Crud
+        description: Retrieve an asset instance by its ID and return it as a
+          JSON object. Supports including relations.
+        parameters:
+          - in: path
+            name: instance_id
+            required: true
+            schema:
+              type: string
+              format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: query
+            name: relations
+            required: false
+            schema:
+              type: boolean
+            default: true
+            example: true
+            description: Whether to include relations
+        responses:
+            200:
+              description: Asset instance retrieved successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      asset_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: Instance Name
+                      number:
+                        type: integer
+                        example: 1
+                      created_at:
+                        type: string
+                        format: date-time
+                        example: "2024-01-15T10:30:00Z"
+                      updated_at:
+                        type: string
+                        format: date-time
+                        example: "2024-01-15T10:30:00Z"
+            400:
+              description: Invalid ID format or query error
+        """
+        return super().get(instance_id)
+
+    @jwt_required()
+    def put(self, instance_id):
+        """
+        Update asset instance
+        ---
+        tags:
+          - Crud
+        description: Update an asset instance with data provided in the
+          request body. JSON format is expected.
+        parameters:
+          - in: path
+            name: instance_id
+            required: true
+            schema:
+              type: string
+              format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  name:
+                    type: string
+                    example: Updated Instance Name
+        responses:
+            200:
+              description: Asset instance updated successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      asset_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: Updated Instance Name
+                      created_at:
+                        type: string
+                        format: date-time
+                        example: "2024-01-15T10:30:00Z"
+                      updated_at:
+                        type: string
+                        format: date-time
+                        example: "2024-01-15T11:00:00Z"
+            400:
+              description: Invalid data format or validation error
+        """
+        return super().put(instance_id)
+
+    @jwt_required()
+    def delete(self, instance_id):
+        """
+        Delete asset instance
+        ---
+        tags:
+          - Crud
+        description: Delete an asset instance by its ID. Returns empty
+          response on success.
+        parameters:
+          - in: path
+            name: instance_id
+            required: true
+            schema:
+              type: string
+              format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+        responses:
+            204:
+              description: Asset instance deleted successfully
+            400:
+              description: Integrity error or cannot delete
+        """
+        return super().delete(instance_id)
+
     def check_read_permissions(self, instance):
         if permissions.has_admin_permissions():
             return True