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

zou/app/blueprints/crud/search_filter_group.py

@@ -1,3 +1,5 @@
+from flask_jwt_extended import jwt_required
+
 from zou.app.models.search_filter_group import SearchFilterGroup
 
 from zou.app.blueprints.crud.base import BaseModelResource, BaseModelsResource
@@ -7,7 +9,275 @@ class SearchFilterGroupsResource(BaseModelsResource):
     def __init__(self):
         BaseModelsResource.__init__(self, SearchFilterGroup)
 
+    @jwt_required()
+    def get(self):
+        """
+        Get search filter groups
+        ---
+        tags:
+          - Crud
+        description: Retrieve all search filter groups. 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: Search filter groups 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 search filter group
+        ---
+        tags:
+          - Crud
+        description: Create a new search filter group with data
+          provided in the request body. JSON format is expected.
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - name
+                  - person_id
+                properties:
+                  name:
+                    type: string
+                    example: My Filter Group
+                  person_id:
+                    type: string
+                    format: uuid
+                    example: a24a6ea4-ce75-4665-a070-57453082c25
+        responses:
+            201:
+              description: Search filter group created successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: My Filter Group
+                      person_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-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 data format or validation error
+        """
+        return super().post()
+
 
 class SearchFilterGroupResource(BaseModelResource):
     def __init__(self):
         BaseModelResource.__init__(self, SearchFilterGroup)
+
+    @jwt_required()
+    def get(self, instance_id):
+        """
+        Get search filter group
+        ---
+        tags:
+          - Crud
+        description: Retrieve a search filter group 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: Search filter group retrieved successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: My Filter Group
+                      person_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-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 search filter group
+        ---
+        tags:
+          - Crud
+        description: Update a search filter group 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 Filter Group Name
+        responses:
+            200:
+              description: Search filter group 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 Filter Group Name
+                      person_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-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-15T11:00:00Z"
+            400:
+              description: Invalid data format or validation error
+        """
+        return super().put(instance_id)
+
+    @jwt_required()
+    def delete(self, instance_id):
+        """
+        Delete search filter group
+        ---
+        tags:
+          - Crud
+        description: Delete a search filter group 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: Search filter group deleted successfully
+            400:
+              description: Integrity error or cannot delete
+        """
+        return super().delete(instance_id)

zou/app/blueprints/crud/software.py

@@ -26,25 +26,45 @@ class SoftwareResource(BaseModelResource):
     @jwt_required()
     def get(self, instance_id):
         """
-        Retrieve a software corresponding at given ID and return it as a
-        JSON object.
+        Get software
         ---
         tags:
           - Crud
+        description: Retrieve a software instance by its ID and return it
+          as a JSON object.
         parameters:
           - in: path
-            name: software_id
-            required: True
-            type: string
-            format: uuid
+            name: instance_id
+            required: true
+            schema:
+              type: string
+              format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
         responses:
             200:
-                description: Model as a JSON object
+              description: Software retrieved successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: Maya
+                      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: Statement error
-            404:
-                description: Value error
+              description: Invalid ID format or query error
         """
         try:
             software = files_service.get_software(instance_id)

zou/app/blueprints/crud/status_automation.py

@@ -17,6 +17,149 @@ class StatusAutomationsResource(BaseModelsResource):
         user_service.block_access_to_vendor()
         return True
 
+    @jwt_required()
+    def get(self):
+        """
+        Get status automations
+        ---
+        tags:
+          - Crud
+        description: Retrieve all status automations. Supports filtering
+          via query parameters and pagination. Vendor access is blocked.
+        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: Status automations 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 status automation
+        ---
+        tags:
+          - Crud
+        description: Create a new status automation with data provided
+          in the request body. JSON format is expected.
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - source_task_status_id
+                  - target_task_status_id
+                  - field_name
+                  - field_value
+                properties:
+                  source_task_status_id:
+                    type: string
+                    format: uuid
+                    example: a24a6ea4-ce75-4665-a070-57453082c25
+                  target_task_status_id:
+                    type: string
+                    format: uuid
+                    example: b24a6ea4-ce75-4665-a070-57453082c25
+                  field_name:
+                    type: string
+                    example: ready_for
+                  field_value:
+                    type: string
+                    example: production
+        responses:
+            201:
+              description: Status automation created successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      source_task_status_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      target_task_status_id:
+                        type: string
+                        format: uuid
+                        example: c24a6ea4-ce75-4665-a070-57453082c25
+                      field_name:
+                        type: string
+                        example: ready_for
+                      field_value:
+                        type: string
+                        example: production
+                      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, status_automation):
         status_automations_service.clear_status_automation_cache()
         return status_automation.serialize()
@@ -26,6 +169,139 @@ class StatusAutomationResource(BaseModelResource):
     def __init__(self):
         BaseModelResource.__init__(self, StatusAutomation)
 
+    @jwt_required()
+    def get(self, instance_id):
+        """
+        Get status automation
+        ---
+        tags:
+          - Crud
+        description: Retrieve a status automation 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: Status automation retrieved successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      source_task_status_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      target_task_status_id:
+                        type: string
+                        format: uuid
+                        example: c24a6ea4-ce75-4665-a070-57453082c25
+                      field_name:
+                        type: string
+                        example: ready_for
+                      field_value:
+                        type: string
+                        example: production
+                      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 status automation
+        ---
+        tags:
+          - Crud
+        description: Update a status automation 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:
+                  field_name:
+                    type: string
+                    example: ready_for
+                  field_value:
+                    type: string
+                    example: approved
+        responses:
+            200:
+              description: Status automation updated successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      source_task_status_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      target_task_status_id:
+                        type: string
+                        format: uuid
+                        example: c24a6ea4-ce75-4665-a070-57453082c25
+                      field_name:
+                        type: string
+                        example: ready_for
+                      field_value:
+                        type: string
+                        example: approved
+                      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 post_update(self, status_automation, data):
         status_automations_service.clear_status_automation_cache()
         return status_automation
@@ -33,8 +309,26 @@ class StatusAutomationResource(BaseModelResource):
     @jwt_required()
     def delete(self, instance_id):
         """
-        Delete status automation corresponding at given ID and return it as a JSON
-        object.
+        Delete status automation
+        ---
+        tags:
+          - Crud
+        description: Delete a status automation by its ID. Returns empty
+          response on success. Cannot delete if automation is used in a
+          project.
+        parameters:
+          - in: path
+            name: instance_id
+            required: true
+            schema:
+              type: string
+              format: uuid
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+        responses:
+            204:
+              description: Status automation deleted successfully
+            400:
+              description: Automation is used in a project or integrity error
         """
         instance = self.get_model_or_404(instance_id)
         instance_dict = instance.serialize()