@shotstack/schemas 1.20.2 → 1.20.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -75,7 +75,7 @@
75
75
  }
76
76
  }
77
77
  },
78
- "description": "Queue and render the contents of an [Edit](#tocs_edit) as a video, image or audio file.\n\n**Rendering Process:**\n1. **Validation**: The edit JSON is validated\n2. **Download**: All assets are downloaded and cached \n3. **Preprocessing**: Video assets are automatically processed to fix compatibility issues\n4. **Rendering**: The timeline is rendered using the processed assets\n5. **Output**: The final media file is generated and stored\n\n**Video Preprocessing:**\nVideo assets undergo automatic preprocessing to ensure compatibility. You can force \npreprocessing by setting `\"transcode\": true` on video assets. See [Preprocessing](#preprocessing) \nfor more details.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>\n",
78
+ "description": "Queue and render the contents of an [Edit](#tocs_edit) as a video, image or audio file.\n\n**Rendering Process:**\n1. **Validation**: The edit JSON is validated\n2. **Download**: All assets are downloaded and cached \n3. **Preprocessing**: Video assets are automatically processed to fix compatibility issues\n4. **Rendering**: The timeline is rendered using the processed assets\n5. **Output**: The final media file is generated and stored\n\n**Video Preprocessing:**\nVideo assets undergo automatic preprocessing to ensure compatibility. You can force \npreprocessing by setting `\"transcode\": true` on video assets. See [VideoAsset](#tocs_videoasset) \nfor more details.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>\n",
79
79
  "summary": "Render Asset",
80
80
  "operationId": "postRender",
81
81
  "requestBody": {
@@ -1095,7 +1095,7 @@
1095
1095
  }
1096
1096
  }
1097
1097
  },
1098
- "description": "A render may generate more than one file, such as a video, thumbnail and poster image. When the assets are\ncreated the only known id is the render id returned by the original [render request](#render-video), status \nrequest or webhook. This endpoint lets you look up one or more assets by the render id.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/serve/{version}</a>\n",
1098
+ "description": "A render may generate more than one file, such as a video, thumbnail and poster image. When the assets are\ncreated the only known id is the render id returned by the original [render request](#render-asset), status \nrequest or webhook. This endpoint lets you look up one or more assets by the render id.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/serve/{version}</a>\n",
1099
1099
  "operationId": "getAssetByRenderId",
1100
1100
  "summary": "Get Asset by Render ID",
1101
1101
  "security": [
@@ -1314,7 +1314,7 @@
1314
1314
  }
1315
1315
  }
1316
1316
  },
1317
- "description": "Request a signed URL to upload a file to. The response returns a signed URL that you use to upload the file to.\nThe signed URL looks similar to:\n\nhttps://shotstack-ingest-api-stage-sources.s3.ap-southeast-2.amazonaws.com/5ca6hu7s9k/zzytey4v-32km-kq1z-aftr-3kcuqi0brad2/source?AWSAccessKeyId=ASIAWJV7UWDMGTZLHTXP&Expires=1677209777&Signature=PKR4dGDDdOuMTAQmDASzLGmLOeo%3D&x-amz-acl=public-read&x-amz-security-token=IQoJb3JpZ2luX2VjEGMaDmFwLX......56osBGByztm7WZdbmXzO09KR\n\nIn a separate API call, use this signed URL to send a PUT request with the binary file. Using cURL you can use\na command like:\n \n`curl -X PUT -T video.mp4 {data.attributes.url}`\n \nWhere **video.mp4** is the file you want to upload and **{data.attributes.url}** is the signed URL returned in\nthe response. The request must be a PUT type.\n\nThe SDK does not currently support the PUT request. You can use the SDK to make the request for the signed URL\nand then use cURL to make the PUT request.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/ingest/{version}</a>\n",
1317
+ "description": "Request a signed URL to upload a file to. The response returns a signed URL that you use to upload the file to.\nThe signed URL looks similar to:\n\n`https://shotstack-ingest-api-stage-sources.s3.ap-southeast-2.amazonaws.com/5ca6hu7s9k/zzytey4v-32km-kq1z-aftr-3kcuqi0brad2/source?AWSAccessKeyId=ASIAWJV7UWDMGTZLHTXP&Expires=1677209777&Signature=PKR4dGDDdOuMTAQmDASzLGmLOeo%3D&x-amz-acl=public-read&x-amz-security-token=IQoJb3JpZ2luX2VjEGMaDmFwLX......56osBGByztm7WZdbmXzO09KR`\n\nIn a separate API call, use this signed URL to send a PUT request with the binary file. Using cURL you can use\na command like:\n \n`curl -X PUT -T video.mp4 {data.attributes.url}`\n \nWhere **video.mp4** is the file you want to upload and **{data.attributes.url}** is the signed URL returned in\nthe response. The request must be a PUT type.\n\nThe SDK does not currently support the PUT request. You can use the SDK to make the request for the signed URL\nand then use cURL to make the PUT request.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/ingest/{version}</a>\n",
1318
1318
  "summary": "Direct Upload",
