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

zou/app/blueprints/crud/task.py

@@ -31,6 +31,84 @@ class TasksResource(BaseModelsResource, ArgsMixin):
     def check_read_permissions(self, options=None):
         return True
 
+    @jwt_required()
+    def get(self):
+        """
+        Get tasks
+        ---
+        tags:
+          - Crud
+        description: Retrieve all tasks. Supports filtering via query
+          parameters and pagination. Includes project permission filtering
+          for non-admin users. Vendor users only see assigned tasks.
+        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
+          - in: query
+            name: episode_id
+            required: false
+            schema:
+              type: string
+              format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+            description: Filter tasks by episode ID
+        responses:
+            200:
+              description: Tasks 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()
+
     def add_project_permission_filter(self, query):
         if permissions.has_vendor_permissions():
             query = query.filter(user_service.build_assignee_filter())
@@ -70,11 +148,68 @@ class TasksResource(BaseModelsResource, ArgsMixin):
 
         return query
 
+    @jwt_required()
     def post(self):
         """
-        Create a task with data given in the request body. JSON format is
-        expected. The model performs the validation automatically when
-        instantiated.
+        Create task
+        ---
+        tags:
+          - Crud
+        description: Create a task with data provided in the request
+          body. JSON format is expected. The task type must match the
+          entity type.
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - task_type_id
+                  - entity_id
+                properties:
+                  task_type_id:
+                    type: string
+                    format: uuid
+                    example: a24a6ea4-ce75-4665-a070-57453082c25
+                  entity_id:
+                    type: string
+                    format: uuid
+                    example: b24a6ea4-ce75-4665-a070-57453082c25
+                  assignees:
+                    type: array
+                    items:
+                      type: string
+                      format: uuid
+                    example: ["c24a6ea4-ce75-4665-a070-57453082c25"]
+        responses:
+            201:
+              description: Task created successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: d24a6ea4-ce75-4665-a070-57453082c25
+                      task_type_id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      entity_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      assignees:
+                        type: array
+                        items:
+                          type: string
+                          format: uuid
+                        example: ["c24a6ea4-ce75-4665-a070-57453082c25"]
+            400:
+              description: Task type does not match entity type or task already exists
         """
         try:
             data = request.json
@@ -131,6 +266,166 @@ class TaskResource(BaseModelResource, ArgsMixin):
         user_service.check_project_access(task["project_id"])
         user_service.check_entity_access(task["entity_id"])
 
+    @jwt_required()
+    def get(self, instance_id):
+        """
+        Get task
+        ---
+        tags:
+          - Crud
+        description: Retrieve a task by its ID and return it as a JSON
+          object. Supports including relations. Requires project and
+          entity access.
+        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: Task retrieved successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      task_type_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      entity_id:
+                        type: string
+                        format: uuid
+                        example: c24a6ea4-ce75-4665-a070-57453082c25
+                      project_id:
+                        type: string
+                        format: uuid
+                        example: d24a6ea4-ce75-4665-a070-57453082c25
+                      task_status_id:
+                        type: string
+                        format: uuid
+                        example: e24a6ea4-ce75-4665-a070-57453082c25
+                      assignees:
+                        type: array
+                        items:
+                          type: string
+                          format: uuid
+                        example: ["f24a6ea4-ce75-4665-a070-57453082c25"]
+                      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 task
+        ---
+        tags:
+          - Crud
+        description: Update a task with data provided in the request
+          body. JSON format is expected. Requires supervisor access.
+        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:
+                  task_status_id:
+                    type: string
+                    format: uuid
+                    example: b24a6ea4-ce75-4665-a070-57453082c25
+                  assignees:
+                    type: array
+                    items:
+                      type: string
+                      format: uuid
+                    example: ["c24a6ea4-ce75-4665-a070-57453082c25"]
+                  duration:
+                    type: number
+                    example: 8.5
+        responses:
+            200:
+              description: Task updated successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      task_type_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      entity_id:
+                        type: string
+                        format: uuid
+                        example: c24a6ea4-ce75-4665-a070-57453082c25
+                      project_id:
+                        type: string
+                        format: uuid
+                        example: d24a6ea4-ce75-4665-a070-57453082c25
+                      task_status_id:
+                        type: string
+                        format: uuid
+                        example: e24a6ea4-ce75-4665-a070-57453082c25
+                      assignees:
+                        type: array
+                        items:
+                          type: string
+                          format: uuid
+                        example: ["f24a6ea4-ce75-4665-a070-57453082c25"]
+                      duration:
+                        type: number
+                        example: 8.5
+                      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)
+
     def check_update_permissions(self, task, data):
         user_service.check_supervisor_task_access(task, data)
 
