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

zou/app/blueprints/crud/preview_background_file.py

@@ -1,3 +1,5 @@
+from flask_jwt_extended import jwt_required
+
 from zou.app.models.preview_background_file import PreviewBackgroundFile
 from zou.app.services.exception import WrongParameterException
 from zou.app.services import files_service, deletion_service
@@ -12,6 +14,133 @@ class PreviewBackgroundFilesResource(BaseModelsResource):
     def check_read_permissions(self, options=None):
         return True
 
+    @jwt_required()
+    def get(self):
+        """
+        Get preview background files
+        ---
+        tags:
+          - Crud
+        description: Retrieve all preview background files. 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: Preview background files 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 preview background file
+        ---
+        tags:
+          - Crud
+        description: Create a new preview background file with data
+          provided in the request body. JSON format is expected.
+          Names must be unique. If is_default is true, resets other
+          defaults.
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - name
+                properties:
+                  name:
+                    type: string
+                    example: background_file_name
+                  is_default:
+                    type: boolean
+                    default: false
+                    example: false
+        responses:
+            201:
+              description: Preview background file created successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: background_file_name
+                      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 name already exists
+        """
+        return super().post()
+
     def update_data(self, data):
         data = super().update_data(data)
         name = data.get("name", None)
@@ -36,6 +165,149 @@ class PreviewBackgroundFileResource(BaseModelResource):
     def check_read_permissions(self, instance):
         return True
 
+    @jwt_required()
+    def get(self, instance_id):
+        """
+        Get preview background file
+        ---
+        tags:
+          - Crud
+        description: Retrieve a preview background file 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: Preview background file retrieved successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: background_file_name
+                      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 preview background file
+        ---
+        tags:
+          - Crud
+        description: Update a preview background file with data provided
+          in the request body. JSON format is expected. Names must be
+          unique. If is_default is set to true, resets other defaults.
+        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_background_file_name
+                  is_default:
+                    type: boolean
+                    example: true
+        responses:
+            200:
+              description: Preview background file updated successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: updated_background_file_name
+                      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 name already exists
+        """
+        return super().put(instance_id)
+
+    @jwt_required()
+    def delete(self, instance_id):
+        """
+        Delete preview background file
+        ---
+        tags:
+          - Crud
+        description: Delete a preview background file 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: Preview background file deleted successfully
+            400:
+              description: Integrity error or cannot delete
+        """
+        return super().delete(instance_id)
+
     def update_data(self, data, instance_id):
         data = super().update_data(data, instance_id)
         name = data.get("name", None)

zou/app/blueprints/crud/preview_file.py

@@ -21,6 +21,141 @@ class PreviewFilesResource(BaseModelsResource):
     def __init__(self):
         BaseModelsResource.__init__(self, PreviewFile)
 
+    @jwt_required()
+    def get(self):
+        """
+        Get preview files
+        ---
+        tags:
+          - Crud
+        description: Retrieve all preview files. Supports filtering via
+          query parameters and pagination. Includes project permission
+          filtering. 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
+        responses:
+            200:
+              description: Preview files 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 preview file
+        ---
+        tags:
+          - Crud
+        description: Create a new preview file with data provided in the
+          request body. JSON format is expected.
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - name
+                  - task_id
+                properties:
+                  name:
+                    type: string
+                    example: preview_file_v001
+                  task_id:
+                    type: string
+                    format: uuid
+                    example: a24a6ea4-ce75-4665-a070-57453082c25
+                  revision:
+                    type: integer
+                    default: 1
+                    example: 1
+        responses:
+            201:
+              description: Preview file created successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: preview_file_v001
+                      task_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      revision:
+                        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 data format or validation error
+        """
+        return super().post()
+
     def add_project_permission_filter(self, query):
         if not permissions.has_admin_permissions():
             query = (
@@ -61,6 +196,133 @@ class PreviewFileResource(BaseModelResource):
             user_service.check_project_access(task["project_id"])
         return True
 
+    @jwt_required()
+    def get(self, instance_id):
+        """
+        Get preview file
+        ---
+        tags:
+          - Crud
+        description: Retrieve a preview file by its ID and return it as
+          a JSON object. Supports including relations. Vendors must be
+          working on the task. Artists must have project 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: Preview file retrieved successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: preview_file_v001
+                      task_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      revision:
+                        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 preview file
+        ---
+        tags:
+          - Crud
+        description: Update a preview file with data provided in the
+          request body. JSON format is expected. Requires project access.
+          Non-managers must be working on the task.
+        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_preview_file_v001
+                  revision:
+                    type: integer
+                    example: 2
+        responses:
+            200:
+              description: Preview file updated successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: updated_preview_file_v001
+                      task_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      revision:
+                        type: integer
+                        example: 2
+                      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, preview_file, data):
         task = tasks_service.get_task(preview_file["task_id"])
         user_service.check_project_access(task["project_id"])
@@ -76,25 +338,34 @@ class PreviewFileResource(BaseModelResource):
     @jwt_required()
     def delete(self, instance_id):
         """
-        Delete a preview file corresponding at given ID and retuns
-        a 204 status code.
+        Delete preview file
         ---
         tags:
           - Crud
+        description: Delete a preview file by its ID. Returns empty
+          response on success. May require force flag if file has
+          associated data.
         parameters:
           - in: path
             name: instance_id
-            required: True
-            type: string
-            format: uuid
+            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 file has associated data
         responses:
             204:
-                description: Model deleted
+              description: Preview file deleted successfully
             400:
-                description: Statement or integrity error
-            404:
-                description: Instance non-existant
+              description: Integrity error or cannot delete
         """
         instance = self.get_model_or_404(instance_id)