@shotstack/schemas 1.6.0 → 1.7.0

package/dist/json-schema/s3destination-options.json

@@ -0,0 +1,59 @@
+{
+  "name": "S3DestinationOptions",
+  "strict": true,
+  "schema": {
+    "description": "Pass additional options to control how files are stored in S3.",
+    "properties": {
+      "region": {
+        "description": "Choose the region to send the file to. Must be a valid  [AWS region](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) string like `us-east-1` or `ap-southeast-2`.",
+        "type": "string"
+      },
+      "bucket": {
+        "description": "The bucket name to send files to. The bucket must exist in the AWS account before files can be sent.",
+        "type": "string"
+      },
+      "prefix": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "A prefix for the file being sent. This is typically a folder name, i.e. `videos` or `customerId/videos`."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "filename": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "acl": {
+        "anyOf": [
+          {
+            "type": "string",
+            "description": "Sets the S3 Access Control List (acl) permissions. Default is `private`. Must use a valid  S3 [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl)."
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "required": [
+      "region",
+      "bucket",
+      "prefix",
+      "filename",
+      "acl"
+    ],
+    "type": "object",
+    "additionalProperties": false
+  }
+}

package/dist/json-schema/s3destination.json

@@ -0,0 +1,90 @@
+{
+  "name": "S3Destination",
+  "strict": true,
+  "schema": {
+    "description": "Send videos and assets to an [Amazon S3](https://shotstack.io/docs/guide/serving-assets/destinations/s3/) bucket. Send files to any region with your own prefix and filename. AWS credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/s3), not in the request.",
+    "properties": {
+      "provider": {
+        "description": "The destination to send assets to - set to `s3` for S3.",
+        "type": "string",
+        "enum": [
+          "s3"
+        ]
+      },
+      "options": {
+        "anyOf": [
+          {
+            "description": "Additional S3 configuration options.",
+            "$ref": "#/$defs/S3DestinationOptions"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "type": "object",
+    "required": [
+      "provider",
+      "options"
+    ],
+    "additionalProperties": false,
+    "$defs": {
+      "S3DestinationOptions": {
+        "description": "Pass additional options to control how files are stored in S3.",
+        "properties": {
+          "region": {
+            "description": "Choose the region to send the file to. Must be a valid  [AWS region](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) string like `us-east-1` or `ap-southeast-2`.",
+            "type": "string"
+          },
+          "bucket": {
+            "description": "The bucket name to send files to. The bucket must exist in the AWS account before files can be sent.",
+            "type": "string"
+          },
+          "prefix": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "A prefix for the file being sent. This is typically a folder name, i.e. `videos` or `customerId/videos`."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "filename": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "acl": {
+            "anyOf": [
+              {
+                "type": "string",
+                "description": "Sets the S3 Access Control List (acl) permissions. Default is `private`. Must use a valid  S3 [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl)."
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "region",
+          "bucket",
+          "prefix",
+          "filename",
+          "acl"
+        ],
+        "type": "object",
+        "additionalProperties": false
+      }
+    }
+  }
+}