1319
1319
  "operationId": "getUploadSignedUrl",
1320
1320
  "security": [
@@ -1352,7 +1352,7 @@
1352
1352
  "example": "https://my-server.com/callback.php"
1353
1353
  },
1354
1354
  "disk": {
1355
- "description": "**Notice: This option is now deprecated and will be removed. Disk types are handled automatically. Setting a disk type has no effect.**\n\nThe disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types/) for more details.\n<ul>\n <li>`local` - optimized for high speed rendering with up to 512MB storage</li>\n <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li>\n</ul>\n",
1355
+ "description": "**Notice: This option is now deprecated and will be removed. Disk types are handled automatically. Setting a disk type has no effect.**\n\nThe disk type to use for storing footage and assets for each render.\n<ul>\n <li>`local` - optimized for high speed rendering with up to 512MB storage</li>\n <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li>\n</ul>\n",
1356
1356
  "type": "string",
1357
1357
  "enum": [
1358
1358
  "local",
@@ -2040,39 +2040,7 @@
2040
2040
  },
2041
2041
  "border": {
2042
2042
  "description": "Border styling properties for the text bounding box.",
2043
- "properties": {
2044
- "width": {
2045
- "description": "The width of the border in pixels. Must be 0 or greater.",
2046
- "type": "number",
2047
- "minimum": 0,
2048
- "default": 0,
2049
- "example": 2
2050
- },
2051
- "color": {
2052
- "description": "The border color using hexadecimal color notation.",
2053
- "type": "string",
2054
- "pattern": "^#[A-Fa-f0-9]{6}$",
2055
- "default": "#000000",
2056
- "example": "#ff0000"
2057
- },
2058
- "opacity": {
2059
- "description": "The opacity of the border where 1 is opaque and 0 is transparent.",
2060
- "type": "number",
2061
- "minimum": 0,
2062
- "maximum": 1,
2063
- "default": 1,
2064
- "example": 0.8
2065
- },
2066
- "radius": {
2067
- "description": "The border radius in pixels for rounded corners. Must be 0 or greater.",
2068
- "type": "number",
2069
- "minimum": 0,
2070
- "default": 0,
2071
- "example": 10
2072
- }
2073
- },
2074
- "additionalProperties": false,
2075
- "type": "object"
2043
+ "$ref": "#/components/schemas/RichTextBorder"
2076
2044
  },
2077
2045
  "padding": {
2078
2046
  "description": "Padding inside the text bounding box. Can be a single number (applied to all sides) or an object with individual sides.",
@@ -2084,39 +2052,7 @@
2084
2052
  "example": 10
2085
2053
  },
2086
2054
  {
2087
- "description": "Padding properties for individual sides of the text bounding box.",
2088
- "properties": {
2089
- "top": {
2090
- "description": "Top padding in pixels.",
2091
- "type": "number",
2092
- "minimum": 0,
2093
- "default": 0,
2094
- "example": 10
2095
- },
2096
- "right": {
2097
- "description": "Right padding in pixels.",
2098
- "type": "number",
2099
- "minimum": 0,
2100
- "default": 0,
2101
- "example": 10
2102
- },
2103
- "bottom": {
2104
- "description": "Bottom padding in pixels.",
2105
- "type": "number",
2106
- "minimum": 0,
2107
- "default": 0,
2108
- "example": 10
2109
- },
2110
- "left": {
2111
- "description": "Left padding in pixels.",
2112
- "type": "number",
2113
- "minimum": 0,
2114
- "default": 0,
2115
- "example": 10
2116
- }
2117
- },
2118
- "additionalProperties": false,
2119
- "type": "object"
2055
+ "$ref": "#/components/schemas/RichTextPadding"
2120
2056
  }
2121
2057
  ]
2122
2058
  },
@@ -2581,7 +2517,7 @@
2581
2517
  },
2582
2518
  "border": {
2583
2519
  "description": "Border styling properties for the caption bounding box.",
2584
- "$ref": "#/components/schemas/RichTextAsset/properties/border"
2520
+ "$ref": "#/components/schemas/RichTextBorder"
2585
2521
  },
