@shotstack/schemas 1.20.2 → 1.21.0
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.
- package/dist/api.bundled.json +89 -78
- package/dist/json-schema/edit.json +100 -89
- package/dist/json-schema/index.cjs +1 -1
- package/dist/json-schema/index.js +1 -1
- package/dist/schema.d.ts +77 -62
- package/dist/zod/zod.gen.cjs +20 -6
- package/dist/zod/zod.gen.d.ts +26 -2
- package/dist/zod/zod.gen.js +16 -2
- package/dist/zod/zod.gen.ts +18 -2
- package/package.json +1 -1
package/dist/api.bundled.json
CHANGED
|
@@ -53,7 +53,7 @@
|
|
|
53
53
|
},
|
|
54
54
|
{
|
|
55
55
|
"name": "Serve",
|
|
56
|
-
"description": "Assets generated by the Edit API or uploaded via the Ingest API are sent to the Serve API. The Serve API includes a simple hosting service with a CDN or you can send assets to third party services like AWS S3 or
|
|
56
|
+
"description": "Assets generated by the Edit API or uploaded via the Ingest API are sent to the Serve API. The Serve API includes a simple hosting service with a CDN or you can send assets to third party services like AWS S3 or Google Cloud Storage. The Serve API includes endpoints to look up assets, where they are hosted and their status."
|
|
57
57
|
},
|
|
58
58
|
{
|
|
59
59
|
"name": "Ingest",
|
|
@@ -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 [
|
|
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-
|
|
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\
|
|
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
|
|
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
|
-
"
|
|
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
|
-
"
|
|
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/
|
|
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/
|
|
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": {
|
|
@@ -4367,7 +4374,8 @@
|
|
|
4367
4374
|
"$ref": "#/components/schemas/VimeoDestination"
|
|
4368
4375
|
},
|
|
4369
4376
|
{
|
|
4370
|
-
"
|
|
4377
|
+
"deprecated": true,
|
|
4378
|
+
"description": "**Notice: The TikTok destination is deprecated.** It continues to work, with no behaviour change for existing integrations.\nSend videos to TikTok. TikTok credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/tiktok), not in the request.",
|
|
4371
4379
|
"properties": {
|
|
4372
4380
|
"provider": {
|
|
4373
4381
|
"description": "The destination to send video to - set to `tiktok` for TikTok.",
|
|
@@ -4377,6 +4385,7 @@
|
|
|
4377
4385
|
},
|
|
4378
4386
|
"options": {
|
|
4379
4387
|
"description": "Additional TikTok configuration options.",
|
|
4388
|
+
"deprecated": true,
|
|
4380
4389
|
"properties": {
|
|
4381
4390
|
"title": {
|
|
4382
4391
|
"description": "A title for the video that will be displayed on TikTok.",
|
|
@@ -4418,7 +4427,7 @@
|
|
|
4418
4427
|
]
|
|
4419
4428
|
},
|
|
4420
4429
|
{
|
|
4421
|
-
"description": "Send videos and assets to [Akamai NetStorage](https://techdocs.akamai.com/netstorage
|
|
4430
|
+
"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
4431
|
"properties": {
|
|
4423
4432
|
"provider": {
|
|
4424
4433
|
"description": "The destination to send assets to - set to `akamai-netstorage` for Akamai NetStorage.",
|
|
@@ -4533,7 +4542,8 @@
|
|
|
4533
4542
|
]
|
|
4534
4543
|
},
|
|
4535
4544
|
"MuxDestination": {
|
|
4536
|
-
"
|
|
4545
|
+
"deprecated": true,
|
|
4546
|
+
"description": "**Notice: The Mux destination is deprecated.** It continues to work, with no behaviour change for existing integrations.\nSend 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
4547
|
"properties": {
|
|
4538
4548
|
"provider": {
|
|
4539
4549
|
"description": "The destination to send video to - set to `mux` for Mux.",
|
|
@@ -4552,7 +4562,8 @@
|
|
|
4552
4562
|
]
|
|
4553
4563
|
},
|
|
4554
4564
|
"MuxDestinationOptions": {
|
|
4555
|
-
"
|
|
4565
|
+
"deprecated": true,
|
|
4566
|
+
"description": "**Notice: MuxDestinationOptions, like the Mux destination, is deprecated.** It continues to work, with no behaviour change for existing integrations.\nPass additional options to control how Mux processes video. Currently supports playback_policy and passthrough options.",
|
|
4556
4567
|
"properties": {
|
|
4557
4568
|
"playbackPolicy": {
|
|
4558
4569
|
"description": "Sets the Mux `playback_policy` option. Value is an array of strings - use `public`, `signed`, or both.",
|
|
@@ -5887,7 +5898,7 @@
|
|
|
5887
5898
|
"example": "2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7"
|
|
5888
5899
|
},
|
|
5889
5900
|
"providerId": {
|
|
5890
|
-
"description": "The third party id of an asset transferred to an external provider,
|
|
5901
|
+
"description": "The third party id of an asset transferred to an external provider, such as Vimeo or S3. If the provider is Shotstack, the providerID is the same as the asset id.",
|
|
5891
5902
|
"type": "string",
|
|
5892
5903
|
"example": "a4482cbf-e321-42a2-ac8b-947d26886840"
|
|
5893
5904
|
},
|
|
@@ -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
|
|
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",
|
|
@@ -679,7 +679,8 @@
|
|
|
679
679
|
"$ref": "#/$defs/VimeoDestination"
|
|
680
680
|
},
|
|
681
681
|
{
|
|
682
|
-
"
|
|
682
|
+
"deprecated": true,
|
|
683
|
+
"description": "**Notice: The TikTok destination is deprecated.** It continues to work, with no behaviour change for existing integrations.\nSend videos to TikTok. TikTok credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/tiktok), not in the request.",
|
|
683
684
|
"properties": {
|
|
684
685
|
"provider": {
|
|
685
686
|
"description": "The destination to send video to - set to `tiktok` for TikTok.",
|
|
@@ -691,6 +692,7 @@
|
|
|
691
692
|
},
|
|
692
693
|
"options": {
|
|
693
694
|
"description": "Additional TikTok configuration options.",
|
|
695
|
+
"deprecated": true,
|
|
694
696
|
"properties": {
|
|
695
697
|
"title": {
|
|
696
698
|
"description": "A title for the video that will be displayed on TikTok.",
|
|
@@ -732,7 +734,7 @@
|
|
|
732
734
|
]
|
|
733
735
|
},
|
|
734
736
|
{
|
|
735
|
-
"description": "Send videos and assets to [Akamai NetStorage](https://techdocs.akamai.com/netstorage
|
|
737
|
+
"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
738
|
"properties": {
|
|
737
739
|
"provider": {
|
|
738
740
|
"description": "The destination to send assets to - set to `akamai-netstorage` for Akamai NetStorage.",
|
|
@@ -1271,7 +1273,8 @@
|
|
|
1271
1273
|
]
|
|
1272
1274
|
},
|
|
1273
1275
|
"MuxDestination": {
|
|
1274
|
-
"
|
|
1276
|
+
"deprecated": true,
|
|
1277
|
+
"description": "**Notice: The Mux destination is deprecated.** It continues to work, with no behaviour change for existing integrations.\nSend 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
1278
|
"properties": {
|
|
1276
1279
|
"provider": {
|
|
1277
1280
|
"description": "The destination to send video to - set to `mux` for Mux.",
|
|
@@ -1292,7 +1295,8 @@
|
|
|
1292
1295
|
]
|
|
1293
1296
|
},
|
|
1294
1297
|
"MuxDestinationOptions": {
|
|
1295
|
-
"
|
|
1298
|
+
"deprecated": true,
|
|
1299
|
+
"description": "**Notice: MuxDestinationOptions, like the Mux destination, is deprecated.** It continues to work, with no behaviour change for existing integrations.\nPass additional options to control how Mux processes video. Currently supports playback_policy and passthrough options.",
|
|
1296
1300
|
"properties": {
|
|
1297
1301
|
"playbackPolicy": {
|
|
1298
1302
|
"description": "Sets the Mux `playback_policy` option. Value is an array of strings - use `public`, `signed`, or both.",
|
|
@@ -1851,7 +1855,7 @@
|
|
|
1851
1855
|
},
|
|
1852
1856
|
"border": {
|
|
1853
1857
|
"description": "Border styling properties for the caption bounding box.",
|
|
1854
|
-
"$ref": "#/$defs/
|
|
1858
|
+
"$ref": "#/$defs/RichTextBorder"
|
|
1855
1859
|
},
|
|
1856
1860
|
"padding": {
|
|
1857
1861
|
"description": "Padding inside the caption bounding box. Can be a single number (applied to all sides) or an object with individual sides.",
|
|
@@ -1865,7 +1869,7 @@
|
|
|
1865
1869
|
]
|
|
1866
1870
|
},
|
|
1867
1871
|
{
|
|
1868
|
-
"$ref": "#/$defs/
|
|
1872
|
+
"$ref": "#/$defs/RichTextPadding"
|
|
1869
1873
|
}
|
|
1870
1874
|
]
|
|
1871
1875
|
},
|
|
@@ -2021,47 +2025,7 @@
|
|
|
2021
2025
|
},
|
|
2022
2026
|
"border": {
|
|
2023
2027
|
"description": "Border styling properties for the text bounding box.",
|
|
2024
|
-
"
|
|
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"
|
|
2028
|
+
"$ref": "#/$defs/RichTextBorder"
|
|
2065
2029
|
},
|
|
2066
2030
|
"padding": {
|
|
2067
2031
|
"description": "Padding inside the text bounding box. Can be a single number (applied to all sides) or an object with individual sides.",
|
|
@@ -2075,47 +2039,7 @@
|
|
|
2075
2039
|
]
|
|
2076
2040
|
},
|
|
2077
2041
|
{
|
|
2078
|
-
"
|
|
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"
|
|
2042
|
+
"$ref": "#/$defs/RichTextPadding"
|
|
2119
2043
|
}
|
|
2120
2044
|
]
|
|
2121
2045
|
},
|
|
@@ -2185,6 +2109,50 @@
|
|
|
2185
2109
|
"additionalProperties": false,
|
|
2186
2110
|
"type": "object"
|
|
2187
2111
|
},
|
|
2112
|
+
"RichTextBorder": {
|
|
2113
|
+
"description": "Border styling properties for the text bounding box.",
|
|
2114
|
+
"properties": {
|
|
2115
|
+
"width": {
|
|
2116
|
+
"description": "The width of the border in pixels. Must be 0 or greater.",
|
|
2117
|
+
"type": "number",
|
|
2118
|
+
"minimum": 0,
|
|
2119
|
+
"default": 0,
|
|
2120
|
+
"examples": [
|
|
2121
|
+
2
|
|
2122
|
+
]
|
|
2123
|
+
},
|
|
2124
|
+
"color": {
|
|
2125
|
+
"description": "The border color using hexadecimal color notation.",
|
|
2126
|
+
"type": "string",
|
|
2127
|
+
"pattern": "^#[A-Fa-f0-9]{6}$",
|
|
2128
|
+
"default": "#000000",
|
|
2129
|
+
"examples": [
|
|
2130
|
+
"#ff0000"
|
|
2131
|
+
]
|
|
2132
|
+
},
|
|
2133
|
+
"opacity": {
|
|
2134
|
+
"description": "The opacity of the border where 1 is opaque and 0 is transparent.",
|
|
2135
|
+
"type": "number",
|
|
2136
|
+
"minimum": 0,
|
|
2137
|
+
"maximum": 1,
|
|
2138
|
+
"default": 1,
|
|
2139
|
+
"examples": [
|
|
2140
|
+
0.8
|
|
2141
|
+
]
|
|
2142
|
+
},
|
|
2143
|
+
"radius": {
|
|
2144
|
+
"description": "The border radius in pixels for rounded corners. Must be 0 or greater.",
|
|
2145
|
+
"type": "number",
|
|
2146
|
+
"minimum": 0,
|
|
2147
|
+
"default": 0,
|
|
2148
|
+
"examples": [
|
|
2149
|
+
10
|
|
2150
|
+
]
|
|
2151
|
+
}
|
|
2152
|
+
},
|
|
2153
|
+
"additionalProperties": false,
|
|
2154
|
+
"type": "object"
|
|
2155
|
+
},
|
|
2188
2156
|
"RichTextFont": {
|
|
2189
2157
|
"description": "Font properties for rich text.",
|
|
2190
2158
|
"properties": {
|
|
@@ -2321,6 +2289,49 @@
|
|
|
2321
2289
|
"additionalProperties": false,
|
|
2322
2290
|
"type": "object"
|
|
2323
2291
|
},
|
|
2292
|
+
"RichTextPadding": {
|
|
2293
|
+
"description": "Padding properties for individual sides of the text bounding box.",
|
|
2294
|
+
"properties": {
|
|
2295
|
+
"top": {
|
|
2296
|
+
"description": "Top padding in pixels.",
|
|
2297
|
+
"type": "number",
|
|
2298
|
+
"minimum": 0,
|
|
2299
|
+
"default": 0,
|
|
2300
|
+
"examples": [
|
|
2301
|
+
10
|
|
2302
|
+
]
|
|
2303
|
+
},
|
|
2304
|
+
"right": {
|
|
2305
|
+
"description": "Right padding in pixels.",
|
|
2306
|
+
"type": "number",
|
|
2307
|
+
"minimum": 0,
|
|
2308
|
+
"default": 0,
|
|
2309
|
+
"examples": [
|
|
2310
|
+
10
|
|
2311
|
+
]
|
|
2312
|
+
},
|
|
2313
|
+
"bottom": {
|
|
2314
|
+
"description": "Bottom padding in pixels.",
|
|
2315
|
+
"type": "number",
|
|
2316
|
+
"minimum": 0,
|
|
2317
|
+
"default": 0,
|
|
2318
|
+
"examples": [
|
|
2319
|
+
10
|
|
2320
|
+
]
|
|
2321
|
+
},
|
|
2322
|
+
"left": {
|
|
2323
|
+
"description": "Left padding in pixels.",
|
|
2324
|
+
"type": "number",
|
|
2325
|
+
"minimum": 0,
|
|
2326
|
+
"default": 0,
|
|
2327
|
+
"examples": [
|
|
2328
|
+
10
|
|
2329
|
+
]
|
|
2330
|
+
}
|
|
2331
|
+
},
|
|
2332
|
+
"additionalProperties": false,
|
|
2333
|
+
"type": "object"
|
|
2334
|
+
},
|
|
2324
2335
|
"RichTextShadow": {
|
|
2325
2336
|
"description": "Text shadow properties.",
|
|
2326
2337
|
"properties": {
|