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

zou/app/blueprints/source/otio.py

@@ -41,8 +41,39 @@ mapping_substitutions_to_regex = {
 
 
 class OTIOBaseResource(Resource, ArgsMixin):
+
     @jwt_required()
     def post(self, project_id, episode_id=None):
+        """
+        Import otio base
+        ---
+        description: Base resource for importing OTIO files. This method is
+          overridden by subclasses. Import an OTIO file to set frame_in,
+          frame_out, and nb_frames for shots.
+        tags:
+          - Import
+        consumes:
+          - multipart/form-data
+        parameters:
+          - in: path
+            name: project_id
+            required: true
+            schema:
+              type: string
+              format: uuid
+            description: Project unique identifier
+            example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: formData
+            name: file
+            type: file
+            required: true
+            description: OTIO file to import (EDL, OTIO, etc.)
+        responses:
+          201:
+            description: Shots imported successfully
+          400:
+            description: Invalid file format or parsing error
+        """
         args = self.post_args()
         user_service.check_manager_project_access(project_id)
         uploaded_file = request.files["file"]
@@ -269,33 +300,114 @@ class OTIOBaseResource(Resource, ArgsMixin):
 
 
 class OTIOImportResource(OTIOBaseResource):
+
     @jwt_required()
     def post(self, **kwargs):
         """
-        Import an OTIO file to enter frame_in / frame_out / nb_frames (it can
-        be every adapter supported by OpenTimelineIO, for example: EDL, OTIO...
-        ).
+        Import otio EDL
         ---
         tags:
           - Import
+        description: Import an OTIO file to set frame_in, frame_out, and
+          nb_frames for shots. Supports any OpenTimelineIO adapter format like
+          EDL or OTIO. Uses naming convention to match shots.
         consumes:
           - multipart/form-data
         parameters:
           - in: path
             name: project_id
-            required: True
-            type: string
-            format: uuid
+            required: true
+            schema:
+              type: string
+              format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
+          - in: query
+            name: naming_convention
+            required: false
+            schema:
+              type: string
+            default: "${project_name}_${sequence_name}-${shot_name}"
+            example: "${project_name}_${sequence_name}-${shot_name}"
+            description: Template for matching shot names from the file
+          - in: query
+            name: match_case
+            required: false
+            schema:
+              type: boolean
+            default: true
+            example: true
+            description: Whether to match shot names case-sensitively
           - in: formData
             name: file
             type: file
             required: true
+            description: OTIO file to import (EDL, OTIO, etc.)
         responses:
             201:
-                description: .
+              description: Shots imported successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      updated_shots:
+                        type: array
+                        items:
+                          type: object
+                          properties:
+                            id:
+                              type: string
+                              format: uuid
+                              example: a24a6ea4-ce75-4665-a070-57453082c25
+                            name:
+                              type: string
+                              example: SH010
+                            project_id:
+                              type: string
+                              format: uuid
+                              example: b24a6ea4-ce75-4665-a070-57453082c25
+                            nb_frames:
+                              type: integer
+                              example: 120
+                            data:
+                              type: object
+                              properties:
+                                frame_in:
+                                  type: integer
+                                  example: 1001
+                                frame_out:
+                                  type: integer
+                                  example: 1120
+                      created_shots:
+                        type: array
+                        items:
+                          type: object
+                          properties:
+                            id:
+                              type: string
+                              format: uuid
+                              example: c24a6ea4-ce75-4665-a070-57453082c25
+                            name:
+                              type: string
+                              example: SH020
+                            project_id:
+                              type: string
+                              format: uuid
+                              example: b24a6ea4-ce75-4665-a070-57453082c25
+                            nb_frames:
+                              type: integer
+                              example: 96
+                            data:
+                              type: object
+                              properties:
+                                frame_in:
+                                  type: integer
+                                  example: 2001
+                                frame_out:
+                                  type: integer
+                                  example: 2096
             400:
-                description: The .otio file is not properly formatted.
+              description: Invalid file format or parsing error
         """
         return super().post(**kwargs)
 
@@ -314,39 +426,122 @@ class OTIOImportResource(OTIOBaseResource):
 
 
 class OTIOImportEpisodeResource(OTIOBaseResource):
+
     @jwt_required()
     def post(self, **kwargs):
         """
-        Import an OTIO file to enter frame_in / frame_out / nb_frames (it can
-        be every adapter supported by OpenTimelineIO, for example: edl, otio...
-        ).
+        Import episode otio
         ---
         tags:
           - Import
+        description: Import an OTIO file to set frame_in, frame_out, and
+          nb_frames for shots in an episode. Supports any OpenTimelineIO
+          adapter format like EDL or OTIO. Uses naming convention with episode
+          name to match shots.
         consumes:
           - multipart/form-data
         parameters:
           - in: path
             name: project_id
-            required: True
-            type: string
-            format: uuid
+            required: true
+            schema:
+              type: string
+              format: uuid
             example: a24a6ea4-ce75-4665-a070-57453082c25
           - in: path
             name: episode_id
-            required: True
-            type: string
-            format: uuid
-            example: a24a6ea4-ce75-4665-a070-57453082c25
+            required: true
+            schema:
+              type: string
+              format: uuid
+            example: b24a6ea4-ce75-4665-a070-57453082c25
+          - in: query
+            name: naming_convention
+            required: false
+            schema:
+              type: string
+            default: "${project_name}_${episode_name}-${sequence_name}-${shot_name}"
+            example: "${project_name}_${episode_name}-${sequence_name}-${shot_name}"
+            description: Template for matching shot names from the file
+          - in: query
+            name: match_case
+            required: false
+            schema:
+              type: boolean
+            default: true
+            example: true
+            description: Whether to match shot names case-sensitively
           - in: formData
             name: file
             type: file
             required: true
+            description: OTIO file to import (EDL, OTIO, etc.)
         responses:
             201:
-                description: .
+              description: Shots imported successfully
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      updated_shots:
+                        type: array
+                        items:
+                          type: object
+                          properties:
+                            id:
+                              type: string
+                              format: uuid
+                              example: a24a6ea4-ce75-4665-a070-57453082c25
+                            name:
+                              type: string
+                              example: SH010
+                            project_id:
+                              type: string
+                              format: uuid
+                              example: c24a6ea4-ce75-4665-a070-57453082c25
+                            nb_frames:
+                              type: integer
+                              example: 120
+                            data:
+                              type: object
+                              properties:
+                                frame_in:
+                                  type: integer
+                                  example: 1001
+                                frame_out:
+                                  type: integer
+                                  example: 1120
+                      created_shots:
+                        type: array
+                        items:
+                          type: object
+                          properties:
+                            id:
+                              type: string
+                              format: uuid
+                              example: d24a6ea4-ce75-4665-a070-57453082c25
+                            name:
+                              type: string
+                              example: SH020
+                            project_id:
+                              type: string
+                              format: uuid
+                              example: c24a6ea4-ce75-4665-a070-57453082c25
+                            nb_frames:
+                              type: integer
+                              example: 96
+                            data:
+                              type: object
+                              properties:
+                                frame_in:
+                                  type: integer
+                                  example: 2001
+                                frame_out:
+                                  type: integer
+                                  example: 2096
             400:
-                description: The .otio file is not properly formatted.
+              description: Invalid file format or parsing error
         """
         return super().post(**kwargs)
 

zou/app/blueprints/source/shotgun/assets.py

@@ -1,4 +1,5 @@
 from flask import current_app
+from flask_jwt_extended import jwt_required
 
 from sqlalchemy.exc import IntegrityError
 
@@ -26,6 +27,104 @@ class ImportShotgunAssetsResource(BaseImportShotgunResource):
     def __init__(self):
         BaseImportShotgunResource.__init__(self)
 
+    @jwt_required()
+    def post(self):
+        """
+        Import shotgun assets
+        ---
+        description: Import Shotgun assets. Send a list of Shotgun asset
+          entries in the JSON body. Returns created or updated assets with
+          parent-child relationships.
+        tags:
+          - Import
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    id:
+                      type: integer
+                      description: Shotgun ID of the asset
+                      example: 12345
+                    code:
+                      type: string
+                      description: Asset code
+                      example: "Asset01"
+                    description:
+                      type: string
+                      description: Asset description
+                      example: "Main character asset"
+                    sg_asset_type:
+                      type: string
+                      description: Asset type name
+                      example: "Character"
+                    project:
+                      type: object
+                      description: Project information
+                      properties:
+                        id:
+                          type: integer
+                          example: 11111
+                    parents:
+                      type: array
+                      description: Parent assets
+                      items:
+                        type: object
+                        properties:
+                          id:
+                            type: integer
+                            example: 22222
+              example:
+                - id: 12345
+                  code: "Asset01"
+                  description: "Main character asset"
+                  sg_asset_type: "Character"
+                  project:
+                    id: 11111
+                  parents:
+                    - id: 22222
+        responses:
+          200:
+            description: Assets imported successfully
+            content:
+              application/json:
+                schema:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      id:
+                        type: string
+                        format: uuid
+                        description: Asset unique identifier
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                      name:
+                        type: string
+                        description: Asset name
+                        example: "Asset01"
+                      description:
+                        type: string
+                        description: Asset description
+                        example: "Main character asset"
+                      created_at:
+                        type: string
+                        format: date-time
+                        description: Creation timestamp
+                        example: "2024-01-15T10:30:00Z"
+                      updated_at:
+                        type: string
+                        format: date-time
+                        description: Update timestamp
+                        example: "2024-01-15T11:00:00Z"
+          400:
+            description: Invalid request body or data format error
+        """
+        return super().post()
+
     def prepare_import(self):
         entity_type_names = self.extract_entity_type_names(self.sg_entries)
         assets_service.create_asset_types(entity_type_names)
@@ -120,6 +219,53 @@ class ImportRemoveShotgunAssetResource(ImportRemoveShotgunBaseResource):
             self, Entity, self.delete_func
         )
 