2586
2522
  "padding": {
2587
2523
  "description": "Padding inside the caption bounding box. Can be a single number (applied to all sides) or an object with individual sides.",
@@ -2593,7 +2529,7 @@
2593
2529
  "example": 10
2594
2530
  },
2595
2531
  {
2596
- "$ref": "#/components/schemas/RichTextAsset/properties/padding/oneOf/1"
2532
+ "$ref": "#/components/schemas/RichTextPadding"
2597
2533
  }
2598
2534
  ]
2599
2535
  },
@@ -3930,6 +3866,77 @@
3930
3866
  "additionalProperties": false,
3931
3867
  "type": "object"
3932
3868
  },
3869
+ "RichTextBorder": {
3870
+ "description": "Border styling properties for the text bounding box.",
3871
+ "properties": {
3872
+ "width": {
3873
+ "description": "The width of the border in pixels. Must be 0 or greater.",
3874
+ "type": "number",
3875
+ "minimum": 0,
3876
+ "default": 0,
3877
+ "example": 2
3878
+ },
3879
+ "color": {
3880
+ "description": "The border color using hexadecimal color notation.",
3881
+ "type": "string",
3882
+ "pattern": "^#[A-Fa-f0-9]{6}$",
3883
+ "default": "#000000",
3884
+ "example": "#ff0000"
3885
+ },
3886
+ "opacity": {
3887
+ "description": "The opacity of the border where 1 is opaque and 0 is transparent.",
3888
+ "type": "number",
3889
+ "minimum": 0,
3890
+ "maximum": 1,
3891
+ "default": 1,
3892
+ "example": 0.8
3893
+ },
3894
+ "radius": {
3895
+ "description": "The border radius in pixels for rounded corners. Must be 0 or greater.",
3896
+ "type": "number",
3897
+ "minimum": 0,
3898
+ "default": 0,
3899
+ "example": 10
3900
+ }
3901
+ },
3902
+ "additionalProperties": false,
3903
+ "type": "object"
3904
+ },
3905
+ "RichTextPadding": {
3906
+ "description": "Padding properties for individual sides of the text bounding box.",
3907
+ "properties": {
3908
+ "top": {
3909
+ "description": "Top padding in pixels.",
3910
+ "type": "number",
3911
+ "minimum": 0,
3912
+ "default": 0,
3913
+ "example": 10
3914
+ },
3915
+ "right": {
3916
+ "description": "Right padding in pixels.",
3917
+ "type": "number",
3918
+ "minimum": 0,
3919
+ "default": 0,
3920
+ "example": 10
3921
+ },
3922
+ "bottom": {
3923
+ "description": "Bottom padding in pixels.",
3924
+ "type": "number",
3925
+ "minimum": 0,
3926
+ "default": 0,
3927
+ "example": 10
3928
+ },
3929
+ "left": {
3930
+ "description": "Left padding in pixels.",
3931
+ "type": "number",
3932
+ "minimum": 0,
3933
+ "default": 0,
3934
+ "example": 10
3935
+ }
3936
+ },
3937
+ "additionalProperties": false,
3938
+ "type": "object"
3939
+ },
3933
3940
  "CaptionFont": {
3934
3941
  "description": "Font properties for captions text.",
3935
3942
  "properties": {
@@ -4418,7 +4425,7 @@
4418
4425
  ]
4419
4426
  },
