@shotstack/schemas 1.4.4 → 1.4.6

package/dist/api.bundled.json

@@ -939,6 +939,7 @@
           "tracks": {
             "description": "A timeline consists of an array of tracks, each track containing clips. Tracks are layered on top of each other in the same order they are added to the array with the top most track layered over the top of those below it. Ensure that a track containing titles is the top most track so that it is displayed above videos and images.",
             "type": "array",
+            "minItems": 1,
             "items": {
               "$ref": "#/components/schemas/Track"
             }
@@ -959,6 +960,8 @@
           "src": {
             "description": "The URL of the mp3 audio file. The URL must be publicly accessible or include credentials.",
             "type": "string",
+            "minLength": 1,
+            "pattern": "\\S",
             "example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/music.mp3"
           },
           "effect": {
@@ -1000,6 +1003,7 @@
           "clips": {
             "description": "An array of Clips comprising of TitleClip, ImageClip or VideoClip.",
             "type": "array",
+            "minItems": 1,
             "items": {
               "$ref": "#/components/schemas/Clip"
             }
@@ -1022,6 +1026,7 @@
               {
                 "type": "number",
                 "description": "The start position of the Clip on the timeline, in seconds. For example, to start the Clip at 2 seconds, set the start value to 2.",
+                "minimum": 0,
                 "example": 2
               },
               {
@@ -1038,6 +1043,7 @@
               {
                 "type": "number",
                 "description": "The duration the Clip should play for, in seconds. For example, to play the Clip for 5 seconds, set the length value to 5.",
+                "minimum": 0,
                 "example": 5
               },
               {
@@ -1078,14 +1084,16 @@
           },
           "width": {
             "description": "Set the width of the clip bounding box in pixels. This constrains the width of the clip, overriding the default behavior where clips fill the viewport width.",
-            "type": "integer",
+            "type": "number",
+            "format": "float",
             "minimum": 1,
             "maximum": 3840,
             "example": 800
           },
           "height": {
             "description": "Set the height of the clip bounding box in pixels. This constrains the height of the clip, overriding the default behavior where clips fill the viewport height.",
-            "type": "integer",
+            "type": "number",
+            "format": "float",
             "minimum": 1,
             "maximum": 2160,
             "example": 600
@@ -1266,6 +1274,8 @@
           "src": {
             "description": "The video source URL. The URL must be publicly accessible or include credentials.",
             "type": "string",
+            "minLength": 1,
+            "pattern": "\\S",
             "example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/video.mp4"
           },
           "transcode": {
@@ -1343,6 +1353,8 @@
           "src": {
             "description": "The image source URL. The URL must be publicly accessible or include credentials.",
             "type": "string",
+            "minLength": 1,
+            "pattern": "\\S",
             "example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/image.jpg"
           },
           "crop": {
@@ -1369,6 +1381,8 @@
           "text": {
             "description": "The text string to display.",
             "type": "string",
+            "minLength": 1,
+            "pattern": "\\S",
             "example": "Hello World"
           },
           "width": {
@@ -1462,8 +1476,10 @@
           "text": {
             "description": "The text string to display. Maximum 5000 characters.",
             "type": "string",
-            "example": "Hello World",
-            "maxLength": 5000
+            "minLength": 1,
+            "maxLength": 5000,
+            "pattern": "\\S",
+            "example": "Hello World"
           },
           "font": {
             "description": "Font styling properties.",
@@ -1590,6 +1606,8 @@
           "src": {
             "description": "The audio source URL. The URL must be publicly accessible or include credentials.",
             "type": "string",
+            "minLength": 1,
+            "pattern": "\\S",
             "example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/sound.mp3"
           },
           "trim": {
@@ -1783,6 +1801,8 @@
           "src": {
             "description": "The luma matte source URL. The URL must be publicly accessible or include credentials.",
             "type": "string",
+            "minLength": 1,
+            "pattern": "\\S",
             "example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/mask.mp4"
           },
           "trim": {
@@ -1810,6 +1830,8 @@
           "src": {
             "description": "The URL to an SRT or VTT subtitles file, or an alias reference to auto-generate captions from an audio or video clip. For file URLs, the URL must be publicly accessible or include credentials. For auto-captioning, use the format `alias://clip-name` where clip-name is the alias of an audio, video, or text-to-speech clip. The system will automatically transcribe the audio and detect the language.",
             "type": "string",
+            "minLength": 1,
+            "pattern": "\\S",
             "example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/captions.srt"
           },
           "font": {
@@ -1892,6 +1914,7 @@
           "src": {
             "description": "The image source URL. The URL must be publicly accessible or include credentials.",
             "type": "string",
+            "minLength": 1,
             "example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/image.jpg"
           },
           "prompt": {
@@ -1924,7 +1947,12 @@
           "crop": {
             "$ref": "#/components/schemas/Crop"
           }
-        }
+        },
+        "type": "object",
+        "required": [
+          "type",
+          "src"
+        ]
       },
       "HtmlAsset": {
         "deprecated": true,
@@ -1942,6 +1970,8 @@
           "html": {
             "description": "The HTML text string. See list of [supported HTML tags](https://shotstack.io/docs/guide/architecting-an-application/html-support/#supported-html-tags).",
             "type": "string",
+            "minLength": 1,
+            "pattern": "\\S",
             "example": "<p>Hello <b>World</b></p>"
           },
           "css": {
@@ -3613,16 +3643,8 @@
             ],
             "example": "shift"
           },
-          "speed": {
-            "description": "Animation speed multiplier. Must be between 0.1 and 10. Higher is faster.",
-            "type": "number",
-            "minimum": 0.1,
-            "maximum": 10,
-            "default": 1,
-            "example": 1.5
-          },
           "duration": {
-            "description": "Override animation duration in seconds. If not specified, calculated based on text length and speed. Must be between 0.1 and 30 seconds.",
+            "description": "Override animation duration in seconds. Must be between 0.1 and 30 seconds.",
             "type": "number",
             "minimum": 0.1,
             "maximum": 30,

package/dist/schema.d.ts

@@ -515,11 +515,13 @@ export interface components {
             /** @description Scale the asset to a fraction of the viewport size - i.e. setting the scale to 0.5 will scale asset to half the size of the viewport. This is useful for picture-in-picture video and scaling images such as logos and watermarks. Use a number or an array of [Tween](./#tocs_tween) objects to create a custom animation. */
             scale?: number | components["schemas"]["Tween"][];
             /**
+             * Format: float
              * @description Set the width of the clip bounding box in pixels. This constrains the width of the clip, overriding the default behavior where clips fill the viewport width.
              * @example 800
              */
             width?: number;
             /**
+             * Format: float
              * @description Set the height of the clip bounding box in pixels. This constrains the height of the clip, overriding the default behavior where clips fill the viewport height.
              * @example 600
              */
@@ -992,8 +994,7 @@ export interface components {
         /** @description The ImageToVideoAsset lets you create a video from an image and a text prompt. */
         ImageToVideoAsset: {
             /**
-             * @description The type of asset to generate - set to `image-to-video` for image-to-video.
-             * @default image-to-video
+             * @description The type of asset to generate - set to `image-to-video` for image-to-video. (enum property replaced by openapi-typescript)
              * @enum {string}
              */
             type: "image-to-video";
@@ -1001,7 +1002,7 @@ export interface components {
              * @description The image source URL. The URL must be publicly accessible or include credentials.
              * @example https://s3-ap-northeast-1.amazonaws.com/my-bucket/image.jpg
              */
-            src?: string;
+            src: string;
             /**
              * @description The instructions for modifying the image into a video sequence.
              * @example Slowly zoom out and orbit left around the object.
@@ -2237,13 +2238,7 @@ export interface components {
              */
             preset: "fadeIn" | "slideIn" | "typewriter" | "ascend" | "shift" | "movingLetters";
             /**
-             * @description Animation speed multiplier. Must be between 0.1 and 10. Higher is faster.
-             * @default 1
-             * @example 1.5
-             */
-            speed: number;
-            /**
-             * @description Override animation duration in seconds. If not specified, calculated based on text length and speed. Must be between 0.1 and 30 seconds.
+             * @description Override animation duration in seconds. Must be between 0.1 and 30 seconds.
              * @example 2
              */
             duration?: number;