+    @jwt_required()
+    def post(self):
+        """
+        Remove shotgun asset
+        ---
+        description: Remove a Shotgun asset from the database. Provide the
+          Shotgun entry ID in the JSON body. If the asset has working files
+          linked to tasks, it will be cancelled instead of deleted.
+        tags:
+          - Import
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - id
+                properties:
+                  id:
+                    type: integer
+                    description: Shotgun ID of the asset to remove
+                    example: 12345
+              example:
+                id: 12345
+        responses:
+          200:
+            description: Removal result returned
+            content:
+              application/json:
+                schema:
+                  type: object
+                  properties:
+                    success:
+                      type: boolean
+                      description: Whether the removal was successful
+                      example: true
+                    removed_instance_id:
+                      type: string
+                      format: uuid
+                      description: ID of the removed asset, if found
+                      example: a24a6ea4-ce75-4665-a070-57453082c25
+          400:
+            description: Invalid request body or instance not found
+        """
+        return super().post()
+
     def delete_func(self, asset):
         try:
             asset = assets_service.get_asset_by_shotgun_id(asset.shotgun_id)

zou/app/blueprints/source/shotgun/base.py

@@ -28,24 +28,62 @@ class BaseImportShotgunResource(Resource):
     @jwt_required()
     def post(self):
         """
-        Import shotgun resource.
+        Import shotgun resource
         ---
         tags:
           - Import
-        parameters:
-          - in: body
-            name: sg_entries
-            required: True
-            schema:
+        description: Import Shotgun resources. Send a list of Shotgun entries
+          in the JSON body. Returns created or updated resources.
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
                 type: array
                 items:
-                    type: object
-                    properties:
-                        id:
-                            type: string
+                  type: object
+                  properties:
+                    id:
+                      type: integer
+                      example: 12345
+                      description: Shotgun ID of the entry
+                    code:
+                      type: string
+                      example: SH010
+                    name:
+                      type: string
+                      example: Shot name
+              example:
+                - id: 12345
+                  code: SH010
+                  name: Shot name
         responses:
             200:
-                description: Resource imported
+              description: Resources imported 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: Imported resource
+                        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 request body or data format error
         """
         results = []
         self.sg_entries = request.json
@@ -169,13 +207,46 @@ class ImportRemoveShotgunBaseResource(Resource):
     @jwt_required()
     def post(self):
         """
-        Import remove instance.
+        Remove shotgun resource
         ---
         tags:
           - Import
+        description: Remove a Shotgun resource from the database. Provide the
+          Shotgun entry ID in the JSON body.
+        requestBody:
+          required: true
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - id
+                properties:
+                  id:
+                    type: integer
+                    example: 12345
+                    description: Shotgun ID of the entry to remove
+              example:
+                id: 12345
         responses:
-            204:
-                description: Instance removed
+            200:
+              description: Removal result returned
+              content:
+                application/json:
+                  schema:
+                    type: object
+                    properties:
+                      success:
+                        type: boolean
+                        example: true
+                        description: Whether the removal was successful
+                      removed_instance_id:
+                        type: string
+                        format: uuid
+                        example: a24a6ea4-ce75-4665-a070-57453082c25
+                        description: ID of the removed instance, if found
+            400:
+              description: Invalid request body or instance not found
         """
         sg_model = request.json
         instance = self.get_instance(sg_model)