4420
4427
  {
4421
- "description": "Send videos and assets to [Akamai NetStorage](https://techdocs.akamai.com/netstorage-usage/docs). Send files to your NetStorage upload directory with a custom path and filename. Akamai credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/akamai-netstorage), not in the request.",
4428
+ "description": "Send videos and assets to [Akamai NetStorage](https://techdocs.akamai.com/netstorage/docs). Send files to your NetStorage upload directory with a custom path and filename. Akamai credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/akamai-netstorage), not in the request.",
4422
4429
  "properties": {
4423
4430
  "provider": {
4424
4431
  "description": "The destination to send assets to - set to `akamai-netstorage` for Akamai NetStorage.",
@@ -4533,7 +4540,7 @@
4533
4540
  ]
4534
4541
  },
4535
4542
  "MuxDestination": {
4536
- "description": "Send videos to the [Mux](https://shotstack.io/docs/guide/serving-assets/destinations/mux/) video hosting and streaming service. Mux credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/mux), not in the request.",
4543
+ "description": "Send videos to the [Mux](https://www.mux.com/docs) video hosting and streaming service. Mux credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/mux), not in the request.",
4537
4544
  "properties": {
4538
4545
  "provider": {
4539
4546
  "description": "The destination to send video to - set to `mux` for Mux.",
@@ -24,7 +24,7 @@
24
24
  ]
25
25
  },
26
26
  "disk": {
27
- "description": "**Notice: This option is now deprecated and will be removed. Disk types are handled automatically. Setting a disk type has no effect.**\n\nThe disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types/) for more details.\n\n- `local` - optimized for high speed rendering with up to 512MB storage\n\n- `mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render",
27
+ "description": "**Notice: This option is now deprecated and will be removed. Disk types are handled automatically. Setting a disk type has no effect.**\n\nThe disk type to use for storing footage and assets for each render.\n\n- `local` - optimized for high speed rendering with up to 512MB storage\n\n- `mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render",
28
28
  "type": "string",
29
29
  "enum": [
30
30
  "local",
@@ -732,7 +732,7 @@
732
732
  ]
733
733
  },
734
734
  {
735
- "description": "Send videos and assets to [Akamai NetStorage](https://techdocs.akamai.com/netstorage-usage/docs). Send files to your NetStorage upload directory with a custom path and filename. Akamai credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/akamai-netstorage), not in the request.",
735
+ "description": "Send videos and assets to [Akamai NetStorage](https://techdocs.akamai.com/netstorage/docs). Send files to your NetStorage upload directory with a custom path and filename. Akamai credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/akamai-netstorage), not in the request.",
736
736
  "properties": {
737
737
  "provider": {
738
738
  "description": "The destination to send assets to - set to `akamai-netstorage` for Akamai NetStorage.",
@@ -1271,7 +1271,7 @@
1271
1271
  ]
1272
1272
  },
1273
1273
  "MuxDestination": {
1274
- "description": "Send videos to the [Mux](https://shotstack.io/docs/guide/serving-assets/destinations/mux/) video hosting and streaming service. Mux credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/mux), not in the request.",
1274
+ "description": "Send videos to the [Mux](https://www.mux.com/docs) video hosting and streaming service. Mux credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/mux), not in the request.",
1275
1275
  "properties": {
1276
1276
  "provider": {
1277
1277
  "description": "The destination to send video to - set to `mux` for Mux.",
@@ -1851,7 +1851,7 @@
1851
1851
  },
1852
1852
  "border": {
1853
1853
  "description": "Border styling properties for the caption bounding box.",
1854
- "$ref": "#/$defs/RichTextAsset/properties/border"
1854
+ "$ref": "#/$defs/RichTextBorder"
1855
1855
  },
1856
1856
  "padding": {
1857
1857
  "description": "Padding inside the caption bounding box. Can be a single number (applied to all sides) or an object with individual sides.",
@@ -1865,7 +1865,7 @@
1865
1865
  ]
1866
1866
  },
1867
1867
  {
1868
- "$ref": "#/$defs/RichTextAsset/properties/padding/oneOf/1"
1868
+ "$ref": "#/$defs/RichTextPadding"
1869
1869
  }
1870
1870
  ]
1871
1871
  },
@@ -2021,47 +2021,7 @@
2021
2021
  },
2022
2022
  "border": {
2023
2023
  "description": "Border styling properties for the text bounding box.",
2024
- "properties": {
2025
- "width": {
2026
- "description": "The width of the border in pixels. Must be 0 or greater.",
2027
- "type": "number",
2028
- "minimum": 0,
2029
- "default": 0,
2030
- "examples": [
2031
- 2
2032
- ]
2033
- },
2034
- "color": {
2035
- "description": "The border color using hexadecimal color notation.",
2036
- "type": "string",
2037
- "pattern": "^#[A-Fa-f0-9]{6}$",
2038
- "default": "#000000",
2039
- "examples": [
2040
- "#ff0000"
2041
- ]
2042
- },
2043
- "opacity": {
2044
- "description": "The opacity of the border where 1 is opaque and 0 is transparent.",
2045
- "type": "number",
2046
- "minimum": 0,
2047
- "maximum": 1,
2048
- "default": 1,
2049
- "examples": [
2050
- 0.8
2051
- ]
2052
- },
2053
- "radius": {
2054
- "description": "The border radius in pixels for rounded corners. Must be 0 or greater.",
2055
- "type": "number",
2056
- "minimum": 0,
2057
- "default": 0,
2058
- "examples": [
2059
- 10
2060
- ]
2061
- }
2062
- },
2063
- "additionalProperties": false,
2064
- "type": "object"
2024
+ "$ref": "#/$defs/RichTextBorder"
2065
2025
  },
2066
2026
  "padding": {
2067
2027
  "description": "Padding inside the text bounding box. Can be a single number (applied to all sides) or an object with individual sides.",
@@ -2075,47 +2035,7 @@
2075
2035
  ]
2076
2036
  },
