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

zou/app/blueprints/crud/metadata_descriptor.py

@@ -1,3 +1,5 @@
+from flask_jwt_extended import jwt_required
+
 from zou.app.models.metadata_descriptor import (
     MetadataDescriptor,
     METADATA_DESCRIPTOR_TYPES,
@@ -20,6 +22,157 @@ class MetadataDescriptorsResource(BaseModelsResource):
     def check_read_permissions(self, options=None):
         return not permissions.has_vendor_permissions()
 
+    @jwt_required()
+    def get(self):
+        """
+        Get metadata descriptors
+        ---
+        tags:
+          - Crud
+        description: Retrieve all metadata descriptors. Supports filtering
+          via query parameters and pagination. Vendor access is blocked.
+          Includes project permission filtering for non-admin users.
+        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: true
+            example: true
+            description: Whether to include relations
+        responses:
+            200:
+              description: Metadata descriptors retrieved successfully
+              content:
+                application/json:
+                  schema:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        id:
+                          type: string
+                          format: uuid
+                          example: a24a6ea4-ce75-4665-a070-57453082c25
+                        name:
+                          type: string
+                          example: Custom Field
+                        field_name:
+                          type: string
+                          example: custom_field
+                        data_type:
+                          type: string
+                          example: text
+                        project_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 filter format or query error
+        """
+        return super().get()
+
+    @jwt_required()
+    def post(self):
+        """
+        Create metadata descriptor
+        ---
+        tags:
+          - Crud
+        description: Create a new metadata descriptor with data provided in
+          the request body. JSON format is expected. Validates data_type.
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - name
+                  - field_name
+                  - data_type
+                  - project_id
+                properties:
+                  name:
+                    type: string
+                    example: Custom Field
+                  field_name:
+                    type: string
+                    example: custom_field
+                  data_type:
+                    type: string
+                    example: text
+                  project_id:
+                    type: string
+                    format: uuid
+                    example: a24a6ea4-ce75-4665-a070-57453082c25
+                  entity_type:
+                    type: string
+                    example: Asset
+        responses:
+            201:
+              description: Metadata descriptor created successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: Custom Field
+                      field_name:
+                        type: string
+                        example: custom_field
+                      data_type:
+                        type: string
+                        example: text
+                      project_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      entity_type:
+                        type: string
+                        example: Asset
+                      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 invalid data_type
+        """
+        return super().post()
+
     def add_project_permission_filter(self, query):
         if not permissions.has_admin_permissions():
             query = query.join(Project).filter(
@@ -52,6 +205,165 @@ class MetadataDescriptorResource(BaseModelResource):
     def __init__(self):
         BaseModelResource.__init__(self, MetadataDescriptor)
 
+    @jwt_required()
+    def get(self, instance_id):
+        """
+        Get metadata descriptor
+        ---
+        tags:
+          - Crud
+        description: Retrieve a metadata descriptor 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: Metadata descriptor retrieved successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: Custom Field
+                      field_name:
+                        type: string
+                        example: custom_field
+                      data_type:
+                        type: string
+                        example: text
+                      project_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      entity_type:
+                        type: string
+                        example: Asset
+                      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 metadata descriptor
+        ---
+        tags:
+          - Crud
+        description: Update a metadata descriptor with data provided in the
+          request body. JSON format is expected. Validates data_type.
+        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 Custom Field
+                  data_type:
+                    type: string
+                    example: number
+        responses:
+            200:
+              description: Metadata descriptor 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 Custom Field
+                      field_name:
+                        type: string
+                        example: custom_field
+                      data_type:
+                        type: string
+                        example: number
+                      project_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 invalid data_type
+        """
+        return super().put(instance_id)
+
+    @jwt_required()
+    def delete(self, instance_id):
+        """
+        Delete metadata descriptor
+        ---
+        tags:
+          - Crud
+        description: Delete a metadata descriptor 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: Metadata descriptor deleted successfully
+            400:
+              description: Integrity error or cannot delete
+        """
+        return super().delete(instance_id)
+
     def update_data(self, data, instance_id):
         """
         Check if the data descriptor has a valid data_type and valid

zou/app/blueprints/crud/milestone.py

@@ -1,3 +1,5 @@
+from flask_jwt_extended import jwt_required
+
 from zou.app.models.milestone import Milestone
 from zou.app.services import user_service
 
@@ -11,6 +13,143 @@ class MilestonesResource(BaseModelsResource):
     def check_create_permissions(self, milestone):
         user_service.check_manager_project_access(milestone["project_id"])
 
+    @jwt_required()
+    def get(self):
+        """
+        Get milestones
+        ---
+        tags:
+          - Crud
+        description: Retrieve all milestones. 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: Milestones 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 milestone
+        ---
+        tags:
+          - Crud
+        description: Create a new milestone with data provided in the
+          request body. JSON format is expected. Requires manager access
+          to the project.
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - name
+                  - project_id
+                  - date
+                properties:
+                  name:
+                    type: string
+                    example: Milestone Name
+                  project_id:
+                    type: string
+                    format: uuid
+                    example: a24a6ea4-ce75-4665-a070-57453082c25
+                  date:
+                    type: string
+                    format: date
+                    example: "2024-03-31"
+        responses:
+            201:
+              description: Milestone created successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: Milestone Name
+                      project_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      date:
+                        type: string
+                        format: date
+                        example: "2024-03-31"
+                      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 MilestoneResource(BaseModelResource):
     def __init__(self):
@@ -20,5 +159,167 @@ class MilestoneResource(BaseModelResource):
         user_service.check_project_access(milestone["project_id"])
         user_service.block_access_to_vendor()
 
+    @jwt_required()
+    def get(self, instance_id):
+        """
+        Get milestone
+        ---
+        tags:
+          - Crud
+        description: Retrieve a milestone by its ID and return it as a
+          JSON object. Supports including relations. Vendor access is
+          blocked. Requires 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: Milestone retrieved successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: Milestone Name
+                      project_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      date:
+                        type: string
+                        format: date
+                        example: "2024-03-31"
+                      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 milestone
+        ---
+        tags:
+          - Crud
+        description: Update a milestone with data provided in the request
+          body. JSON format is expected. Requires manager access to the
+          project.
+        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 Milestone Name
+                  date:
+                    type: string
+                    format: date
+                    example: "2024-04-30"
+        responses:
+            200:
+              description: Milestone 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 Milestone Name
+                      project_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      date:
+                        type: string
+                        format: date
+                        example: "2024-04-30"
+                      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 milestone
+        ---
+        tags:
+          - Crud
+        description: Delete a milestone 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: Milestone deleted successfully
+            400:
+              description: Integrity error or cannot delete
+        """
+        return super().delete(instance_id)
+
     def check_update_permissions(self, milestone, data):
-        user_service.check_manager_project_access(milestone["project_id"])
+        return user_service.check_manager_project_access(
+            milestone["project_id"]
+        )
+
+    def check_delete_permissions(self, milestone):
+        return user_service.check_manager_project_access(
+            milestone["project_id"]
+        )