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

zou/app/blueprints/crud/playlist.py

@@ -1,3 +1,5 @@
+from flask_jwt_extended import jwt_required
+
 from zou.app.models.playlist import Playlist
 from zou.app.services import user_service, playlists_service
 
@@ -12,6 +14,150 @@ class PlaylistsResource(BaseModelsResource):
     def check_read_permissions(self, options=None):
         return True
 
+    @jwt_required()
+    def get(self):
+        """
+        Get playlists
+        ---
+        tags:
+          - Crud
+        description: Retrieve all playlists. 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: Playlists 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 playlist
+        ---
+        tags:
+          - Crud
+        description: Create a new playlist with data provided in the
+          request body. JSON format is expected. Requires supervisor
+          access to the project.
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - name
+                  - project_id
+                properties:
+                  name:
+                    type: string
+                    example: Playlist Name
+                  project_id:
+                    type: string
+                    format: uuid
+                    example: a24a6ea4-ce75-4665-a070-57453082c25
+                  episode_id:
+                    type: string
+                    format: uuid
+                    example: b24a6ea4-ce75-4665-a070-57453082c25
+                  task_type_id:
+                    type: string
+                    format: uuid
+                    example: c24a6ea4-ce75-4665-a070-57453082c25
+        responses:
+            201:
+              description: Playlist created successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: Playlist Name
+                      project_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      episode_id:
+                        type: string
+                        format: uuid
+                        example: c24a6ea4-ce75-4665-a070-57453082c25
+                      task_type_id:
+                        type: string
+                        format: uuid
+                        example: d24a6ea4-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()
+
     def check_create_permissions(self, playlist):
         user_service.check_supervisor_project_access(playlist["project_id"])
 
@@ -34,6 +180,182 @@ class PlaylistResource(BaseModelResource):
         user_service.check_project_access(playlist["project_id"])
         user_service.block_access_to_vendor()
 
+    @jwt_required()
+    def get(self, instance_id):
+        """
+        Get playlist
+        ---
+        tags:
+          - Crud
+        description: Retrieve a playlist by its ID and return it as a JSON
+          object. Supports including relations. Requires project access.
+          Vendor access is blocked.
+        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: Playlist retrieved successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: Playlist Name
+                      project_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      episode_id:
+                        type: string
+                        format: uuid
+                        example: c24a6ea4-ce75-4665-a070-57453082c25
+                      task_type_id:
+                        type: string
+                        format: uuid
+                        example: d24a6ea4-ce75-4665-a070-57453082c25
+                      shots:
+                        type: array
+                        items:
+                          type: object
+                        example: []
+                      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 playlist
+        ---
+        tags:
+          - Crud
+        description: Update a playlist with data provided in the request
+          body. JSON format is expected. Requires project access. Vendor
+          access is blocked.
+        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 Playlist Name
+                  shots:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        entity_id:
+                          type: string
+                          format: uuid
+                          example: b24a6ea4-ce75-4665-a070-57453082c25
+                        preview_file_id:
+                          type: string
+                          format: uuid
+                          example: c24a6ea4-ce75-4665-a070-57453082c25
+                    example: []
+        responses:
+            200:
+              description: Playlist 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 Playlist Name
+                      project_id:
+                        type: string
+                        format: uuid
+                        example: b24a6ea4-ce75-4665-a070-57453082c25
+                      shots:
+                        type: array
+                        items:
+                          type: object
+                        example: []
+                      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 playlist
+        ---
+        tags:
+          - Crud
+        description: Delete a playlist 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: Playlist deleted successfully
+            400:
+              description: Integrity error or cannot delete
+        """
+        playlists_service.remove_playlist(instance_id)
+        return "", 204
+
     def check_update_permissions(self, playlist, data):
         user_service.check_project_access(playlist["project_id"])
         user_service.block_access_to_vendor()
@@ -50,7 +372,3 @@ class PlaylistResource(BaseModelResource):
             ]
             data["shots"] = shots
         return data
-
-    def delete(self, instance_id):
-        playlists_service.remove_playlist(instance_id)
-        return "", 204

zou/app/blueprints/crud/plugin.py

@@ -1,3 +1,5 @@
+from flask_jwt_extended import jwt_required
+
 from zou.app.models.plugin import Plugin
 
 from zou.app.blueprints.crud.base import BaseModelsResource, BaseModelResource
@@ -7,7 +9,274 @@ class PluginsResource(BaseModelsResource):
     def __init__(self):
         BaseModelsResource.__init__(self, Plugin)
 
+    @jwt_required()
+    def get(self):
+        """
+        Get plugins
+        ---
+        tags:
+          - Crud
+        description: Retrieve all plugins. 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: Plugins 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 plugin
+        ---
+        tags:
+          - Crud
+        description: Create a new plugin with data provided in the
+          request body. JSON format is expected.
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - name
+                properties:
+                  name:
+                    type: string
+                    example: Plugin Name
+                  active:
+                    type: boolean
+                    default: false
+                    example: false
+        responses:
+            201:
+              description: Plugin created successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: Plugin Name
+                      active:
+                        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()
+
 
 class PluginResource(BaseModelResource):
     def __init__(self):
         BaseModelResource.__init__(self, Plugin)
+
+    @jwt_required()
+    def get(self, instance_id):
+        """
+        Get plugin
+        ---
+        tags:
+          - Crud
+        description: Retrieve a plugin 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: Plugin retrieved successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        example: Plugin Name
+                      active:
+                        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 plugin
+        ---
+        tags:
+          - Crud
+        description: Update a plugin 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 Plugin Name
+                  active:
+                    type: boolean
+                    example: true
+        responses:
+            200:
+              description: Plugin 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 Plugin Name
+                      active:
+                        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 plugin
+        ---
+        tags:
+          - Crud
+        description: Delete a plugin 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: Plugin deleted successfully
+            400:
+              description: Integrity error or cannot delete
+        """
+        return super().delete(instance_id)