2077
2037
  {
2078
- "description": "Padding properties for individual sides of the text bounding box.",
2079
- "properties": {
2080
- "top": {
2081
- "description": "Top padding in pixels.",
2082
- "type": "number",
2083
- "minimum": 0,
2084
- "default": 0,
2085
- "examples": [
2086
- 10
2087
- ]
2088
- },
2089
- "right": {
2090
- "description": "Right padding in pixels.",
2091
- "type": "number",
2092
- "minimum": 0,
2093
- "default": 0,
2094
- "examples": [
2095
- 10
2096
- ]
2097
- },
2098
- "bottom": {
2099
- "description": "Bottom padding in pixels.",
2100
- "type": "number",
2101
- "minimum": 0,
2102
- "default": 0,
2103
- "examples": [
2104
- 10
2105
- ]
2106
- },
2107
- "left": {
2108
- "description": "Left padding in pixels.",
2109
- "type": "number",
2110
- "minimum": 0,
2111
- "default": 0,
2112
- "examples": [
2113
- 10
2114
- ]
2115
- }
2116
- },
2117
- "additionalProperties": false,
2118
- "type": "object"
2038
+ "$ref": "#/$defs/RichTextPadding"
2119
2039
  }
2120
2040
  ]
2121
2041
  },
@@ -2185,6 +2105,50 @@
2185
2105
  "additionalProperties": false,
2186
2106
  "type": "object"
2187
2107
  },
2108
+ "RichTextBorder": {
2109
+ "description": "Border styling properties for the text bounding box.",
2110
+ "properties": {
2111
+ "width": {
2112
+ "description": "The width of the border in pixels. Must be 0 or greater.",
2113
+ "type": "number",
2114
+ "minimum": 0,
2115
+ "default": 0,
2116
+ "examples": [
2117
+ 2
2118
+ ]
2119
+ },
2120
+ "color": {
2121
+ "description": "The border color using hexadecimal color notation.",
2122
+ "type": "string",
2123
+ "pattern": "^#[A-Fa-f0-9]{6}$",
2124
+ "default": "#000000",
2125
+ "examples": [
2126
+ "#ff0000"
2127
+ ]
2128
+ },
2129
+ "opacity": {
2130
+ "description": "The opacity of the border where 1 is opaque and 0 is transparent.",
2131
+ "type": "number",
2132
+ "minimum": 0,
2133
+ "maximum": 1,
2134
+ "default": 1,
2135
+ "examples": [
2136
+ 0.8
2137
+ ]
2138
+ },
2139
+ "radius": {
2140
+ "description": "The border radius in pixels for rounded corners. Must be 0 or greater.",
2141
+ "type": "number",
2142
+ "minimum": 0,
2143
+ "default": 0,
2144
+ "examples": [
2145
+ 10
2146
+ ]
2147
+ }
2148
+ },
2149
+ "additionalProperties": false,
2150
+ "type": "object"
2151
+ },
2188
2152
  "RichTextFont": {
2189
2153
  "description": "Font properties for rich text.",
2190
2154
  "properties": {
@@ -2321,6 +2285,49 @@
2321
2285
  "additionalProperties": false,
2322
2286
  "type": "object"
2323
2287
  },
2288
+ "RichTextPadding": {
2289
+ "description": "Padding properties for individual sides of the text bounding box.",
2290
+ "properties": {
2291
+ "top": {
2292
+ "description": "Top padding in pixels.",
2293
+ "type": "number",
2294
+ "minimum": 0,
2295
+ "default": 0,
2296
+ "examples": [
2297
+ 10
2298
+ ]
2299
+ },
2300
+ "right": {
2301
+ "description": "Right padding in pixels.",
2302
+ "type": "number",
2303
+ "minimum": 0,
2304
+ "default": 0,
2305
+ "examples": [
2306
+ 10
2307
+ ]
2308
+ },
2309
+ "bottom": {
2310
+ "description": "Bottom padding in pixels.",
2311
+ "type": "number",
2312
+ "minimum": 0,
2313
+ "default": 0,
2314
+ "examples": [
2315
+ 10
2316
+ ]
2317
+ },
2318
+ "left": {
2319
+ "description": "Left padding in pixels.",
2320
+ "type": "number",
2321
+ "minimum": 0,
2322
+ "default": 0,
2323
+ "examples": [
2324
+ 10
2325
+ ]
2326
+ }
2327
+ },
2328
+ "additionalProperties": false,
2329
+ "type": "object"
2330
+ },
2324
2331
  "RichTextShadow": {
2325
2332
  "description": "Text shadow properties.",
2326
2333
  "properties": {