@@ -144,8 +439,33 @@ class TaskResource(BaseModelResource, ArgsMixin):
     @jwt_required()
     def delete(self, instance_id):
         """
-        Delete a model corresponding at given ID and return it as a JSON
-        object.
+        Delete task
+        ---
+        tags:
+          - Crud
+        description: Delete a task by its ID. Returns empty response on
+          success. May require force flag if task has associated data.
+        parameters:
+          - in: path
+            name: instance_id
+            required: true
+            schema:
+              type: string
+              format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: query
+            name: force
+            required: false
+            schema:
+              type: boolean
+            default: false
+            example: false
+            description: Force deletion even if task has associated data
+        responses:
+            204:
+              description: Task deleted successfully
+            400:
+              description: Integrity error or cannot delete
         """
         force = self.get_force()
 

zou/app/blueprints/crud/task_status.py

@@ -1,3 +1,5 @@
+from flask_jwt_extended import jwt_required
+
 from zou.app.models.task_status import TaskStatus
 from zou.app.services import tasks_service
 from zou.app.blueprints.crud.base import BaseModelResource, BaseModelsResource
@@ -10,6 +12,144 @@ class TaskStatusesResource(BaseModelsResource):
     def check_read_permissions(self, options=None):
         return True
 
+    @jwt_required()
+    def get(self):
+        """
+        Get task statuses
+        ---
+        tags:
+          - Crud
+        description: Retrieve all task statuses. 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: Task statuses 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 task status
+        ---
+        tags:
+          - Crud
+        description: Create a new task status with data provided in the
+          request body. JSON format is expected. If is_default is true,
+          sets all other statuses to non-default.
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - name
+                properties:
+                  name:
+                    type: string
+                    example: To Do
+                  short_name:
+                    type: string
+                    example: TODO
+                  color:
+                    type: string
+                    example: "#FF5733"
+                  is_default:
+                    type: boolean
+                    default: false
+                    example: false
+        responses:
+            201:
+              description: Task status created successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: To Do
+                      short_name:
+                        type: string
+                        example: TODO
+                      color:
+                        type: string
+                        example: "#FF5733"
+                      is_default:
+                        type: boolean
+                        example: false
+                      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()
+
     def post_creation(self, instance):
         tasks_service.clear_task_status_cache(str(instance.id))
         return instance.serialize()
@@ -29,6 +169,167 @@ class TaskStatusResource(BaseModelResource):
     def check_read_permissions(self, instance):
         return True
 
+    @jwt_required()
+    def get(self, instance_id):
+        """
+        Get task status
+        ---
+        tags:
+          - Crud
+        description: Retrieve a task status 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: Task status retrieved successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: To Do
+                      short_name:
+                        type: string
+                        example: TODO
+                      color:
+                        type: string
+                        example: "#FF5733"
+                      is_default:
+                        type: boolean
+                        example: false
+                      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 task status
+        ---
+        tags:
+          - Crud
+        description: Update a task status with data provided in the
+          request body. JSON format is expected. If is_default is set
+          to true, sets all other statuses to non-default.
+        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: In Progress
+                  short_name:
+                    type: string
+                    example: WIP
+                  color:
+                    type: string
+                    example: "#00FF00"
+                  is_default:
+                    type: boolean
+                    example: true
+        responses:
+            200:
+              description: Task status updated successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: In Progress
+                      short_name:
+                        type: string
+                        example: WIP
+                      color:
+                        type: string
+                        example: "#00FF00"
+                      is_default:
+                        type: boolean
+                        example: true
+                      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 task status
+        ---
+        tags:
+          - Crud
+        description: Delete a task status 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: Task status deleted successfully
+            400:
+              description: Integrity error or cannot delete
+        """
+        return super().delete(instance_id)
+
     def pre_update(self, instance_dict, data):
         if data.get("is_default", False):
             status = TaskStatus.get_by(is_default=True)