{ "openapi": "3.0.0", "externalDocs": { "description": "See documentation for Akamai's Image & Video Manager API", "url": "https://techdocs.akamai.com/ivm/reference" }, "info": { "title": "Akamai: Image & Video Manager API", "version": "2", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" } }, "paths": { "/imagecollections": { "get": { "description": "Lists all image collections, unless you set a limit.", "operationId": "get-image-collections", "summary": "List image collections", "tags": [ "Image collections" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Image & Video Manager API", "url": "https://techdocs.akamai.com/ivm/reference/get-image-collections" }, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "example": { "itemKind": "IMAGECOLLECTION", "totalItems": 2, "items": [ { "id": "ring_spin360", "lastModifiedTimestamp": 1649865301693, "user": "jsmith", "definition": { "items": [ { "type": "spin360", "urls": [ "https://example.com/img/ring_01.jpg", "https://example.com/img/ring_02.jpg", "https://example.com/img/ring_03.jpg", "https://example.com/img/ring_04.jpg", "https://example.com/img/ring_05.jpg", "https://example.com/img/ring_06.jpg", "https://example.com/img/ring_07.jpg", "https://example.com/img/ring_08.jpg", "https://example.com/img/ring_09.jpg", "https://example.com/img/ring_10.jpg", "https://example.com/img/ring_11.jpg", "https://example.com/img/ring_12.jpg", "https://example.com/img/ring_13.jpg", "https://example.com/img/ring_14.jpg", "https://example.com/img/ring_15.jpg", "https://example.com/img/ring_16.jpg", "https://example.com/img/ring_17.jpg", "https://example.com/img/ring_18.jpg", "https://example.com/img/ring_19.jpg", "https://example.com/img/ring_20.jpg" ] }, { "mime": "video/mp4", "poster": "", "type": "video", "url": "https://example.com/video/engagement.mp4" } ] } }, { "description": "A collection for bikes", "id": "SKU-26684355", "lastModifiedTimestamp": 1649865078032, "user": "jsmith", "definition": { "version": 1, "items": [ { "mime": "image/jpeg", "type": "image", "url": "https://example.com/bikes/sport-bike.jpg", "tags": [ "red" ] }, { "mime": "image/jpeg", "type": "image", "url": "https://example.com/bikes/road-bike.jpg", "tags": [ "blue" ] }, { "mime": "image/jpeg", "type": "image", "url": "https://example.com/bikes/transport-bike.jpg", "tags": [ "red" ] } ] } } ] }, "schema": { "additionalProperties": false, "description": "Provides data about the types of items included in an image collection.", "type": "object", "properties": { "itemKind": { "description": "The type of item included in the response. In this case it's the available `IMAGECOLLECTION`.", "type": "string", "enum": [ "IMAGECOLLECTION" ] }, "items": { "description": "The Collection array provides data about the types of items included in an image collection.", "type": "array", "items": { "additionalProperties": false, "description": "Allows you to create and manage collections of your Image & Video Manager assets.", "type": "object", "required": [ "definition", "id" ], "properties": { "definition": { "additionalProperties": false, "description": "Provides data about the types of items included in an image collection.", "title": "Image Collection definition", "type": "object", "required": [ "version", "items" ], "properties": { "items": { "description": "A listing of the images, videos, and 360 degree image spins included in the collection.", "minItems": 1, "type": "array", "items": { "description": "Array of Image, Video, and Spin360 objects.", "oneOf": [ { "additionalProperties": false, "description": "Information about an image that's included in the collection.", "title": "Collection image", "type": "object", "required": [ "type", "url" ], "properties": { "mime": { "description": "The MIME type of the image.", "type": "string" }, "tags": { "description": "Additional keywords to describe the object.", "type": "array", "items": { "description": "A string of at least one character.", "type": "string" } }, "type": { "description": "The type of item in the collection. `image` in this case.", "type": "string", "enum": [ "image" ] }, "url": { "description": "The URL of the image.", "format": "uri-reference", "type": "string" } }, "x-akamai": { "file-path": "schemas/imagecollection-image.yaml" } }, { "additionalProperties": false, "description": "Information about a video that's included in the collection.", "title": "Collection video", "type": "object", "required": [ "type", "mime", "url" ], "properties": { "mime": { "description": "The MIME type of the video.", "minLength": 1, "type": "string", "x-akamai": { "file-path": "schemas/non-empty-string.yaml" } }, "poster": { "description": "The URL of the image to display while the video is downloading.", "format": "uri-reference", "type": "string" }, "tags": { "description": "Additional keywords to describe the object.", "type": "array", "items": { "description": "A string of at least one character.", "minLength": 1, "type": "string" } }, "type": { "description": "The type of item in the collection, `video` in this case.", "type": "string", "enum": [ "video" ] }, "url": { "description": "The URL of the video.", "format": "uri-reference", "type": "string" } }, "x-akamai": { "file-path": "schemas/imagecollection-video.yaml" } }, { "additionalProperties": false, "description": "Information about a 360 degree image spin that's included in the collection.", "title": "Collection Spin360", "type": "object", "required": [ "type", "urls" ], "properties": { "tags": { "description": "Additional keywords to describe the object.", "type": "array", "items": { "description": "A string of at least one character.", "minLength": 1, "type": "string" } }, "type": { "description": "The type of item in the collection, `spin360` in this case.", "type": "string", "enum": [ "spin360" ] }, "urls": { "description": "The URL of the 360 spin file.", "minItems": 1, "type": "array", "items": { "description": "The URL for the collection.", "format": "uri-reference", "type": "string" } } }, "x-akamai": { "file-path": "schemas/imagecollection-spin-360.yaml" } } ] } }, "version": { "description": "The version of the collection.", "type": "number" } }, "x-akamai": { "file-path": "schemas/imagecollection-definition.yaml" } }, "description": { "description": "A human-readable name for the image collection.", "type": "string" }, "id": { "description": "The ID of the image collection.", "minLength": 1, "type": "string" }, "lastModifiedTimestamp": { "description": "Date the image collection was last updated in UNIX timestamp format.", "readOnly": true, "type": "number" }, "user": { "description": "The user who created this image collection version.", "readOnly": true, "type": "string" } }, "x-akamai": { "file-path": "schemas/imagecollection.yaml" } } }, "totalItems": { "description": "The total number of image collections.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/imagecollection-array.yaml" } } } } } }, "parameters": [ { "description": "Specifies maximum number of items to get.", "example": "{{limit}}", "in": "query", "name": "limit", "schema": { "default": 1000, "example": 2, "type": "integer" }, "x-akamai": { "file-path": "parameters/limit-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "put": { "description": "Create a new image collection.", "operationId": "put-root", "summary": "Create a new image collection", "tags": [ "Image collections" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Image & Video Manager API", "url": "https://techdocs.akamai.com/ivm/reference/put-root" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "description": "A collection for bikes", "id": "SKU-26684355", "definition": { "items": [ { "mime": "image/jpeg", "type": "image", "url": "https://example.com/bikes/sport-bike.jpg", "tags": [ "red" ] }, { "mime": "image/jpeg", "type": "image", "url": "https://example.com/bikes/road-bike.jpg", "tags": [ "green" ] } ] } }, "schema": { "additionalProperties": false, "description": "Allows you to create and manage collections of your Image & Video Manager assets.", "type": "object", "required": [ "definition", "id" ], "properties": { "definition": { "additionalProperties": false, "description": "Provides data about the types of items included in an image collection.", "title": "Image Collection definition", "type": "object", "required": [ "version", "items" ], "properties": { "items": { "description": "A listing of the images, videos, and 360 degree image spins included in the collection.", "minItems": 1, "type": "array", "items": { "description": "Array of Image, Video, and Spin360 objects.", "oneOf": [ { "additionalProperties": false, "description": "Information about an image that's included in the collection.", "title": "Collection image", "type": "object", "required": [ "type", "url" ], "properties": { "mime": { "description": "The MIME type of the image.", "type": "string" }, "tags": { "description": "Additional keywords to describe the object.", "type": "array", "items": { "description": "A string of at least one character.", "type": "string" } }, "type": { "description": "The type of item in the collection. `image` in this case.", "type": "string", "enum": [ "image" ] }, "url": { "description": "The URL of the image.", "format": "uri-reference", "type": "string" } }, "x-akamai": { "file-path": "schemas/imagecollection-image.yaml" } }, { "additionalProperties": false, "description": "Information about a video that's included in the collection.", "title": "Collection video", "type": "object", "required": [ "type", "mime", "url" ], "properties": { "mime": { "description": "The MIME type of the video.", "minLength": 1, "type": "string", "x-akamai": { "file-path": "schemas/non-empty-string.yaml" } }, "poster": { "description": "The URL of the image to display while the video is downloading.", "format": "uri-reference", "type": "string" }, "tags": { "description": "Additional keywords to describe the object.", "type": "array", "items": { "description": "A string of at least one character.", "minLength": 1, "type": "string" } }, "type": { "description": "The type of item in the collection, `video` in this case.", "type": "string", "enum": [ "video" ] }, "url": { "description": "The URL of the video.", "format": "uri-reference", "type": "string" } }, "x-akamai": { "file-path": "schemas/imagecollection-video.yaml" } }, { "additionalProperties": false, "description": "Information about a 360 degree image spin that's included in the collection.", "title": "Collection Spin360", "type": "object", "required": [ "type", "urls" ], "properties": { "tags": { "description": "Additional keywords to describe the object.", "type": "array", "items": { "description": "A string of at least one character.", "minLength": 1, "type": "string" } }, "type": { "description": "The type of item in the collection, `spin360` in this case.", "type": "string", "enum": [ "spin360" ] }, "urls": { "description": "The URL of the 360 spin file.", "minItems": 1, "type": "array", "items": { "description": "The URL for the collection.", "format": "uri-reference", "type": "string" } } }, "x-akamai": { "file-path": "schemas/imagecollection-spin-360.yaml" } } ] } }, "version": { "description": "The version of the collection.", "type": "number" } }, "x-akamai": { "file-path": "schemas/imagecollection-definition.yaml" } }, "description": { "description": "A human-readable name for the image collection.", "example": "{{description}}", "type": "string" }, "id": { "description": "The ID of the image collection.", "example": "{{id}}", "minLength": 1, "type": "string" }, "lastModifiedTimestamp": { "description": "Date the image collection was last updated in UNIX timestamp format.", "example": "{{lastModifiedTimestamp}}", "readOnly": true, "type": "number" }, "user": { "description": "The user who created this image collection version.", "example": "{{user}}", "readOnly": true, "type": "string" } }, "x-akamai": { "file-path": "schemas/imagecollection.yaml" } } } } }, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "example": { "description": "Image Collection SKU-26684355 was created", "id": "SKU-26684355", "operationPerformed": "CREATED" }, "schema": { "additionalProperties": false, "description": "The type of operation performed on an Image & Video Manager resource.", "type": "object", "properties": { "description": { "description": "The description of the resource.", "type": "string" }, "id": { "description": "Unique identifier for a resource.", "type": "string" }, "operationPerformed": { "description": "The action performed on the resource, either `CREATED`, `UPDATED`, `DELETED`, or `CANCELLED`.", "type": "string", "enum": [ "CREATED", "UPDATED", "DELETED", "CANCELLED" ] } }, "x-akamai": { "file-path": "schemas/operation-performed.yaml" } } } } }, "400": { "description": "Invalid image collection.", "content": { "application/problem+json": { "example": { "detail": "Request body was invalid JSON", "instance": "/imaging/error-instances/38b5157a-aea3-484e-ac50-b1f4bc6ba15b", "requestId": "622d5983b8fe3cd1", "status": 400, "title": "Bad Request", "type": "/imaging/error-types/IVM_9000" }, "schema": { "additionalProperties": false, "description": "Error messaging.", "type": "object", "properties": { "detail": { "description": "A detailed description of the error.", "type": "string" }, "httpStatus": { "description": "The HTTP code for the error.", "type": "integer" }, "instance": { "description": "A reference to unique instance of the error.", "type": "string" }, "requestId": { "description": "An additional instance identifier for the error.", "type": "string" }, "title": { "description": "The summary description of the error.", "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } } } }, "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for the Akamai Contract containing the policy sets. Required if you have access to more than one contract with Image & Video Manager.", "example": "{{Contract}}", "in": "header", "name": "Contract", "required": false, "schema": { "example": "A-CCT7890", "type": "string" }, "x-akamai": { "file-path": "parameters/contractId-header.yaml" } }, { "description": "Unique identifier for the Image & Video Manager policy set.", "example": "{{Policy-Set}}", "in": "header", "name": "Policy-Set", "required": true, "schema": { "example": "053eef00-9f85-11ec-a51d-47eefacf795d", "type": "string" }, "x-akamai": { "file-path": "parameters/policySetId-header.yaml" } } ] }, "/imagecollections/history/{imageCollectionId}": { "get": { "description": "Get a history of a specific image collection and all updates to it over the last three months.", "operationId": "get-image-collection-history", "summary": "Get image collection history", "tags": [ "Image collection hitory" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Image & Video Manager API", "url": "https://techdocs.akamai.com/ivm/reference/get-image-collection-history" }, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "example": { "itemKind": "IMAGECOLLECTIONHISTORY", "totalItems": 2, "items": [ { "description": "A collection for bikes", "id": "SKU-26684355", "lastModifiedTimestamp": 1649865078032, "user": "jsmith", "definition": { "version": 1, "items": [ { "mime": "image/jpeg", "type": "image", "url": "https://example.com/bikes/sport-bike.jpg", "tags": [ "red" ] }, { "mime": "image/jpeg", "type": "image", "url": "https://example.com/bikes/road-bike.jpg", "tags": [ "blue" ] }, { "mime": "image/jpeg", "type": "image", "url": "https://example.com/bikes/transport-bike.jpg", "tags": [ "red" ] } ] } }, { "description": "A collection for bikes", "id": "SKU-26684355", "lastModifiedTimestamp": 1649865051508, "user": "jsmith", "definition": { "version": 1, "items": [ { "mime": "image/jpeg", "type": "image", "url": "https://example.com/bikes/sport-bike.jpg", "tags": [ "red" ] }, { "mime": "image/jpeg", "type": "image", "url": "https://example.com/bikes/road-bike.jpg", "tags": [ "green" ] } ] } } ] }, "schema": { "additionalProperties": false, "description": "Provides details regarding versions of the image collection over the last three months.", "type": "object", "properties": { "itemKind": { "description": "The type of item included in the response. In this case it's the available `IMAGECOLLECTIONHISTORY`.", "type": "string", "enum": [ "IMAGECOLLECTIONHISTORY" ] }, "items": { "description": "The Collection array provides a list of versions of the image collection.", "type": "array", "items": { "additionalProperties": false, "description": "Allows you to create and manage collections of your Image & Video Manager assets.", "type": "object", "required": [ "definition", "id" ], "properties": { "definition": { "additionalProperties": false, "description": "Provides data about the types of items included in an image collection.", "title": "Image Collection definition", "type": "object", "required": [ "version", "items" ], "properties": { "items": { "description": "A listing of the images, videos, and 360 degree image spins included in the collection.", "minItems": 1, "type": "array", "items": { "description": "Array of Image, Video, and Spin360 objects.", "oneOf": [ { "additionalProperties": false, "description": "Information about an image that's included in the collection.", "title": "Collection image", "type": "object", "required": [ "type", "url" ], "properties": { "mime": { "description": "The MIME type of the image.", "type": "string" }, "tags": { "description": "Additional keywords to describe the object.", "type": "array", "items": { "description": "A string of at least one character.", "type": "string" } }, "type": { "description": "The type of item in the collection. `image` in this case.", "type": "string", "enum": [ "image" ] }, "url": { "description": "The URL of the image.", "format": "uri-reference", "type": "string" } }, "x-akamai": { "file-path": "schemas/imagecollection-image.yaml" } }, { "additionalProperties": false, "description": "Information about a video that's included in the collection.", "title": "Collection video", "type": "object", "required": [ "type", "mime", "url" ], "properties": { "mime": { "description": "The MIME type of the video.", "minLength": 1, "type": "string", "x-akamai": { "file-path": "schemas/non-empty-string.yaml" } }, "poster": { "description": "The URL of the image to display while the video is downloading.", "format": "uri-reference", "type": "string" }, "tags": { "description": "Additional keywords to describe the object.", "type": "array", "items": { "description": "A string of at least one character.", "minLength": 1, "type": "string" } }, "type": { "description": "The type of item in the collection, `video` in this case.", "type": "string", "enum": [ "video" ] }, "url": { "description": "The URL of the video.", "format": "uri-reference", "type": "string" } }, "x-akamai": { "file-path": "schemas/imagecollection-video.yaml" } }, { "additionalProperties": false, "description": "Information about a 360 degree image spin that's included in the collection.", "title": "Collection Spin360", "type": "object", "required": [ "type", "urls" ], "properties": { "tags": { "description": "Additional keywords to describe the object.", "type": "array", "items": { "description": "A string of at least one character.", "minLength": 1, "type": "string" } }, "type": { "description": "The type of item in the collection, `spin360` in this case.", "type": "string", "enum": [ "spin360" ] }, "urls": { "description": "The URL of the 360 spin file.", "minItems": 1, "type": "array", "items": { "description": "The URL for the collection.", "format": "uri-reference", "type": "string" } } }, "x-akamai": { "file-path": "schemas/imagecollection-spin-360.yaml" } } ] } }, "version": { "description": "The version of the collection.", "type": "number" } }, "x-akamai": { "file-path": "schemas/imagecollection-definition.yaml" } }, "description": { "description": "A human-readable name for the image collection.", "type": "string" }, "id": { "description": "The ID of the image collection.", "minLength": 1, "type": "string" }, "lastModifiedTimestamp": { "description": "Date the image collection was last updated in UNIX timestamp format.", "readOnly": true, "type": "number" }, "user": { "description": "The user who created this image collection version.", "readOnly": true, "type": "string" } }, "x-akamai": { "file-path": "schemas/imagecollection.yaml" } } }, "totalItems": { "description": "The total number of versions of the image collection in the last three months.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/imagecollection-history-array.yaml" } } } } } }, "parameters": [ { "description": "Specifies maximum number of items to get.", "example": "{{limit}}", "in": "query", "name": "limit", "schema": { "default": 1000, "example": 2, "type": "integer" }, "x-akamai": { "file-path": "parameters/limit-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for the Akamai Contract containing the policy sets. Required if you have access to more than one contract with Image & Video Manager.", "example": "{{Contract}}", "in": "header", "name": "Contract", "required": false, "schema": { "example": "A-CCT7890", "type": "string" }, "x-akamai": { "file-path": "parameters/contractId-header.yaml" } }, { "description": "Unique identifier for the Image & Video Manager policy set.", "example": "{{Policy-Set}}", "in": "header", "name": "Policy-Set", "required": true, "schema": { "example": "053eef00-9f85-11ec-a51d-47eefacf795d", "type": "string" }, "x-akamai": { "file-path": "parameters/policySetId-header.yaml" } }, { "description": "Unique identifier for each image collection.", "example": "{{imageCollectionId}}", "in": "path", "name": "imageCollectionId", "required": true, "schema": { "example": "MyId123", "type": "string" }, "x-akamai": { "file-path": "parameters/imageCollectionId-path.yaml" } } ] }, "/imagecollections/{imageCollectionId}": { "post": { "description": "Update an image collection.", "operationId": "post-image-collection", "summary": "Update an image collection", "tags": [ "Image collections" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Image & Video Manager API", "url": "https://techdocs.akamai.com/ivm/reference/post-image-collection" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "description": "A collection for bikes", "id": "SKU-26684355", "definition": { "items": [ { "mime": "image/jpeg", "type": "image", "url": "https://example.com/bikes/sport-bike.jpg", "tags": [ "red" ] }, { "mime": "image/jpeg", "type": "image", "url": "https://example.com/bikes/road-bike.jpg", "tags": [ "blue" ] }, { "mime": "image/jpeg", "type": "image", "url": "https://example.com/bikes/transport-bike.jpg", "tags": [ "red" ] } ] } }, "schema": { "additionalProperties": false, "description": "Allows you to create and manage collections of your Image & Video Manager assets.", "type": "object", "required": [ "definition", "id" ], "properties": { "definition": { "additionalProperties": false, "description": "Provides data about the types of items included in an image collection.", "title": "Image Collection definition", "type": "object", "required": [ "version", "items" ], "properties": { "items": { "description": "A listing of the images, videos, and 360 degree image spins included in the collection.", "minItems": 1, "type": "array", "items": { "description": "Array of Image, Video, and Spin360 objects.", "oneOf": [ { "additionalProperties": false, "description": "Information about an image that's included in the collection.", "title": "Collection image", "type": "object", "required": [ "type", "url" ], "properties": { "mime": { "description": "The MIME type of the image.", "type": "string" }, "tags": { "description": "Additional keywords to describe the object.", "type": "array", "items": { "description": "A string of at least one character.", "type": "string" } }, "type": { "description": "The type of item in the collection. `image` in this case.", "type": "string", "enum": [ "image" ] }, "url": { "description": "The URL of the image.", "format": "uri-reference", "type": "string" } }, "x-akamai": { "file-path": "schemas/imagecollection-image.yaml" } }, { "additionalProperties": false, "description": "Information about a video that's included in the collection.", "title": "Collection video", "type": "object", "required": [ "type", "mime", "url" ], "properties": { "mime": { "description": "The MIME type of the video.", "minLength": 1, "type": "string", "x-akamai": { "file-path": "schemas/non-empty-string.yaml" } }, "poster": { "description": "The URL of the image to display while the video is downloading.", "format": "uri-reference", "type": "string" }, "tags": { "description": "Additional keywords to describe the object.", "type": "array", "items": { "description": "A string of at least one character.", "minLength": 1, "type": "string" } }, "type": { "description": "The type of item in the collection, `video` in this case.", "type": "string", "enum": [ "video" ] }, "url": { "description": "The URL of the video.", "format": "uri-reference", "type": "string" } }, "x-akamai": { "file-path": "schemas/imagecollection-video.yaml" } }, { "additionalProperties": false, "description": "Information about a 360 degree image spin that's included in the collection.", "title": "Collection Spin360", "type": "object", "required": [ "type", "urls" ], "properties": { "tags": { "description": "Additional keywords to describe the object.", "type": "array", "items": { "description": "A string of at least one character.", "minLength": 1, "type": "string" } }, "type": { "description": "The type of item in the collection, `spin360` in this case.", "type": "string", "enum": [ "spin360" ] }, "urls": { "description": "The URL of the 360 spin file.", "minItems": 1, "type": "array", "items": { "description": "The URL for the collection.", "format": "uri-reference", "type": "string" } } }, "x-akamai": { "file-path": "schemas/imagecollection-spin-360.yaml" } } ] } }, "version": { "description": "The version of the collection.", "type": "number" } }, "x-akamai": { "file-path": "schemas/imagecollection-definition.yaml" } }, "description": { "description": "A human-readable name for the image collection.", "example": "{{description}}", "type": "string" }, "id": { "description": "The ID of the image collection.", "example": "{{id}}", "minLength": 1, "type": "string" }, "lastModifiedTimestamp": { "description": "Date the image collection was last updated in UNIX timestamp format.", "example": "{{lastModifiedTimestamp}}", "readOnly": true, "type": "number" }, "user": { "description": "The user who created this image collection version.", "example": "{{user}}", "readOnly": true, "type": "string" } }, "x-akamai": { "file-path": "schemas/imagecollection.yaml" } } } } }, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "example": { "description": "Image Collection SKU-26684355 was updated", "id": "SKU-26684355", "operationPerformed": "UPDATED" }, "schema": { "additionalProperties": false, "description": "The type of operation performed on an Image & Video Manager resource.", "type": "object", "properties": { "description": { "description": "The description of the resource.", "type": "string" }, "id": { "description": "Unique identifier for a resource.", "type": "string" }, "operationPerformed": { "description": "The action performed on the resource, either `CREATED`, `UPDATED`, `DELETED`, or `CANCELLED`.", "type": "string", "enum": [ "CREATED", "UPDATED", "DELETED", "CANCELLED" ] } }, "x-akamai": { "file-path": "schemas/operation-performed.yaml" } } } } }, "404": { "description": "Not found.", "content": { "application/problem+json": { "example": { "detail": "Request body was invalid JSON", "instance": "/imaging/error-instances/38b5157a-aea3-484e-ac50-b1f4bc6ba15b", "requestId": "622d5983b8fe3cd1", "status": 400, "title": "Bad Request", "type": "/imaging/error-types/IVM_9000" }, "schema": { "additionalProperties": false, "description": "Error messaging.", "type": "object", "properties": { "detail": { "description": "A detailed description of the error.", "type": "string" }, "httpStatus": { "description": "The HTTP code for the error.", "type": "integer" }, "instance": { "description": "A reference to unique instance of the error.", "type": "string" }, "requestId": { "description": "An additional instance identifier for the error.", "type": "string" }, "title": { "description": "The summary description of the error.", "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } } } }, "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "get": { "description": "Returns the values for the image collection you specify.", "operationId": "get-image-collection", "summary": "Get an image collection", "tags": [ "Image collections" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Image & Video Manager API", "url": "https://techdocs.akamai.com/ivm/reference/get-image-collection" }, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "example": { "id": "ring_spin360", "lastModifiedTimestamp": 1649865301693, "user": "jsmith", "definition": { "items": [ { "type": "spin360", "urls": [ "https://example.com/img/ring_01.jpg", "https://example.com/img/ring_02.jpg", "https://example.com/img/ring_03.jpg", "https://example.com/img/ring_04.jpg", "https://example.com/img/ring_05.jpg", "https://example.com/img/ring_06.jpg", "https://example.com/img/ring_07.jpg", "https://example.com/img/ring_08.jpg", "https://example.com/img/ring_09.jpg", "https://example.com/img/ring_10.jpg", "https://example.com/img/ring_11.jpg", "https://example.com/img/ring_12.jpg", "https://example.com/img/ring_13.jpg", "https://example.com/img/ring_14.jpg", "https://example.com/img/ring_15.jpg", "https://example.com/img/ring_16.jpg", "https://example.com/img/ring_17.jpg", "https://example.com/img/ring_18.jpg", "https://example.com/img/ring_19.jpg", "https://example.com/img/ring_20.jpg" ] }, { "mime": "video/mp4", "poster": "", "type": "video", "url": "https://example.com/video/engagement.mp4" } ] } }, "schema": { "additionalProperties": false, "description": "Allows you to create and manage collections of your Image & Video Manager assets.", "type": "object", "required": [ "definition", "id" ], "properties": { "definition": { "additionalProperties": false, "description": "Provides data about the types of items included in an image collection.", "title": "Image Collection definition", "type": "object", "required": [ "version", "items" ], "properties": { "items": { "description": "A listing of the images, videos, and 360 degree image spins included in the collection.", "minItems": 1, "type": "array", "items": { "description": "Array of Image, Video, and Spin360 objects.", "oneOf": [ { "additionalProperties": false, "description": "Information about an image that's included in the collection.", "title": "Collection image", "type": "object", "required": [ "type", "url" ], "properties": { "mime": { "description": "The MIME type of the image.", "type": "string" }, "tags": { "description": "Additional keywords to describe the object.", "type": "array", "items": { "description": "A string of at least one character.", "type": "string" } }, "type": { "description": "The type of item in the collection. `image` in this case.", "type": "string", "enum": [ "image" ] }, "url": { "description": "The URL of the image.", "format": "uri-reference", "type": "string" } }, "x-akamai": { "file-path": "schemas/imagecollection-image.yaml" } }, { "additionalProperties": false, "description": "Information about a video that's included in the collection.", "title": "Collection video", "type": "object", "required": [ "type", "mime", "url" ], "properties": { "mime": { "description": "The MIME type of the video.", "minLength": 1, "type": "string", "x-akamai": { "file-path": "schemas/non-empty-string.yaml" } }, "poster": { "description": "The URL of the image to display while the video is downloading.", "format": "uri-reference", "type": "string" }, "tags": { "description": "Additional keywords to describe the object.", "type": "array", "items": { "description": "A string of at least one character.", "minLength": 1, "type": "string" } }, "type": { "description": "The type of item in the collection, `video` in this case.", "type": "string", "enum": [ "video" ] }, "url": { "description": "The URL of the video.", "format": "uri-reference", "type": "string" } }, "x-akamai": { "file-path": "schemas/imagecollection-video.yaml" } }, { "additionalProperties": false, "description": "Information about a 360 degree image spin that's included in the collection.", "title": "Collection Spin360", "type": "object", "required": [ "type", "urls" ], "properties": { "tags": { "description": "Additional keywords to describe the object.", "type": "array", "items": { "description": "A string of at least one character.", "minLength": 1, "type": "string" } }, "type": { "description": "The type of item in the collection, `spin360` in this case.", "type": "string", "enum": [ "spin360" ] }, "urls": { "description": "The URL of the 360 spin file.", "minItems": 1, "type": "array", "items": { "description": "The URL for the collection.", "format": "uri-reference", "type": "string" } } }, "x-akamai": { "file-path": "schemas/imagecollection-spin-360.yaml" } } ] } }, "version": { "description": "The version of the collection.", "type": "number" } }, "x-akamai": { "file-path": "schemas/imagecollection-definition.yaml" } }, "description": { "description": "A human-readable name for the image collection.", "type": "string" }, "id": { "description": "The ID of the image collection.", "minLength": 1, "type": "string" }, "lastModifiedTimestamp": { "description": "Date the image collection was last updated in UNIX timestamp format.", "readOnly": true, "type": "number" }, "user": { "description": "The user who created this image collection version.", "readOnly": true, "type": "string" } }, "x-akamai": { "file-path": "schemas/imagecollection.yaml" } } } } }, "404": { "description": "Not found.", "content": { "application/problem+json": { "example": { "detail": "Unable to retrieve image collection with id 'my_collection'", "instance": "/imaging/error-instances/c7773b0a-702e-45be-b0c5-f75cf89e4cd7", "requestId": "622d5923cf68a406", "status": 404, "title": "Not Found", "type": "/imaging/error-types/IVM_9000" }, "schema": { "additionalProperties": false, "description": "Error messaging.", "type": "object", "properties": { "detail": { "description": "A detailed description of the error.", "type": "string" }, "httpStatus": { "description": "The HTTP code for the error.", "type": "integer" }, "instance": { "description": "A reference to unique instance of the error.", "type": "string" }, "requestId": { "description": "An additional instance identifier for the error.", "type": "string" }, "title": { "description": "The summary description of the error.", "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } } } }, "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "delete": { "description": "Delete a specific image collection.", "operationId": "delete-image-collection", "summary": "Remove an image collection", "tags": [ "Image collections" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Image & Video Manager API", "url": "https://techdocs.akamai.com/ivm/reference/delete-image-collection" }, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "example": { "description": "Item was deleted", "id": "SKU-35225621", "operationPerformed": "DELETED" }, "schema": { "additionalProperties": false, "description": "The type of operation performed on an Image & Video Manager resource.", "type": "object", "properties": { "description": { "description": "The description of the resource.", "type": "string" }, "id": { "description": "Unique identifier for a resource.", "type": "string" }, "operationPerformed": { "description": "The action performed on the resource, either `CREATED`, `UPDATED`, `DELETED`, or `CANCELLED`.", "type": "string", "enum": [ "CREATED", "UPDATED", "DELETED", "CANCELLED" ] } }, "x-akamai": { "file-path": "schemas/operation-performed.yaml" } } } } } }, "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for the Akamai Contract containing the policy sets. Required if you have access to more than one contract with Image & Video Manager.", "example": "{{Contract}}", "in": "header", "name": "Contract", "required": false, "schema": { "example": "A-CCT7890", "type": "string" }, "x-akamai": { "file-path": "parameters/contractId-header.yaml" } }, { "description": "Unique identifier for the Image & Video Manager policy set.", "example": "{{Policy-Set}}", "in": "header", "name": "Policy-Set", "required": true, "schema": { "example": "053eef00-9f85-11ec-a51d-47eefacf795d", "type": "string" }, "x-akamai": { "file-path": "parameters/policySetId-header.yaml" } }, { "description": "Unique identifier for each image collection.", "example": "{{imageCollectionId}}", "in": "path", "name": "imageCollectionId", "required": true, "schema": { "example": "MyId123", "type": "string" }, "x-akamai": { "file-path": "parameters/imageCollectionId-path.yaml" } } ] }, "/network/{network}/details/errors": { "get": { "description": "Returns a list of image or video errors for the transformations requested in the past three days.", "operationId": "get-errors", "summary": "List error details", "tags": [ "Errors" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Image & Video Manager API", "url": "https://techdocs.akamai.com/ivm/reference/get-errors" }, "responses": { "200": { "description": "The request was successful.", "content": { "application/json": { "example": { "itemKind": "LOGDETAILS", "totalItems": 1, "items": [ { "actual": 276134947, "completeTime": "2020-01-29 06:20:07", "policyId": "videoPolicy", "reason": "BYTES", "size": 854, "startTime": "2020-01-29 06:20:06", "status": "FAILED", "threshold": 268435456, "transformationType": "REALTIME", "url": "http://www.customer.com/dog_video.mp4" } ] }, "schema": { "additionalProperties": false, "description": "Lists the image or video errors pertaining to transformation tasks in the last 3 days.", "type": "object", "required": [ "itemKind", "items", "totalItems" ], "properties": { "itemKind": { "description": "The type of item returned, `LOGDETAILS` in this case.", "type": "string", "enum": [ "LOGDETAILS" ] }, "items": { "description": "A detailed list of the error details returned.", "type": "array", "items": { "additionalProperties": false, "description": "Lists image or video errors pertaining to transformation tasks.", "type": "object", "required": [ "url", "policyId", "size", "transformationType", "reason", "threshold", "actual", "status", "startTime", "completeTime" ], "properties": { "actual": { "description": "The actual value of the metric mentioned in the reason.", "type": "integer" }, "completeTime": { "description": "Time when the transformation task completed.", "format": "date-time", "type": "string" }, "pendingTime": { "description": "Time when the transformation task was added to the queue. Present only when images or videos are queued for offline processing.", "format": "date-time", "type": "string" }, "policyId": { "description": "The ID of the policy used for an Image & Video Manager transformation.", "type": "string" }, "reason": { "description": "Provides a reason for an Image & Video Manager failure. The possible values are: `DURATION` when the pristine video exceeds the maximum duration of 5 minutes, `BYTES` when the pristine video exceeds the maximum size of 256 MB, `PIXEL` when the pristine video pixels exceed 3,686,400 (1920×1920), `SAMPLERATE` when the pristine video exceeds maximum sample rate of 60 Hz, `UNPARSEABLE` when the pristine video isn't a recognized or supported video format, `PRISTINE_TOO_WIDE` when the pristine image width exceeds 9999 pixels, `PRISTINE_TOO_TALL` when the pristine image height exceeds 9999 pixels, `PROCESS_FAILED_INTERNALLY` when the image or video couldn't be fetched from the origin or the policy is outdated, or `INVALID_POLICY` when the policy parameters are invalid.", "type": "string", "enum": [ "DURATION", "BYTES", "PIXEL", "SAMPLERATE", "UNPARSEABLE", "PRISTINE_TOO_WIDE", "PRISTINE_TOO_TALL", "PROCESS_FAILED_INTERNALLY", "INVALID_POLICY" ] }, "size": { "description": "The size breakpoint width in pixels configured in the policy.", "type": "integer" }, "startTime": { "description": "Time when the transformation task execution started.", "format": "date-time", "type": "string" }, "status": { "description": "The status of the transformation task. The status is `PASSED` when the image or video processing succeeds, `FAILED` when the image or video processing fails, or `QUEUED` when the image or video processing is queued for offline processing.", "type": "string", "enum": [ "PASSED", "FAILED", "QUEUED" ] }, "threshold": { "description": "The threshold value of the metric mentioned in the reason.", "type": "integer" }, "transformationType": { "description": "The type of transformation requested. The transformation type is `OFFLINE` if the image processing is queued for offline processing, or `REALTIME` if the image processing is performed in realtime.", "type": "string", "enum": [ "REALTIME", "OFFLINE" ] }, "url": { "description": "The URL of the image.", "type": "string" } }, "x-akamai": { "file-path": "schemas/details-error.yaml" } } }, "totalItems": { "description": "The total number of error records returned.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/details-error-array.yaml" } } } } } }, "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "__Enum__ Network environment to execute the API request on.", "example": "{{network}}", "in": "path", "name": "network", "required": true, "schema": { "example": "production", "type": "string", "enum": [ "staging", "production" ] }, "x-akamai": { "file-path": "parameters/network-path.yaml" } }, { "description": "Unique identifier for the Akamai Contract containing the policy sets. Required if you have access to more than one contract with Image & Video Manager.", "example": "{{Contract}}", "in": "header", "name": "Contract", "required": false, "schema": { "example": "A-CCT7890", "type": "string" }, "x-akamai": { "file-path": "parameters/contractId-header.yaml" } }, { "description": "Unique identifier for the Image & Video Manager policy set.", "example": "{{Policy-Set}}", "in": "header", "name": "Policy-Set", "required": true, "schema": { "example": "053eef00-9f85-11ec-a51d-47eefacf795d", "type": "string" }, "x-akamai": { "file-path": "parameters/policySetId-header.yaml" } }, { "description": "Specifies the maximum number of logs per day.", "example": "{{limit}}", "in": "query", "name": "limit", "schema": { "default": 100, "example": 2, "type": "integer" }, "x-akamai": { "file-path": "parameters/detailsLimit-query.yaml" } }, { "description": "Limits search results to a specific image or video URL.", "example": "{{url}}", "in": "query", "name": "url", "schema": { "example": "http://www.example.com/video.mp4", "type": "string" }, "x-akamai": { "file-path": "parameters/detailsUrl-query.yaml" } }, { "description": "Filters the policy to specify a single image or video policy. To get a policy's ID, run the [List policies](https://techdocs.akamai.com/ivm/reference/get-policies) operation. Use in conjunction with the `url`, `transformationType`, and `size` parameters.", "example": "{{policyId}}", "in": "query", "name": "policyId", "schema": { "example": "thumbnail_policy", "type": "string" }, "x-akamai": { "file-path": "parameters/detailsPolicyId-query.yaml" } }, { "description": "Size breakpoint, in pixels, configured in the policy. Use in conjunction with the `url`, `transformationType`, and `policyId` query parameters.", "example": "{{size}}", "in": "query", "name": "size", "schema": { "example": 5000, "type": "integer" }, "x-akamai": { "file-path": "parameters/detailsSize-query.yaml" } }, { "description": "__Enum__ Filters results to include transformations done in `REALTIME` or queued for `OFFLINE` processing. Use in conjunction with the `url`, `size` and `policyId` parameters.", "example": "{{transformationType}}", "in": "query", "name": "transformationType", "schema": { "example": "REALTIME", "type": "string", "enum": [ "REALTIME", "OFFLINE" ] }, "x-akamai": { "file-path": "parameters/detailsTransformationType-query.yaml" } } ] }, "/network/{network}/details/logs": { "get": { "description": "Returns a list of image or video logs for the transformations requested in the past three days.", "operationId": "get-logs", "summary": "List log details", "tags": [ "Logs" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Image & Video Manager API", "url": "https://techdocs.akamai.com/ivm/reference/get-logs" }, "responses": { "200": { "description": "The request was successful.", "content": { "application/json": { "example": { "itemKind": "LOGDETAILS", "totalItems": 3, "items": [ { "completeTime": "2020-01-29 02:45:36", "policyId": "videoPolicy", "size": 854, "startTime": "2020-01-29 02:45:34", "status": "PASSED", "transformationType": "REALTIME", "url": "http://www.customer.com/cat_video.mp4" }, { "completeTime": "2020-01-29 02:45:39", "pendingTime": "2020-01-29 02:45:36", "policyId": "videoPolicy", "size": 854, "startTime": "2020-01-29 02:45:37", "status": "PASSED", "transformationType": "OFFLINE", "url": "http://www.customer.com/cat_video.mp4" }, { "actual": 276134947, "completeTime": "2020-01-29 06:20:07", "policyId": "videoPolicy", "reason": "BYTES", "size": 854, "startTime": "2020-01-29 06:20:06", "status": "FAILED", "threshold": 268435456, "transformationType": "REALTIME", "url": "http://www.customer.com/dog_video.mp4" } ] }, "schema": { "additionalProperties": false, "description": "Lists the image or video logs pertaining to transformation tasks in the last 3 days.", "type": "object", "required": [ "itemKind", "items", "totalItems" ], "properties": { "itemKind": { "description": "The type of item returned, `LOGDETAILS` in this case.", "type": "string", "enum": [ "LOGDETAILS" ] }, "items": { "description": "A detailed list of the log details returned.", "type": "array", "items": { "additionalProperties": false, "description": "Lists image or video logs pertaining to transformation tasks.", "type": "object", "required": [ "url", "policyId", "size", "transformationType", "status", "startTime", "completeTime" ], "properties": { "actual": { "description": "The actual value of metric mentioned in the reason. Present only for error logs.", "type": "integer" }, "completeTime": { "description": "Time when the transformation task was completed.", "format": "date-time", "type": "string" }, "pendingTime": { "description": "Time when the transformation task was added to queue. Present only for queued offline images or videos.", "format": "date-time", "type": "string" }, "policyId": { "description": "The ID of the policy used for the image or video transformation.", "type": "string" }, "reason": { "description": "Provides a reason for an Image & Video Manager failure. The possible values are: `DURATION` when the pristine video exceeds the maximum duration of 5 minutes, `BYTES` when the pristine video exceeds the maximum size of 256 MB, `PIXEL` when the pristine video pixels exceed 3,686,400 (1920×1920), `SAMPLERATE` when the pristine video exceeds maximum sample rate of 60 Hz, `UNPARSEABLE` when the pristine video isn't a recognized or supported video format, `PRISTINE_TOO_WIDE` when the pristine image width exceeds 9999 pixels, `PRISTINE_TOO_TALL` when the pristine image height exceeds 9999 pixels, `PROCESS_FAILED_INTERNALLY` when the image or video couldn't be fetched from the origin or the policy is outdated, or `INVALID_POLICY` when the policy parameters are invalid.", "type": "string", "enum": [ "DURATION", "BYTES", "PIXEL", "SAMPLERATE", "UNPARSEABLE", "PRISTINE_TOO_WIDE", "PRISTINE_TOO_TALL", "PROCESS_FAILED_INTERNALLY", "INVALID_POLICY" ] }, "size": { "description": "The size breakpoint width in pixels configured in the policy.", "type": "integer" }, "startTime": { "description": "Time when the transformation task execution started.", "format": "date-time", "type": "string" }, "status": { "description": "The status of the transformation task. The status is `PASSED` when the image or video processing succeeds, `FAILED` when the image or video processing fails, or `QUEUED` when the image or video processing is queued for offline processing.", "type": "string", "enum": [ "PASSED", "FAILED", "QUEUED" ] }, "threshold": { "description": "The threshold value of metric mentioned in the reason. Present only for error logs.", "type": "integer" }, "transformationType": { "description": "The type of transformation requested. The transformation type is `OFFLINE` if the image processing is queued for offline processing, or `REALTIME` if the image processing is performed in realtime.", "type": "string", "enum": [ "REALTIME", "OFFLINE" ] }, "url": { "description": "The URL of the image.", "type": "string" } }, "x-akamai": { "file-path": "schemas/details-log.yaml" } } }, "totalItems": { "description": "The total number of logs returned.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/details-log-array.yaml" } } } } } }, "parameters": [ { "description": "__Enum__ Network environment to execute the API request on.", "example": "{{network}}", "in": "path", "name": "network", "required": true, "schema": { "example": "production", "type": "string", "enum": [ "staging", "production" ] }, "x-akamai": { "file-path": "parameters/network-path.yaml" } }, { "description": "Unique identifier for the Akamai Contract containing the policy sets. Required if you have access to more than one contract with Image & Video Manager.", "example": "{{Contract}}", "in": "header", "name": "Contract", "required": false, "schema": { "example": "A-CCT7890", "type": "string" }, "x-akamai": { "file-path": "parameters/contractId-header.yaml" } }, { "description": "Unique identifier for the Image & Video Manager policy set.", "example": "{{Policy-Set}}", "in": "header", "name": "Policy-Set", "required": true, "schema": { "example": "053eef00-9f85-11ec-a51d-47eefacf795d", "type": "string" }, "x-akamai": { "file-path": "parameters/policySetId-header.yaml" } }, { "description": "Specifies the maximum number of logs per day.", "example": "{{limit}}", "in": "query", "name": "limit", "schema": { "default": 100, "example": 2, "type": "integer" }, "x-akamai": { "file-path": "parameters/detailsLimit-query.yaml" } }, { "description": "Limits search results to a specific image or video URL.", "example": "{{url}}", "in": "query", "name": "url", "schema": { "example": "http://www.example.com/video.mp4", "type": "string" }, "x-akamai": { "file-path": "parameters/detailsUrl-query.yaml" } }, { "description": "Filters the policy to specify a single image or video policy. To get a policy's ID, run the [List policies](https://techdocs.akamai.com/ivm/reference/get-policies) operation. Use in conjunction with the `url`, `transformationType`, and `size` parameters.", "example": "{{policyId}}", "in": "query", "name": "policyId", "schema": { "example": "thumbnail_policy", "type": "string" }, "x-akamai": { "file-path": "parameters/detailsPolicyId-query.yaml" } }, { "description": "Size breakpoint, in pixels, configured in the policy. Use in conjunction with the `url`, `transformationType`, and `policyId` query parameters.", "example": "{{size}}", "in": "query", "name": "size", "schema": { "example": 5000, "type": "integer" }, "x-akamai": { "file-path": "parameters/detailsSize-query.yaml" } }, { "description": "__Enum__ Filters results to include transformations done in `REALTIME` or queued for `OFFLINE` processing. Use in conjunction with the `url`, `size` and `policyId` parameters.", "example": "{{transformationType}}", "in": "query", "name": "transformationType", "schema": { "example": "REALTIME", "type": "string", "enum": [ "REALTIME", "OFFLINE" ] }, "x-akamai": { "file-path": "parameters/detailsTransformationType-query.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] } }, "/network/{network}/images": { "get": { "description": "List a policy's images.", "operationId": "get-images", "summary": "List images", "tags": [ "Images" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Image & Video Manager API", "url": "https://techdocs.akamai.com/ivm/reference/get-images" }, "responses": { "200": { "description": "The request was successful.", "content": { "application/json": { "example": { "itemKind": "IMAGE", "totalItems": 2, "items": [ { "id": "/uploads/image/header/small/bike-sale.jpg", "url": "https://images.example.com/uploads/image/header/small/bike-sale.jpg" }, { "id": "/uploads/image/header/large/spring-cleaning.jpg", "url": "https://images.example.com/uploads/image/header/large/spring-cleaning.jpg" }, { "id": "/uploads/image/showcase/item/sport-bike.jpg", "url": "https://images.example.com/uploads/image/showcase/item/sport-bike.jpg", "errors": [ "2022-04-09 16:02:47+0000: Image processing tasks did not complete successfully. No offline images were saved." ] } ] }, "schema": { "additionalProperties": false, "description": "Allows you to manage the images you're using with Image & Video Manager.", "type": "object", "properties": { "itemKind": { "description": "The type of item returned, `IMAGE` in this case.", "type": "string", "enum": [ "IMAGE" ] }, "items": { "description": "A detailed list of the images returned.", "type": "array", "items": { "additionalProperties": false, "description": "Collects information that describes an image.", "type": "object", "properties": { "errors": { "description": "Any errors associated with an image.", "type": "array", "items": { "type": "string" } }, "id": { "description": "The ID of the image.", "type": "string" }, "url": { "description": "The URL of the image.", "type": "string" } }, "x-akamai": { "file-path": "schemas/images-image.yaml" } } }, "totalItems": { "description": "The total number of images returned.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/images-array.yaml" } } } } } }, "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "__Enum__ Network environment to execute the API request on.", "example": "{{network}}", "in": "path", "name": "network", "required": true, "schema": { "example": "production", "type": "string", "enum": [ "staging", "production" ] }, "x-akamai": { "file-path": "parameters/network-path.yaml" } }, { "description": "Unique identifier for the Akamai Contract containing the policy sets. Required if you have access to more than one contract with Image & Video Manager.", "example": "{{Contract}}", "in": "header", "name": "Contract", "required": false, "schema": { "example": "A-CCT7890", "type": "string" }, "x-akamai": { "file-path": "parameters/contractId-header.yaml" } }, { "description": "Unique identifier for the Image & Video Manager policy set.", "example": "{{Policy-Set}}", "in": "header", "name": "Policy-Set", "required": true, "schema": { "example": "053eef00-9f85-11ec-a51d-47eefacf795d", "type": "string" }, "x-akamai": { "file-path": "parameters/policySetId-header.yaml" } }, { "description": "Specifies maximum number of items to get.", "example": "{{limit}}", "in": "query", "name": "limit", "schema": { "default": 1000, "example": 2, "type": "integer" }, "x-akamai": { "file-path": "parameters/limit-query.yaml" } }, { "description": "URL to search for.", "example": "{{url}}", "in": "query", "name": "url", "schema": { "example": "http://www.example.com/image2.png", "type": "string" }, "x-akamai": { "file-path": "parameters/url-query.yaml" } }, { "description": "The policy to list images for.", "example": "{{policyId}}", "in": "query", "name": "policyId", "schema": { "example": "thumbnail_policy", "type": "string" }, "x-akamai": { "file-path": "parameters/policyId-query.yaml" } } ] }, "/network/{network}/images/{imageId}": { "get": { "description": "Returns a specific image.", "operationId": "get-image", "summary": "Get an image", "tags": [ "Images" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Image & Video Manager API", "url": "https://techdocs.akamai.com/ivm/reference/get-image" }, "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "example": { "id": "/uploads/image/showcase/item/sport-bike.jpg", "url": "https://images.example.com/uploads/image/showcase/item/sport-bike.jpg", "errors": [ "2022-04-09 16:02:47+0000: Image processing tasks did not complete successfully. No offline images were saved." ] }, "schema": { "additionalProperties": false, "description": "Collects information that describes an image.", "type": "object", "properties": { "errors": { "description": "Any errors associated with an image.", "type": "array", "items": { "type": "string" } }, "id": { "description": "The ID of the image.", "type": "string" }, "url": { "description": "The URL of the image.", "type": "string" } }, "x-akamai": { "file-path": "schemas/images-image.yaml" } } } } } }, "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "__Enum__ Network environment to execute the API request on.", "example": "{{network}}", "in": "path", "name": "network", "required": true, "schema": { "example": "production", "type": "string", "enum": [ "staging", "production" ] }, "x-akamai": { "file-path": "parameters/network-path.yaml" } }, { "description": "Unique identifier for the Akamai Contract containing the policy sets. Required if you have access to more than one contract with Image & Video Manager.", "example": "{{Contract}}", "in": "header", "name": "Contract", "required": false, "schema": { "example": "A-CCT7890", "type": "string" }, "x-akamai": { "file-path": "parameters/contractId-header.yaml" } }, { "description": "Unique identifier for the Image & Video Manager policy set.", "example": "{{Policy-Set}}", "in": "header", "name": "Policy-Set", "required": true, "schema": { "example": "053eef00-9f85-11ec-a51d-47eefacf795d", "type": "string" }, "x-akamai": { "file-path": "parameters/policySetId-header.yaml" } }, { "description": "The ID of the image. This ID usually represents the part of the URL after the scheme, host, and port.", "example": "{{imageId}}", "in": "path", "name": "imageId", "required": true, "schema": { "example": "/images/image.jpg?imageId=format/jpg", "type": "string" }, "x-akamai": { "file-path": "parameters/imageId-path.yaml" } } ] }, "/network/{network}/policies": { "get": { "description": "Returns a list of all policies belonging to the specified policy set.", "operationId": "get-policies", "summary": "List policies", "tags": [ "Policies" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Image & Video Manager API", "url": "https://techdocs.akamai.com/ivm/reference/get-policies" }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "example": { "itemKind": "POLICY", "totalItems": 3, "items": [ { "dateCreated": "2021-09-22 18:15:34+0000", "id": ".auto", "previousVersion": 0, "user": "jsmith", "version": 1, "video": false, "breakpoints": { "widths": [ 720, 1080, 1366, 1920, 5000 ] }, "output": { "perceptualQuality": "mediumHigh" }, "rolloutInfo": { "endTime": 1632338734, "rolloutDuration": 3600, "startTime": 1632335134 } }, { "dateCreated": "2021-07-15 19:59:35+0000", "id": "watermark", "previousVersion": 0, "user": "jsmith", "version": 1, "video": false, "breakpoints": { "widths": [ 720, 1280, 1920, 5000 ] }, "output": { "perceptualQuality": "mediumHigh" }, "rolloutInfo": { "endTime": 1626382776, "rolloutDuration": 3600, "startTime": 1626379176 }, "transformations": [ { "gravity": "SouthWest", "transformation": "Composite", "xPosition": 0, "yPosition": 0, "image": { "url": "www.customer.com/watermark.png" } } ] }, { "dateCreated": "2020-02-11 16:55:00+0000", "id": "custom_text", "previousVersion": 0, "user": "jsmith", "version": 1, "video": false, "breakpoints": { "widths": [ 720, 1280, 1920, 5000 ] }, "output": { "quality": 90 }, "rolloutInfo": { "endTime": 1581445500, "rolloutDuration": 3600, "startTime": 1581441900 }, "transformations": [ { "gravity": "SouthWest", "transformation": "Composite", "xPosition": 0, "yPosition": 0, "image": { "fill": "#000000", "size": 72, "stroke": "#FFFFFF", "strokeSize": 0, "type": "Text", "text": { "var": "textVal" } } } ], "variables": [ { "defaultValue": "Hello there!", "name": "textVal", "type": "string" } ] } ] }, "schema": { "additionalProperties": false, "description": "Lists the policies for your configuration.", "type": "object", "properties": { "itemKind": { "description": "The type of policy.", "type": "string" }, "items": { "description": "A detailed list of the policies returned.", "type": "array", "items": { "oneOf": [ { "description": "Specifies details for each policy, such as variations in image size and formats and the transformations to apply.", "title": "Image policy", "type": "object", "x-akamai": { "file-path": "schemas/policy-image.yaml" }, "allOf": [ { "additionalProperties": false, "type": "object", "properties": { "output": { "additionalProperties": false, "description": "Dictates the output quality, either `quality` or `perceptualQuality`, and the formats created for each resized image. If unspecified, you get image formats that support all browsers at the default quality level of `85`, including WEBP, JPEG2000, and JPEG-XR for specific browsers.", "title": "Output", "type": "object", "properties": { "adaptiveQuality": { "description": "Overrides the quality of the image to serve when Image & Video Manager detects a slow connection with a round-trip time (RTT) of less than 300 ms. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of images for users with standard connections.", "maximum": 100, "minimum": 1, "type": "integer" }, "allowedFormats": { "description": "The graphics file formats allowed for browser specific results, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "minItems": 1, "readOnly": true, "type": "array", "uniqueItems": true, "default": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ], "items": { "description": "The values of the allowed graphics file formats, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "type": "string", "enum": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ] } }, "forcedFormats": { "description": "The forced extra formats for the `imFormat` query parameter, which requests a specific browser type. By default, Image & Video Manager detects the browser and returns the appropriate image.", "readOnly": true, "type": "array", "uniqueItems": true, "default": [], "items": { "description": "The values of the forced extra formats, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "type": "string", "enum": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ] } }, "perceptualQuality": { "description": "Mutually exclusive with `quality`. The perceptual quality to use when comparing resulting images, which overrides the `quality` setting. Perceptual quality tunes each image format's quality dynamically based on the human-perceived quality of the output image. This can result in greater byte savings as compared to using regular `quality` because many images can be encoded at a much lower quality without compromising the perceived quality of the image. In addition, certain images may need to be encoded at a slightly higher quality in order to maintain human-perceived quality. Value tiers are `high`, `mediumHigh`, `medium`, `mediumLow`, and `low`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "perceptualQualityFloor": { "description": "Applies only when `perceptualQuality` is set. Sets a minimum image quality to respect when using perceptual quality. Perceptual quality won't reduce the quality below this value, even if it determines the compressed image to be acceptably visually similar.", "maximum": 100, "minimum": 1, "type": "integer" }, "quality": { "description": "Mutually exclusive with `perceptualQuality`, used by default if neither is specified. The chosen quality of output images from 1-100, with 1 being the lowest quality and 100 being the highest.", "oneOf": [ { "default": 85, "maximum": 100, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } } }, "postBreakpointTransformations": { "description": "Post-processing Transformations are applied to the image after image and quality settings have been applied.", "type": "array", "items": { "description": "A transformation to apply to the image/object/text.", "x-akamai": { "file-path": "schemas/transformation-post-breakpoint.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Places a transparent image on a set background color. Specify the color in CSS hexadecimal format.", "title": "BackgroundColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value for the background.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "BackgroundColor", "description": "Identifies the type of transformation, `BackgroundColor` in this case.", "type": "string", "enum": [ "BackgroundColor" ] } }, "x-akamai": { "file-path": "schemas/t-background-color.yaml" } }, { "additionalProperties": false, "description": "Applies a Gaussian blur to the image.", "title": "Blur", "type": "object", "required": [ "transformation" ], "properties": { "sigma": { "description": "The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.", "oneOf": [ { "default": 5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Blur", "description": "Identifies the type of transformation, `Blur` in this case.", "type": "string", "enum": [ "Blur" ] } }, "x-akamai": { "file-path": "schemas/t-blur.yaml" } }, { "additionalProperties": false, "description": "Changes any color in an image within the specified volume of the HSL colorspace to transparent or semi-transparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.", "title": "ChromaKey", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120\u00b0 on the color wheel.", "oneOf": [ { "default": 120, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueFeather": { "description": "How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30\u00b0 around the Hue Tolerance.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueTolerance": { "description": "How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30\u00b0 around the specified hue.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessFeather": { "description": "How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessTolerance": { "description": "How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a color must be within 75% of the full color to full white or full black for full removal.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationFeather": { "description": "How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the Saturation Tolerance.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationTolerance": { "description": "How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "ChromaKey", "description": "Identifies the type of transformation, `ChromaKey` in this case.", "type": "string", "enum": [ "ChromaKey" ] } }, "x-akamai": { "file-path": "schemas/t-chroma-key.yaml" } }, { "additionalProperties": false, "description": "An ordered combination of transformations to perform. Use to represent a sequence of transformations as a single transformation.", "title": "Compound", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Compound", "description": "Identifies the type of transformation, `Compound` in this case.", "type": "string", "enum": [ "Compound" ] }, "transformations": { "description": "A set of nested image transformations to apply to the source image.", "type": "array", "items": { "type": "object" } } }, "x-akamai": { "file-path": "schemas/t-compound.yaml" } }, { "additionalProperties": false, "description": "Adjusts both the contrast and brightness of an image.", "title": "Contrast", "type": "object", "required": [ "transformation" ], "properties": { "brightness": { "description": "Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of `1` produces a white image. A value of `-1` produces a black image. The default value is `0`, which leaves the image unchanged. The acceptable value range is `-1.0` to `1.0`. Values outside of the acceptable range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "contrast": { "description": "Adjusts the contrast of the image. Expressed as a range from `-1` to `1`, positive values increase contrast, negative values decrease it, while `0` leaves the image unchanged. Values outside of the `-1` to `1` range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Contrast", "description": "Identifies the type of transformation, `Contrast` in this case.", "type": "string", "enum": [ "Contrast" ] } }, "x-akamai": { "file-path": "schemas/t-contrast.yaml" } }, { "additionalProperties": false, "description": "Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears _goopy_. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.", "title": "Goop", "type": "object", "required": [ "transformation" ], "properties": { "chaos": { "description": "Specifies the greatest distance control points may move from their original position. A value of `1.0` shifts control points over as far as the next one in the original grid. A value of `0.0` leaves the image unchanged. Values under `0.5` work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "density": { "description": "Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium- to large-size images.", "oneOf": [ { "default": 4, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "power": { "description": "By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldn't need to vary the default value of `2.0`.", "oneOf": [ { "default": 2, "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "seed": { "description": "Specifies your own `seed` value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used, `Goop` distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Goop", "description": "Identifies the type of transformation, `Goop` in this case.", "type": "string", "enum": [ "Goop" ] } }, "x-akamai": { "file-path": "schemas/t-goop.yaml" } }, { "additionalProperties": false, "description": "Restricts image color to shades of gray only.", "title": "Grayscale", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Grayscale", "description": "Identifies the type of transformation, `Grayscale` in this case.", "type": "string", "enum": [ "Grayscale" ] }, "type": { "default": "Rec709", "description": "The algorithm used to transform colors to grays, either `Brightness`, `Lightness`, `Rec601`, or the default `Rec709`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "Rec601", "Rec709", "Brightness", "Lightness" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-grayscale.yaml" } }, { "additionalProperties": false, "description": "Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as `Grayscale` and `MaxColors`. If you're using more than one, consider the order to apply them for the desired results.", "title": "HSL", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightness": { "description": "A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green, whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than `1.0` decrease the lightness of colors in the image. Values greater than `1.0` increase the lightness of colors in the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSL", "description": "Identifies the type of transformation, `HSL` in this case.", "type": "string", "enum": [ "HSL" ] } }, "x-akamai": { "file-path": "schemas/t-hsl.yaml" } }, { "additionalProperties": false, "description": "Identical to HSL except it replaces `lightness` with `value`. For example, if you reduce the `lightness` of a light green, almost white, image, the color turns a vibrant green. Reducing the `value` turns the image a darker color, close to gray. This happens because the original image color is very close to white.", "title": "HSV", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0.0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSV", "description": "Identifies the type of transformation, `HSV` in this case.", "type": "string", "enum": [ "HSV" ] }, "value": { "description": "A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-hsv.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the dimensions of the source image. You need to select a dimension for comparison, which is either `width` and `height` or `both`.", "title": "IfDimension", "type": "object", "required": [ "transformation", "value" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "dimension": { "description": "The dimension to use to select the transformation, either `height`, `width`, or `both`. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "default": "width", "title": "String", "type": "string", "enum": [ "width", "height", "both" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "equal": { "description": "The transformation performed only if the source image's dimension is equal to the `value` listed.", "type": "object" }, "greaterThan": { "description": "The transformation performed if the source image's dimension is greater than the `value` listed.", "type": "object" }, "lessThan": { "description": "The transformation performed if the source image's dimension is less than the `value` listed.", "type": "object" }, "transformation": { "default": "IfDimension", "description": "Identifies the type of transformation, `IfDimension` in this case.", "type": "string", "enum": [ "IfDimension" ] }, "value": { "description": "The value to compare against the source image dimension. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-if-dimension.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the orientation of the source image. Defaults to the `default` transformation if no transformation is specified for the orientation.", "title": "IfOrientation", "type": "object", "required": [ "transformation" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "landscape": { "description": "The transformation performed if the source image uses landscape orientation.", "type": "object" }, "portrait": { "description": "The transformation performed if the source image uses portrait orientation.", "type": "object" }, "square": { "description": "The transformation performed if the source image uses a square orientation.", "type": "object" }, "transformation": { "default": "IfOrientation", "description": "Identifies the type of transformation, `IfOrientation` in this case.", "type": "string", "enum": [ "IfOrientation" ] } }, "x-akamai": { "file-path": "schemas/t-if-orientation.yaml" } }, { "additionalProperties": false, "description": "Set the maximum number of colors in the image palette. Reducing the number of colors in an image can help to reduce file size.", "title": "MaxColors", "type": "object", "required": [ "transformation", "colors" ], "properties": { "colors": { "description": "The value representing the maximum number of colors to use with the source image.", "oneOf": [ { "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MaxColors", "description": "Identifies the type of transformation, `MaxColors` in this case.", "type": "string", "enum": [ "MaxColors" ] } }, "x-akamai": { "file-path": "schemas/t-max-colors.yaml" } }, { "additionalProperties": false, "description": "Flips an image horizontally, vertically, or both.", "minProperties": 2, "title": "Mirror", "type": "object", "required": [ "transformation" ], "properties": { "horizontal": { "description": "Flips the image horizontally.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Mirror", "description": "Identifies the type of transformation, `Mirror` in this case.", "title": "IfDimension", "type": "string", "enum": [ "Mirror" ] }, "vertical": { "description": "Flips the image vertically.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-mirror.yaml" } }, { "additionalProperties": false, "description": "Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color's lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.", "title": "MonoHue", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MonoHue", "description": "Identifies the type of transformation, `MonoHue` in this case.", "type": "string", "enum": [ "MonoHue" ] } }, "x-akamai": { "file-path": "schemas/t-mono-hue.yaml" } }, { "additionalProperties": false, "description": "Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.", "title": "Opacity", "type": "object", "required": [ "transformation", "opacity" ], "properties": { "opacity": { "description": "Represents alpha values on a scale of `0` to `1`. Values below `1` increase transparency, and `0` is invisible. For images that have some transparency, values above `1` increase the opacity of the transparent portions.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Opacity", "description": "Identifies the type of transformation, `Opacity` in this case.", "type": "string", "enum": [ "Opacity" ] } }, "x-akamai": { "file-path": "schemas/t-opacity.yaml" } }, { "additionalProperties": false, "description": "Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.", "title": "RemoveColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value to remove.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "feather": { "description": "The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent, creating a softer edge. The first real-time request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "tolerance": { "description": "The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.", "oneOf": [ { "default": 0.2, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RemoveColor", "description": "Identifies the type of transformation, `RemoveColor` in this case.", "type": "string", "enum": [ "RemoveColor" ] } }, "x-akamai": { "file-path": "schemas/t-remove-color.yaml" } }, { "additionalProperties": false, "description": "Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as _sharpening_ an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image & Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.", "title": "UnsharpMask", "type": "object", "required": [ "transformation" ], "properties": { "gain": { "description": "Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "sigma": { "description": "The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels, `1.0` by default. High values emphasize large details and low values emphasize small details.", "oneOf": [ { "default": 1, "format": "float", "maximum": 10, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "threshold": { "description": "Set the minimum change required to include a detail in the filter. Higher values discard more changes.", "oneOf": [ { "default": 0.05, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "UnsharpMask", "description": "Identifies the type of transformation, `UnsharpMask` in this case.", "type": "string", "enum": [ "UnsharpMask" ] } }, "x-akamai": { "file-path": "schemas/t-unsharp-mask.yaml" } } ] } }, "transformations": { "description": "Set of image transformations to apply to the source image. If unspecified, no operations are performed.", "type": "array", "items": { "description": "A transformation to apply to the image/object/text.", "x-akamai": { "file-path": "schemas/transformation.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Places a specified `image` beside the source image. The API places the `image` on a major dimension, then aligns it on the minor dimension. Transparent pixels fill any area not covered by either image.", "title": "Append", "type": "object", "required": [ "transformation", "image" ], "properties": { "gravity": { "default": "Center", "description": "Specifies where to place the `image` relative to the source image. The available values represent the eight cardinal directions (`North`, `South`, `East`, `West`, `NorthEast`, `NorthWest`, `SouthEast`, `SouthWest`) and a `Center` by default.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravityPriority": { "description": "Determines the exact placement of the `image` when `gravity` is `Center` or a diagonal. The value is either `horizontal` or `vertical`. Use `horizontal` to append an `image` east or west of the source image. This aligns the `image` on the vertical gravity component, placing `Center` gravity east. Use `vertical` to append an `image` north or south of the source image. This aligns the `image` on the horizontal gravity component, placing `Center` gravity south.", "oneOf": [ { "default": "horizontal", "title": "String enum", "type": "string", "enum": [ "horizontal", "vertical" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "image": { "x-akamai": { "file-path": "schemas/image-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "A rectangular box, with a specified color and applied transformation.", "title": "Box image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the box, not the color of the edges of the box. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Box", "description": "Identifies the type of image, `Box` in this case.", "type": "string", "enum": [ "Box" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-box.yaml" } }, { "additionalProperties": false, "description": "A simple, solid, monochrome circle of a specified diameter on a transparent background.", "title": "Circle image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "diameter": { "description": "The diameter of the circle. The diameter will be the width and the height of the image in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Circle", "description": "Identifies the type of image, `Circle` in this case.", "type": "string", "enum": [ "Circle" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-circle.yaml" } }, { "additionalProperties": false, "description": "A snippet of text. Defines the font family, font size, fill color, outline stroke width, and outline color.", "title": "Text image", "type": "object", "required": [ "type", "text" ], "properties": { "fill": { "description": "The main fill color of the text.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "size": { "description": "The size in pixels to render the text.", "oneOf": [ { "default": 72, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "stroke": { "description": "The color of the outline of the text.", "oneOf": [ { "default": "#FFF", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "strokeSize": { "description": "The thickness in points of the outline of the text.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "text": { "description": "The line of text to render.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Text", "description": "Identifies the type of image, `Text` in this case.", "type": "string", "enum": [ "Text" ] }, "typeface": { "description": "The font family to apply to the text image. This may be the URL of a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.", "oneOf": [ { "default": "DejaVuSans", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-text.yaml" } }, { "additionalProperties": false, "description": "An image loaded from a URL.", "title": "URL image", "type": "object", "required": [ "url" ], "properties": { "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "URL", "description": "Identifies the type of image, `URL` in this case.", "type": "string", "enum": [ "URL" ] }, "url": { "description": "The URL of the image.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-url.yaml" } } ] }, "preserveMinorDimension": { "description": "Whether to preserve the source image's minor dimension, `false` by default. The minor dimension is the dimension opposite the dimension that the appending `image` is placed. For example, the dimensions of the source image are 100 × 100 pixels. The dimensions of the appending `image` are 50 × 150 pixels. The `gravity` is set to `East`. This makes the major dimension horizontal and the source image's minor dimension vertical. To preserve the source image's minor dimension at 100 pixels, the `preserveMinorDimension` is set to `true`. As a result of the append, the major dimension expanded with the appended image to 150 pixels. The source image's minor dimension was maintained at 100 pixels. The total combined dimension of the image is 150 × 100 pixels.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Append", "description": "Identifies the type of transformation, `Append` in this case.", "type": "string", "enum": [ "Append" ] } }, "x-akamai": { "file-path": "schemas/t-append.yaml" } }, { "additionalProperties": false, "description": "Changes the height or width of an image, either by cropping or expanding the area, to an aspect ratio of your choosing.", "title": "AspectCrop", "type": "object", "required": [ "transformation" ], "properties": { "allowExpansion": { "description": "Increases the size of the image canvas to achieve the requested aspect ratio instead of cropping the image. Use the Horizontal Offset and Vertical Offset settings to determine where to add the fully transparent pixels on the expanded image canvas.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height term of the aspect ratio to crop.", "oneOf": [ { "default": 1, "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "AspectCrop", "description": "Identifies the type of transformation, `AspectCrop` in this case.", "type": "string", "enum": [ "AspectCrop" ] }, "width": { "description": "The width term of the aspect ratio to crop.", "oneOf": [ { "default": 1, "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "xPosition": { "description": "Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.", "oneOf": [ { "default": 0.5, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "description": "Specifies the horizontal portion of the image you want to keep when cropping by aspect ratio crop. When using `allowExpansion`, this setting defines the horizontal position of the image on the new expanded image canvas.", "oneOf": [ { "default": 0.5, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-aspect-crop.yaml" } }, { "additionalProperties": false, "description": "Places a transparent image on a set background color. Specify the color in CSS hexadecimal format.", "title": "BackgroundColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value for the background.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "BackgroundColor", "description": "Identifies the type of transformation, `BackgroundColor` in this case.", "type": "string", "enum": [ "BackgroundColor" ] } }, "x-akamai": { "file-path": "schemas/t-background-color.yaml" } }, { "additionalProperties": false, "description": "Applies a Gaussian blur to the image.", "title": "Blur", "type": "object", "required": [ "transformation" ], "properties": { "sigma": { "description": "The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.", "oneOf": [ { "default": 5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Blur", "description": "Identifies the type of transformation, `Blur` in this case.", "type": "string", "enum": [ "Blur" ] } }, "x-akamai": { "file-path": "schemas/t-blur.yaml" } }, { "additionalProperties": false, "description": "Changes any color in an image within the specified volume of the HSL colorspace to transparent or semi-transparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.", "title": "ChromaKey", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120\u00b0 on the color wheel.", "oneOf": [ { "default": 120, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueFeather": { "description": "How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30\u00b0 around the Hue Tolerance.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueTolerance": { "description": "How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30\u00b0 around the specified hue.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessFeather": { "description": "How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessTolerance": { "description": "How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a color must be within 75% of the full color to full white or full black for full removal.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationFeather": { "description": "How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the Saturation Tolerance.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationTolerance": { "description": "How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "ChromaKey", "description": "Identifies the type of transformation, `ChromaKey` in this case.", "type": "string", "enum": [ "ChromaKey" ] } }, "x-akamai": { "file-path": "schemas/t-chroma-key.yaml" } }, { "additionalProperties": false, "description": "Applies another image to the source image, either as an overlay or an underlay. The image that's underneath is visible in areas that are beyond the edges of the top image or that are less than 100% opaque. A common use of an overlay composite is to add a watermark.", "title": "Composite", "type": "object", "required": [ "transformation", "image" ], "properties": { "gravity": { "default": "NorthWest", "description": "Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "image": { "x-akamai": { "file-path": "schemas/image-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "A rectangular box, with a specified color and applied transformation.", "title": "Box image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the box, not the color of the edges of the box. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Box", "description": "Identifies the type of image, `Box` in this case.", "type": "string", "enum": [ "Box" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-box.yaml" } }, { "additionalProperties": false, "description": "A simple, solid, monochrome circle of a specified diameter on a transparent background.", "title": "Circle image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "diameter": { "description": "The diameter of the circle. The diameter will be the width and the height of the image in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Circle", "description": "Identifies the type of image, `Circle` in this case.", "type": "string", "enum": [ "Circle" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-circle.yaml" } }, { "additionalProperties": false, "description": "A snippet of text. Defines the font family, font size, fill color, outline stroke width, and outline color.", "title": "Text image", "type": "object", "required": [ "type", "text" ], "properties": { "fill": { "description": "The main fill color of the text.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "size": { "description": "The size in pixels to render the text.", "oneOf": [ { "default": 72, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "stroke": { "description": "The color of the outline of the text.", "oneOf": [ { "default": "#FFF", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "strokeSize": { "description": "The thickness in points of the outline of the text.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "text": { "description": "The line of text to render.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Text", "description": "Identifies the type of image, `Text` in this case.", "type": "string", "enum": [ "Text" ] }, "typeface": { "description": "The font family to apply to the text image. This may be the URL of a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.", "oneOf": [ { "default": "DejaVuSans", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-text.yaml" } }, { "additionalProperties": false, "description": "An image loaded from a URL.", "title": "URL image", "type": "object", "required": [ "url" ], "properties": { "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "URL", "description": "Identifies the type of image, `URL` in this case.", "type": "string", "enum": [ "URL" ] }, "url": { "description": "The URL of the image.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-url.yaml" } } ] }, "placement": { "description": "Where to place the specified image, either `Over` or `Under` the existing image. Watermarks are usually applied over. Backgrounds are usually applied under.", "oneOf": [ { "default": "Over", "title": "String enum", "type": "string", "enum": [ "Over", "Under", "Mask", "Stencil" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "scale": { "description": "A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the `scaleDimension` to calculate the `scale` from the source image's width or height.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "scaleDimension": { "description": "The dimension, either `width` or `height`, of the source image to scale.", "oneOf": [ { "default": "width", "title": "String enum", "type": "string", "enum": [ "width", "height" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Composite", "description": "Identifies the type of transformation, `Composite` in this case.", "type": "string", "enum": [ "Composite" ] }, "xPosition": { "description": "The x-axis position of the image to apply.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "default": 0, "description": "The y-axis position of the image to apply.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-composite.yaml" } }, { "additionalProperties": false, "description": "An ordered combination of transformations to perform. Use to represent a sequence of transformations as a single transformation.", "title": "Compound", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Compound", "description": "Identifies the type of transformation, `Compound` in this case.", "type": "string", "enum": [ "Compound" ] }, "transformations": { "description": "A set of nested image transformations to apply to the source image.", "type": "array", "items": { "type": "object" } } }, "x-akamai": { "file-path": "schemas/t-compound.yaml" } }, { "additionalProperties": false, "description": "Adjusts both the contrast and brightness of an image.", "title": "Contrast", "type": "object", "required": [ "transformation" ], "properties": { "brightness": { "description": "Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of `1` produces a white image. A value of `-1` produces a black image. The default value is `0`, which leaves the image unchanged. The acceptable value range is `-1.0` to `1.0`. Values outside of the acceptable range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "contrast": { "description": "Adjusts the contrast of the image. Expressed as a range from `-1` to `1`, positive values increase contrast, negative values decrease it, while `0` leaves the image unchanged. Values outside of the `-1` to `1` range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Contrast", "description": "Identifies the type of transformation, `Contrast` in this case.", "type": "string", "enum": [ "Contrast" ] } }, "x-akamai": { "file-path": "schemas/t-contrast.yaml" } }, { "additionalProperties": false, "description": "Crops an image.", "title": "Crop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "allowExpansion": { "description": "If cropping an area outside of the existing canvas, expands the image canvas.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "NorthWest", "description": "Frame of reference for X and Y positions.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The number of pixels to crop along the y-axis.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Crop", "description": "Identifies the type of transformation, `Crop` in this case.", "type": "string", "enum": [ "Crop" ] }, "width": { "description": "The number of pixels to crop along the x-axis.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "xPosition": { "description": "The x-axis position of the image to crop from.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "description": "The y-axis position of the image to crop from.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-crop.yaml" } }, { "additionalProperties": false, "description": "Applies a method to detect faces in the source image and applies the rectangular crop on either the `biggest` face or `all` of the faces detected. Image & Video Manager tries to preserve faces in the image instead of using specified crop coordinates.", "title": "FaceCrop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "algorithm": { "description": "Specifies the type of algorithm used to detect faces in the image, either `cascade` for the cascade classifier algorithm or `dnn` for the deep neural network algorithm, `cascade` by default.", "oneOf": [ { "default": "cascade", "title": "String enum", "type": "string", "enum": [ "cascade", "dnn" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "confidence": { "description": "With `algorithm` set to `dnn`, specifies the minimum confidence needed to detect faces in the image. Values range from `0` to `1` for increased confidence, and possibly fewer faces detected.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "failGravity": { "default": "Center", "description": "Controls placement of the crop if Image & Video Manager does not detect any faces in the image. Directions are relative to the edges of the image being transformed.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "focus": { "description": "Distinguishes the faces detected, either `biggestFace` or `allFaces` to place the crop rectangle around the full set of faces. This is `all` by default.", "oneOf": [ { "default": "allFaces", "title": "String enum", "type": "string", "enum": [ "allFaces", "biggestFace" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "Center", "description": "Controls placement of the crop. Directions are relative to the face, plus padding.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the output image in pixels relative to the specified `style` value.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "The padding ratio based on the dimensions of the biggest face detected, `0.5` by default. Larger values increase padding.", "oneOf": [ { "default": 0.5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the faces detected in the source image, `zoom` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` places a raw crop around the faces, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and faces as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the faces, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "zoom", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FaceCrop", "description": "Identifies the type of transformation, `FaceCrop` in this case.", "type": "string", "enum": [ "FaceCrop" ] }, "width": { "description": "The width of the output image in pixels relative to the specified `style` value.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-face-crop.yaml" } }, { "additionalProperties": false, "description": "Identifies prominent features of the source image, then crops around as many of these features as possible relative to the specified `width` and `height` values.", "title": "FeatureCrop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "failGravity": { "default": "Center", "description": "Controls placement of the crop if Image & Video Manager does not detect any features in the image. Directions are relative to the edges of the image being transformed.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "featureRadius": { "description": "The size in pixels of the important features to search for. If identified, two features never appear closer together than this value, `8.0` by default.", "oneOf": [ { "default": 8, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "Center", "description": "Controls placement of the crop. Directions are relative to the region of interest plus padding.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "maxFeatures": { "description": "The maximum number of features to identify as important features, `32` by default. The strongest features are always chosen.", "oneOf": [ { "default": 32, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "minFeatureQuality": { "description": "Determines the minimum quality level of the feature identified. To consider a feature important, the feature needs to surpass this value. Image & Video Manager measures quality on a scale from `0` for the lowest quality to `1` for the highest quality, `.1` by default.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "Adds space around the region of interest. The amount of padding added is directly related to the size of the bounding box of the selected features. Specifically, the region of interest is expanded in all directions by the largest dimension of the bounding box of the selected features multiplied by this value.", "oneOf": [ { "default": 0.05, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the features identified in the source image, `fill` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` performs a raw crop around the features, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and features as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the features, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "zoom", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FeatureCrop", "description": "Identifies the type of transformation, `FeatureCrop` in this case.", "type": "string", "enum": [ "FeatureCrop" ] }, "width": { "description": "The width in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-feature-crop.yaml" } }, { "additionalProperties": false, "description": "Resizes an image to fit within a specific size box and then uses a fill of that same image to cover any transparent space at the edges. By default the fill image has a Blur transformation with a sigma value of 8 applied. Customize the transformation using the `fillTransformation` parameter.", "title": "FitAndFill", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "fillTransformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "height": { "description": "The height value of the resized image.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FitAndFill", "description": "Identifies the type of transformation, `FitAndFill` in this case.", "type": "string", "enum": [ "FitAndFill" ] }, "width": { "description": "The width value of the resized image.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-fit-and-fill.yaml" } }, { "additionalProperties": false, "description": "Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears _goopy_. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.", "title": "Goop", "type": "object", "required": [ "transformation" ], "properties": { "chaos": { "description": "Specifies the greatest distance control points may move from their original position. A value of `1.0` shifts control points over as far as the next one in the original grid. A value of `0.0` leaves the image unchanged. Values under `0.5` work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "density": { "description": "Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium- to large-size images.", "oneOf": [ { "default": 4, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "power": { "description": "By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldn't need to vary the default value of `2.0`.", "oneOf": [ { "default": 2, "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "seed": { "description": "Specifies your own `seed` value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used, `Goop` distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Goop", "description": "Identifies the type of transformation, `Goop` in this case.", "type": "string", "enum": [ "Goop" ] } }, "x-akamai": { "file-path": "schemas/t-goop.yaml" } }, { "additionalProperties": false, "description": "Restricts image color to shades of gray only.", "title": "Grayscale", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Grayscale", "description": "Identifies the type of transformation, `Grayscale` in this case.", "type": "string", "enum": [ "Grayscale" ] }, "type": { "default": "Rec709", "description": "The algorithm used to transform colors to grays, either `Brightness`, `Lightness`, `Rec601`, or the default `Rec709`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "Rec601", "Rec709", "Brightness", "Lightness" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-grayscale.yaml" } }, { "additionalProperties": false, "description": "Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as `Grayscale` and `MaxColors`. If you're using more than one, consider the order to apply them for the desired results.", "title": "HSL", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightness": { "description": "A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green, whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than `1.0` decrease the lightness of colors in the image. Values greater than `1.0` increase the lightness of colors in the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSL", "description": "Identifies the type of transformation, `HSL` in this case.", "type": "string", "enum": [ "HSL" ] } }, "x-akamai": { "file-path": "schemas/t-hsl.yaml" } }, { "additionalProperties": false, "description": "Identical to HSL except it replaces `lightness` with `value`. For example, if you reduce the `lightness` of a light green, almost white, image, the color turns a vibrant green. Reducing the `value` turns the image a darker color, close to gray. This happens because the original image color is very close to white.", "title": "HSV", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0.0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSV", "description": "Identifies the type of transformation, `HSV` in this case.", "type": "string", "enum": [ "HSV" ] }, "value": { "description": "A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-hsv.yaml" } }, { "additionalProperties": false, "description": "Apply artistic transformations to images quickly and dynamically by specifying transformations with a query string appended to the image URL.\n- transformation\n- query\n- allowedTransformations", "title": "ImQuery", "type": "object", "properties": { "allowedTransformations": { "description": "Specifies the transformations that can be applied using the query string parameter.", "type": "array", "items": { "type": "string", "enum": [ "Append", "AspectCrop", "BackgroundColor", "Blur", "Composite", "Contrast", "Crop", "ChromaKey", "FaceCrop", "FeatureCrop", "FitAndFill", "Goop", "Grayscale", "HSL", "HSV", "MaxColors", "Mirror", "MonoHue", "Opacity", "RegionOfInterestCrop", "RelativeCrop", "RemoveColor", "Resize", "Rotate", "Scale", "Shear", "Trim", "UnsharpMask", "IfDimension", "IfOrientation" ] } }, "query": { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } }, "transformation": { "default": "ImQuery", "description": "Identifies the type of transformation, `ImQuery` in this case.", "type": "string", "enum": [ "ImQuery" ] } }, "x-akamai": { "file-path": "schemas/t-im-query.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the dimensions of the source image. You need to select a dimension for comparison, which is either `width` and `height` or `both`.", "title": "IfDimension", "type": "object", "required": [ "transformation", "value" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "dimension": { "description": "The dimension to use to select the transformation, either `height`, `width`, or `both`. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "default": "width", "title": "String", "type": "string", "enum": [ "width", "height", "both" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "equal": { "description": "The transformation performed only if the source image's dimension is equal to the `value` listed.", "type": "object" }, "greaterThan": { "description": "The transformation performed if the source image's dimension is greater than the `value` listed.", "type": "object" }, "lessThan": { "description": "The transformation performed if the source image's dimension is less than the `value` listed.", "type": "object" }, "transformation": { "default": "IfDimension", "description": "Identifies the type of transformation, `IfDimension` in this case.", "type": "string", "enum": [ "IfDimension" ] }, "value": { "description": "The value to compare against the source image dimension. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-if-dimension.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the orientation of the source image. Defaults to the `default` transformation if no transformation is specified for the orientation.", "title": "IfOrientation", "type": "object", "required": [ "transformation" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "landscape": { "description": "The transformation performed if the source image uses landscape orientation.", "type": "object" }, "portrait": { "description": "The transformation performed if the source image uses portrait orientation.", "type": "object" }, "square": { "description": "The transformation performed if the source image uses a square orientation.", "type": "object" }, "transformation": { "default": "IfOrientation", "description": "Identifies the type of transformation, `IfOrientation` in this case.", "type": "string", "enum": [ "IfOrientation" ] } }, "x-akamai": { "file-path": "schemas/t-if-orientation.yaml" } }, { "additionalProperties": false, "description": "Set the maximum number of colors in the image palette. Reducing the number of colors in an image can help to reduce file size.", "title": "MaxColors", "type": "object", "required": [ "transformation", "colors" ], "properties": { "colors": { "description": "The value representing the maximum number of colors to use with the source image.", "oneOf": [ { "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MaxColors", "description": "Identifies the type of transformation, `MaxColors` in this case.", "type": "string", "enum": [ "MaxColors" ] } }, "x-akamai": { "file-path": "schemas/t-max-colors.yaml" } }, { "additionalProperties": false, "description": "Flips an image horizontally, vertically, or both.", "minProperties": 2, "title": "Mirror", "type": "object", "required": [ "transformation" ], "properties": { "horizontal": { "description": "Flips the image horizontally.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Mirror", "description": "Identifies the type of transformation, `Mirror` in this case.", "title": "IfDimension", "type": "string", "enum": [ "Mirror" ] }, "vertical": { "description": "Flips the image vertically.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-mirror.yaml" } }, { "additionalProperties": false, "description": "Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color's lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.", "title": "MonoHue", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MonoHue", "description": "Identifies the type of transformation, `MonoHue` in this case.", "type": "string", "enum": [ "MonoHue" ] } }, "x-akamai": { "file-path": "schemas/t-mono-hue.yaml" } }, { "additionalProperties": false, "description": "Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.", "title": "Opacity", "type": "object", "required": [ "transformation", "opacity" ], "properties": { "opacity": { "description": "Represents alpha values on a scale of `0` to `1`. Values below `1` increase transparency, and `0` is invisible. For images that have some transparency, values above `1` increase the opacity of the transparent portions.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Opacity", "description": "Identifies the type of transformation, `Opacity` in this case.", "type": "string", "enum": [ "Opacity" ] } }, "x-akamai": { "file-path": "schemas/t-opacity.yaml" } }, { "additionalProperties": false, "description": "Crops to a region around a specified area of interest relative to the specified `width` and `height` values.", "title": "RegionOfInterestCrop", "type": "object", "required": [ "transformation", "width", "height", "regionOfInterest" ], "properties": { "gravity": { "default": "Center", "description": "The placement of the crop area relative to the specified area of interest.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "regionOfInterest": { "x-akamai": { "file-path": "schemas/shape-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Defines a circle with a specified `radius` from its `center` point.", "title": "Circle", "type": "object", "required": [ "center", "radius" ], "properties": { "center": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, "radius": { "description": "The radius of the circle measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-circle.yaml" } }, { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, { "additionalProperties": false, "description": "Defines a polygon from a series of connected points.", "title": "Polygon", "type": "object", "required": [ "points" ], "properties": { "points": { "description": "Series of PointShapeType objects. The last and first points connect to close the shape automatically.", "type": "array", "items": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } } } }, "x-akamai": { "file-path": "schemas/shape-type-polygon.yaml" } }, { "additionalProperties": false, "description": "Defines a rectangle's `width` and `height` relative to an `anchor` point at the top left corner.", "title": "Rectangle", "type": "object", "required": [ "anchor", "width", "height" ], "properties": { "anchor": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, "height": { "description": "Extends the rectangle down from the `anchor` point.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "width": { "description": "Extends the rectangle right from the `anchor` point.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-rectangle.yaml" } }, { "additionalProperties": false, "description": "Identifies a combined shape based on a set of other shapes.", "title": "Union", "type": "object", "required": [ "shapes" ], "properties": { "shapes": { "description": "A nested shape used to describe a more complex shape.", "type": "array", "items": { "description": "A nested shape used to describe a more complex shape.", "title": "Nested shape", "type": "object", "x-akamai": { "file-path": "schemas/shape-type-nested.yaml" } } } }, "x-akamai": { "file-path": "schemas/shape-type-union.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the specified area of interest in the source image, `zoom` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` places raw crop around the point of interest, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and point of interest as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the point of interest, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "fill", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RegionOfInterestCrop", "description": "Identifies the type of transformation, `RegionOfInterestCrop` in this case.", "type": "string", "enum": [ "RegionOfInterestCrop" ] }, "width": { "description": "The width in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-region-of-interest-crop.yaml" } }, { "additionalProperties": false, "description": "Shrinks or expands an image relative to the image's specified dimensions. Image & Video Manager fills the expanded areas with transparency. Positive values shrink the side, while negative values expand it.", "title": "RelativeCrop", "type": "object", "required": [ "transformation" ], "properties": { "east": { "description": "The number of pixels to shrink or expand the right side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "north": { "description": "The number of pixels to shrink or expand the top side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "south": { "description": "The number of pixels to shrink or expand the bottom side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RelativeCrop", "description": "Identifies the type of transformation, `RelativeCrop` in this case.", "type": "string", "enum": [ "RelativeCrop" ] }, "west": { "description": "The number of pixels to shrink or expand the left side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-relative-crop.yaml" } }, { "additionalProperties": false, "description": "Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.", "title": "RemoveColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value to remove.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "feather": { "description": "The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent, creating a softer edge. The first real-time request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "tolerance": { "description": "The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.", "oneOf": [ { "default": 0.2, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RemoveColor", "description": "Identifies the type of transformation, `RemoveColor` in this case.", "type": "string", "enum": [ "RemoveColor" ] } }, "x-akamai": { "file-path": "schemas/t-remove-color.yaml" } }, { "additionalProperties": false, "description": "Resizes an image to a particular, absolute dimension. If you don't enter a `width` or a `height`, the image is resized with the `fit` aspect preservation mode, which selects a value for the missing dimension that preserves the image's aspect.", "title": "Resize", "type": "object", "required": [ "transformation" ], "properties": { "aspect": { "description": "Preserves the aspect ratio. Select `fit` to make the image fit entirely within the selected width and height. When using `fit`, the resulting image has the largest possible size for the specified dimensions. Select `fill` to size the image so it both completely fills the dimensions and has the smallest possible file size. Otherwise `ignore` changes the original aspect ratio to fit within an arbitrarily shaped rectangle.", "oneOf": [ { "default": "fit", "title": "String enum", "type": "string", "enum": [ "fit", "fill", "ignore" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height to resize the source image to. Must be set if `width` is not specified.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Resize", "description": "Identifies the type of transformation, `Resize` in this case.", "type": "string", "enum": [ "Resize" ] }, "type": { "description": "Sets constraints for the image resize. Select `normal` to resize in all cases, either increasing or decreasing the dimensions. Select `downsize` to ignore this transformation if the result would be larger than the original. Select `upsize` to ignore this transformation if the result would be smaller.", "oneOf": [ { "default": "normal", "title": "String enum", "type": "string", "enum": [ "normal", "upsize", "downsize" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "width": { "description": "The width to resize the source image to. Must be set if `height` is not specified.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-resize.yaml" } }, { "additionalProperties": false, "description": "Rotate the image around its center by indicating the degrees of rotation.", "title": "Rotate", "type": "object", "required": [ "transformation", "degrees" ], "properties": { "degrees": { "description": "The value to rotate the image by. Positive values rotate clockwise, while negative values rotate counter-clockwise.", "oneOf": [ { "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Rotate", "description": "Identifies the type of transformation, `Rotate` in this case.", "type": "string", "enum": [ "Rotate" ] } }, "x-akamai": { "file-path": "schemas/t-rotate.yaml" } }, { "additionalProperties": false, "description": "Changes the image's size to different dimensions relative to its starting size.", "title": "Scale", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "height": { "description": "Scaling factor for the input height to determine the output height of the image, where values between `0` and `1` decrease size. Image dimensions need to be non-zero positive numbers.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Scale", "description": "Identifies the type of transformation, `Scale` in this case.", "type": "string", "enum": [ "Scale" ] }, "width": { "description": "Scaling factor for the input width to determine the output width of the image, where `1` leaves the width unchanged. Values greater than `1` increase the image size. Image dimensions need to be non-zero positive numbers.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-scale.yaml" } }, { "additionalProperties": false, "description": "Slants an image into a parallelogram, as a percent of the starting dimension as represented in decimal format. You need to specify at least one axis property. Transparent pixels fill empty areas around the sheared image as needed, so it's often useful to use a `BackgroundColor` transformation for these areas.", "title": "Shear", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Shear", "description": "Identifies the type of transformation, `Shear` in this case.", "type": "string", "enum": [ "Shear" ] }, "xShear": { "description": "The amount to shear along the x-axis, measured in multiples of the image's width. Required if `yShear` is not specified.", "oneOf": [ { "default": 0, "format": "float", "maximum": 5, "minimum": -5, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yShear": { "description": "The amount to shear along the y-axis, measured in multiples of the image's height. Required if `xShear` is not specified.", "oneOf": [ { "default": 0, "format": "float", "maximum": 5, "minimum": -5, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-shear.yaml" } }, { "additionalProperties": false, "description": "Automatically crops uniform backgrounds from the edges of an image.", "title": "Trim", "type": "object", "required": [ "transformation" ], "properties": { "fuzz": { "description": "The fuzz tolerance of the trim, a value between `0` and `1` that determines the acceptable amount of background variation before trimming stops.", "oneOf": [ { "default": 0.08, "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "The amount of padding in pixels to add to the trimmed image.", "oneOf": [ { "default": 0, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Trim", "description": "Identifies the type of transformation, `Trim` in this case.", "type": "string", "enum": [ "Trim" ] } }, "x-akamai": { "file-path": "schemas/t-trim.yaml" } }, { "additionalProperties": false, "description": "Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as _sharpening_ an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image & Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.", "title": "UnsharpMask", "type": "object", "required": [ "transformation" ], "properties": { "gain": { "description": "Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "sigma": { "description": "The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels, `1.0` by default. High values emphasize large details and low values emphasize small details.", "oneOf": [ { "default": 1, "format": "float", "maximum": 10, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "threshold": { "description": "Set the minimum change required to include a detail in the filter. Higher values discard more changes.", "oneOf": [ { "default": 0.05, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "UnsharpMask", "description": "Identifies the type of transformation, `UnsharpMask` in this case.", "type": "string", "enum": [ "UnsharpMask" ] } }, "x-akamai": { "file-path": "schemas/t-unsharp-mask.yaml" } } ] } }, "video": { "default": false, "description": "Identifies this as an image policy.", "readOnly": true, "type": "boolean", "enum": [ false ] } }, "x-akamai": { "file-path": "schemas/policy-image-specific.yaml" } }, { "additionalProperties": false, "properties": { "breakpoints": { "additionalProperties": false, "description": "The breakpoint widths (in pixels) to use to create derivative images or videos.", "title": "Breakpoints", "type": "object", "properties": { "widths": { "description": "Specifies each integer breakpoint width value.", "minItems": 1, "type": "array", "items": { "maximum": 5000, "minimum": 1, "type": "integer" } } } }, "dateCreated": { "description": "Date this policy version was created in ISO 8601 extended notation format.", "readOnly": true, "type": "string" }, "hosts": { "description": "Hosts that are allowed for image or video URLs within transformations or variables.", "type": "array", "items": { "type": "string" } }, "id": { "description": "Unique identifier for a policy which can be up to 64 alphanumeric characters and can include underscores or dashes.", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "readOnly": true, "type": "string" }, "previousVersion": { "description": "The previous version number of this policy version.", "readOnly": true, "type": "integer" }, "rolloutDuration": { "default": 3600, "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. This value has no effect on the staging network.", "maximum": 604800, "minimum": 3600, "type": "integer", "writeOnly": true }, "rolloutInfo": { "additionalProperties": false, "description": "Contains information about policy rollout start and completion times.", "readOnly": true, "type": "object", "properties": { "endTime": { "description": "The estimated time that rollout for this policy will end in UNIX timestamp format.", "type": "integer" }, "rolloutDuration": { "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. Policies on the staging network deploy as quickly as possible without rollout. For staging policies this value will always be 1.", "maximum": 604800, "minimum": 3600, "type": "integer" }, "startTime": { "description": "The estimated time that rollout for this policy will begin in UNIX timestamp format.", "type": "integer" } } }, "user": { "description": "The user who created this policy version.", "readOnly": true, "type": "string" }, "variables": { "description": "Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as an Inline Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.", "type": "array", "items": { "additionalProperties": false, "title": "Variable", "type": "object", "required": [ "name", "type", "defaultValue" ], "properties": { "defaultValue": { "description": "The default value of the variable if no query parameter is provided. It needs to be one of the `enumOptions` if any are provided.", "type": "string" }, "enumOptions": { "description": "Optionally limits the set of possible values for a variable. References to an enum `id` insert a corresponding `value`.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "id", "value" ], "properties": { "id": { "description": "The unique identifier for each enum value, up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "value": { "description": "The value of the variable when the `id` is provided.", "type": "string" } } } }, "name": { "description": "The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "postfix": { "description": "A postfix added to the value provided for the variable, or to the default value.", "type": "string" }, "prefix": { "description": "A prefix added to the value provided for the variable, or to the default value.", "type": "string" }, "type": { "description": "The type of value for the variable, either `bool`, `number`, `url`, `color`, `gravity`, `placement`, `scaleDimension`, `grayscaleType`, `aspect`, `resizeType`, `dimension`, `perceptualQuality`, `string`, or `focus`.", "type": "string", "enum": [ "bool", "number", "url", "color", "gravity", "placement", "scaleDimension", "grayscaleType", "aspect", "resizeType", "dimension", "perceptualQuality", "string", "focus" ] } }, "x-akamai": { "file-path": "schemas/variable.yaml" } } }, "version": { "description": "The version number of this policy version.", "readOnly": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/policy-shared.yaml" } } ] }, { "description": "Specifies details for each policy such as video size.", "title": "Video policy", "type": "object", "x-akamai": { "file-path": "schemas/policy-video.yaml" }, "allOf": [ { "additionalProperties": false, "type": "object", "properties": { "output": { "additionalProperties": false, "description": "Dictates the output quality for each resized video.", "title": "Output", "type": "object", "properties": { "perceptualQuality": { "description": "The quality of derivative videos. High preserves video quality with reduced byte savings while low reduces video quality to increase byte savings.", "oneOf": [ { "default": "medium", "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "placeholderVideoUrl": { "description": "Allows you to add a specific placeholder video that appears when a user first requests a video, but before Image & Video Manager processes the video. If not specified the original video plays during the processing time.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "videoAdaptiveQuality": { "description": "Overrides the quality of video to serve when Image & Video Manager detects a slow connection with a round-trip time (RTT) of 300 ms. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of videos for users with faster connections.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } } }, "video": { "default": true, "description": "Identifies this as a video policy.", "readOnly": true, "type": "boolean", "enum": [ true ] } }, "x-akamai": { "file-path": "schemas/policy-video-specific.yaml" } }, { "additionalProperties": false, "properties": { "breakpoints": { "additionalProperties": false, "description": "The breakpoint widths (in pixels) to use to create derivative images or videos.", "title": "Breakpoints", "type": "object", "properties": { "widths": { "description": "Specifies each integer breakpoint width value.", "minItems": 1, "type": "array", "items": { "maximum": 5000, "minimum": 1, "type": "integer" } } } }, "dateCreated": { "description": "Date this policy version was created in ISO 8601 extended notation format.", "readOnly": true, "type": "string" }, "hosts": { "description": "Hosts that are allowed for image or video URLs within transformations or variables.", "type": "array", "items": { "type": "string" } }, "id": { "description": "Unique identifier for a policy which can be up to 64 alphanumeric characters and can include underscores or dashes.", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "readOnly": true, "type": "string" }, "previousVersion": { "description": "The previous version number of this policy version.", "readOnly": true, "type": "integer" }, "rolloutDuration": { "default": 3600, "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. This value has no effect on the staging network.", "maximum": 604800, "minimum": 3600, "type": "integer", "writeOnly": true }, "rolloutInfo": { "additionalProperties": false, "description": "Contains information about policy rollout start and completion times.", "readOnly": true, "type": "object", "properties": { "endTime": { "description": "The estimated time that rollout for this policy will end in UNIX timestamp format.", "type": "integer" }, "rolloutDuration": { "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. Policies on the staging network deploy as quickly as possible without rollout. For staging policies this value will always be 1.", "maximum": 604800, "minimum": 3600, "type": "integer" }, "startTime": { "description": "The estimated time that rollout for this policy will begin in UNIX timestamp format.", "type": "integer" } } }, "user": { "description": "The user who created this policy version.", "readOnly": true, "type": "string" }, "variables": { "description": "Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as an Inline Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.", "type": "array", "items": { "additionalProperties": false, "title": "Variable", "type": "object", "required": [ "name", "type", "defaultValue" ], "properties": { "defaultValue": { "description": "The default value of the variable if no query parameter is provided. It needs to be one of the `enumOptions` if any are provided.", "type": "string" }, "enumOptions": { "description": "Optionally limits the set of possible values for a variable. References to an enum `id` insert a corresponding `value`.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "id", "value" ], "properties": { "id": { "description": "The unique identifier for each enum value, up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "value": { "description": "The value of the variable when the `id` is provided.", "type": "string" } } } }, "name": { "description": "The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "postfix": { "description": "A postfix added to the value provided for the variable, or to the default value.", "type": "string" }, "prefix": { "description": "A prefix added to the value provided for the variable, or to the default value.", "type": "string" }, "type": { "description": "The type of value for the variable, either `bool`, `number`, `url`, `color`, `gravity`, `placement`, `scaleDimension`, `grayscaleType`, `aspect`, `resizeType`, `dimension`, `perceptualQuality`, `string`, or `focus`.", "type": "string", "enum": [ "bool", "number", "url", "color", "gravity", "placement", "scaleDimension", "grayscaleType", "aspect", "resizeType", "dimension", "perceptualQuality", "string", "focus" ] } }, "x-akamai": { "file-path": "schemas/variable.yaml" } } }, "version": { "description": "The version number of this policy version.", "readOnly": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/policy-shared.yaml" } } ] } ] } }, "totalItems": { "description": "The total number of policies returned.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/policy-array.yaml" } } } } } }, "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "__Enum__ Network environment to execute the API request on.", "example": "{{network}}", "in": "path", "name": "network", "required": true, "schema": { "example": "production", "type": "string", "enum": [ "staging", "production" ] }, "x-akamai": { "file-path": "parameters/network-path.yaml" } }, { "description": "Unique identifier for the Akamai Contract containing the policy sets. Required if you have access to more than one contract with Image & Video Manager.", "example": "{{Contract}}", "in": "header", "name": "Contract", "required": false, "schema": { "example": "A-CCT7890", "type": "string" }, "x-akamai": { "file-path": "parameters/contractId-header.yaml" } }, { "description": "Unique identifier for the Image & Video Manager policy set.", "example": "{{Policy-Set}}", "in": "header", "name": "Policy-Set", "required": true, "schema": { "example": "053eef00-9f85-11ec-a51d-47eefacf795d", "type": "string" }, "x-akamai": { "file-path": "parameters/policySetId-header.yaml" } } ] }, "/network/{network}/policies/history/{policyId}": { "get": { "description": "Returns the policy history by policy ID. This operation returns the full state of the policy at various points in time. Time stamps are in ISO 8601 extended notation format.", "operationId": "get-policy-history", "summary": "Get policy history", "tags": [ "Policy history" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Image & Video Manager API", "url": "https://techdocs.akamai.com/ivm/reference/get-policy-history" }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "example": { "itemKind": "POLICIESLOG", "totalItems": 1, "items": [ { "action": "UPSERT", "dateCreated": "2015-06-09 15:41:37+0000", "id": "thumbnail_policy", "policy": "{\"id\":\"grayscale\",\"transformations\":[{\"transformation\":\"Grayscale\"}],\"resolutions\":{\"widths\":[500]},\"currentVersion\":1}", "user": "jsmith" } ] }, "schema": { "additionalProperties": false, "description": "Provides date, user, and version information for your policies.", "type": "object", "properties": { "itemKind": { "description": "The type of policy, in this case the `POLICIESLOG`.", "type": "string", "enum": [ "POLICIESLOG" ] }, "items": { "description": "An array showing a history of your policy changes.", "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "action": { "description": "The action logged, either `UPSERT` or `DELETE`.", "type": "string", "enum": [ "UPSERT", "DELETE" ] }, "dateCreated": { "description": "Date of the log entry in ISO 8601 extended notation format.", "type": "string" }, "id": { "description": "The ID of the policy.", "type": "string" }, "policy": { "description": "The policy's state as a result of the change, represented as a JSON string.", "type": "string" }, "user": { "description": "The user who made the modification.", "type": "string" }, "version": { "description": "The version of the policy.", "type": "integer" } } } }, "totalItems": { "description": "The total number of policies returned.", "type": "integer" } }, "x-akamai": { "file-path": "schemas/policy-history.yaml" } } } } } }, "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "__Enum__ Network environment to execute the API request on.", "example": "{{network}}", "in": "path", "name": "network", "required": true, "schema": { "example": "production", "type": "string", "enum": [ "staging", "production" ] }, "x-akamai": { "file-path": "parameters/network-path.yaml" } }, { "description": "Unique identifier for a policy.", "example": "{{policyId}}", "in": "path", "name": "policyId", "required": true, "schema": { "example": "thumbnail_policy", "type": "string" }, "x-akamai": { "file-path": "parameters/policyId-path.yaml" } }, { "description": "Unique identifier for the Akamai Contract containing the policy sets. Required if you have access to more than one contract with Image & Video Manager.", "example": "{{Contract}}", "in": "header", "name": "Contract", "required": false, "schema": { "example": "A-CCT7890", "type": "string" }, "x-akamai": { "file-path": "parameters/contractId-header.yaml" } }, { "description": "Unique identifier for the Image & Video Manager policy set.", "example": "{{Policy-Set}}", "in": "header", "name": "Policy-Set", "required": true, "schema": { "example": "053eef00-9f85-11ec-a51d-47eefacf795d", "type": "string" }, "x-akamai": { "file-path": "parameters/policySetId-header.yaml" } } ] }, "/network/{network}/policies/rollback/{policyId}": { "put": { "description": "Use this operation to revert the previous version of the policy and deploy it to the network. Use this operation to stop and reverse a policy rollout.", "operationId": "put-rollback-policy", "summary": "Roll back a policy", "tags": [ "Policies" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Image & Video Manager API", "url": "https://techdocs.akamai.com/ivm/reference/put-rollback-policy" }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "example": { "description": "Policy `watermark` has been rolled back to version 1.", "id": "watermark", "operationPerformed": "UPDATED" }, "schema": { "additionalProperties": false, "description": "The type of operation performed on an Image & Video Manager resource.", "type": "object", "properties": { "description": { "description": "The description of the resource.", "type": "string" }, "id": { "description": "Unique identifier for a resource.", "type": "string" }, "operationPerformed": { "description": "The action performed on the resource, either `CREATED`, `UPDATED`, `DELETED`, or `CANCELLED`.", "type": "string", "enum": [ "CREATED", "UPDATED", "DELETED", "CANCELLED" ] } }, "x-akamai": { "file-path": "schemas/operation-performed.yaml" } } } } }, "400": { "description": "Rollback failed.", "content": { "application/problem+json": { "example": { "detail": "Policy 'watermarked' does not exist.", "instance": "/imaging/error-instances/bf39e042-9d21-4ef3-88f1-eacf487d12f8", "requestId": "5fb7efe81b819c76", "status": 400, "title": "Bad Request", "type": "/imaging/error-types/IVM_9000" }, "schema": { "additionalProperties": false, "description": "Error messaging.", "type": "object", "properties": { "detail": { "description": "A detailed description of the error.", "type": "string" }, "httpStatus": { "description": "The HTTP code for the error.", "type": "integer" }, "instance": { "description": "A reference to unique instance of the error.", "type": "string" }, "requestId": { "description": "An additional instance identifier for the error.", "type": "string" }, "title": { "description": "The summary description of the error.", "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } } } }, "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "__Enum__ Network environment to execute the API request on.", "example": "{{network}}", "in": "path", "name": "network", "required": true, "schema": { "example": "production", "type": "string", "enum": [ "staging", "production" ] }, "x-akamai": { "file-path": "parameters/network-path.yaml" } }, { "description": "Unique identifier for a policy.", "example": "{{policyId}}", "in": "path", "name": "policyId", "required": true, "schema": { "example": "thumbnail_policy", "type": "string" }, "x-akamai": { "file-path": "parameters/policyId-path.yaml" } }, { "description": "Unique identifier for the Akamai Contract containing the policy sets. Required if you have access to more than one contract with Image & Video Manager.", "example": "{{Contract}}", "in": "header", "name": "Contract", "required": false, "schema": { "example": "A-CCT7890", "type": "string" }, "x-akamai": { "file-path": "parameters/contractId-header.yaml" } }, { "description": "Unique identifier for the Image & Video Manager policy set.", "example": "{{Policy-Set}}", "in": "header", "name": "Policy-Set", "required": true, "schema": { "example": "053eef00-9f85-11ec-a51d-47eefacf795d", "type": "string" }, "x-akamai": { "file-path": "parameters/policySetId-header.yaml" } } ] }, "/network/{network}/policies/{policyId}": { "get": { "description": "Returns a specific policy assigned to the specified policy set.", "operationId": "get-policy", "summary": "Get a policy", "tags": [ "Policies" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Image & Video Manager API", "url": "https://techdocs.akamai.com/ivm/reference/get-policy" }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "example": { "dateCreated": "2021-07-15 19:59:35+0000", "id": "watermark", "previousVersion": 0, "user": "jsmith", "version": 1, "video": false, "breakpoints": { "widths": [ 720, 1280, 1920, 5000 ] }, "output": { "perceptualQuality": "mediumHigh" }, "rolloutInfo": { "endTime": 1626382776, "rolloutDuration": 3600, "startTime": 1626379176 }, "transformations": [ { "gravity": "SouthWest", "transformation": "Composite", "xPosition": 0, "yPosition": 0, "image": { "url": "www.customer.com/watermark.png" } } ] }, "schema": { "x-akamai": { "file-path": "schemas/policy.yaml" }, "oneOf": [ { "description": "Specifies details for each policy, such as variations in image size and formats and the transformations to apply.", "title": "Image policy", "type": "object", "x-akamai": { "file-path": "schemas/policy-image.yaml" }, "allOf": [ { "additionalProperties": false, "type": "object", "properties": { "output": { "additionalProperties": false, "description": "Dictates the output quality, either `quality` or `perceptualQuality`, and the formats created for each resized image. If unspecified, you get image formats that support all browsers at the default quality level of `85`, including WEBP, JPEG2000, and JPEG-XR for specific browsers.", "title": "Output", "type": "object", "properties": { "adaptiveQuality": { "description": "Overrides the quality of the image to serve when Image & Video Manager detects a slow connection with a round-trip time (RTT) of less than 300 ms. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of images for users with standard connections.", "maximum": 100, "minimum": 1, "type": "integer" }, "allowedFormats": { "description": "The graphics file formats allowed for browser specific results, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "minItems": 1, "readOnly": true, "type": "array", "uniqueItems": true, "default": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ], "items": { "description": "The values of the allowed graphics file formats, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "type": "string", "enum": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ] } }, "forcedFormats": { "description": "The forced extra formats for the `imFormat` query parameter, which requests a specific browser type. By default, Image & Video Manager detects the browser and returns the appropriate image.", "readOnly": true, "type": "array", "uniqueItems": true, "default": [], "items": { "description": "The values of the forced extra formats, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "type": "string", "enum": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ] } }, "perceptualQuality": { "description": "Mutually exclusive with `quality`. The perceptual quality to use when comparing resulting images, which overrides the `quality` setting. Perceptual quality tunes each image format's quality dynamically based on the human-perceived quality of the output image. This can result in greater byte savings as compared to using regular `quality` because many images can be encoded at a much lower quality without compromising the perceived quality of the image. In addition, certain images may need to be encoded at a slightly higher quality in order to maintain human-perceived quality. Value tiers are `high`, `mediumHigh`, `medium`, `mediumLow`, and `low`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "perceptualQualityFloor": { "description": "Applies only when `perceptualQuality` is set. Sets a minimum image quality to respect when using perceptual quality. Perceptual quality won't reduce the quality below this value, even if it determines the compressed image to be acceptably visually similar.", "maximum": 100, "minimum": 1, "type": "integer" }, "quality": { "description": "Mutually exclusive with `perceptualQuality`, used by default if neither is specified. The chosen quality of output images from 1-100, with 1 being the lowest quality and 100 being the highest.", "oneOf": [ { "default": 85, "maximum": 100, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } } }, "postBreakpointTransformations": { "description": "Post-processing Transformations are applied to the image after image and quality settings have been applied.", "type": "array", "items": { "description": "A transformation to apply to the image/object/text.", "x-akamai": { "file-path": "schemas/transformation-post-breakpoint.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Places a transparent image on a set background color. Specify the color in CSS hexadecimal format.", "title": "BackgroundColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value for the background.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "BackgroundColor", "description": "Identifies the type of transformation, `BackgroundColor` in this case.", "type": "string", "enum": [ "BackgroundColor" ] } }, "x-akamai": { "file-path": "schemas/t-background-color.yaml" } }, { "additionalProperties": false, "description": "Applies a Gaussian blur to the image.", "title": "Blur", "type": "object", "required": [ "transformation" ], "properties": { "sigma": { "description": "The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.", "oneOf": [ { "default": 5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Blur", "description": "Identifies the type of transformation, `Blur` in this case.", "type": "string", "enum": [ "Blur" ] } }, "x-akamai": { "file-path": "schemas/t-blur.yaml" } }, { "additionalProperties": false, "description": "Changes any color in an image within the specified volume of the HSL colorspace to transparent or semi-transparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.", "title": "ChromaKey", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120\u00b0 on the color wheel.", "oneOf": [ { "default": 120, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueFeather": { "description": "How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30\u00b0 around the Hue Tolerance.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueTolerance": { "description": "How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30\u00b0 around the specified hue.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessFeather": { "description": "How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessTolerance": { "description": "How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a color must be within 75% of the full color to full white or full black for full removal.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationFeather": { "description": "How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the Saturation Tolerance.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationTolerance": { "description": "How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "ChromaKey", "description": "Identifies the type of transformation, `ChromaKey` in this case.", "type": "string", "enum": [ "ChromaKey" ] } }, "x-akamai": { "file-path": "schemas/t-chroma-key.yaml" } }, { "additionalProperties": false, "description": "An ordered combination of transformations to perform. Use to represent a sequence of transformations as a single transformation.", "title": "Compound", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Compound", "description": "Identifies the type of transformation, `Compound` in this case.", "type": "string", "enum": [ "Compound" ] }, "transformations": { "description": "A set of nested image transformations to apply to the source image.", "type": "array", "items": { "type": "object" } } }, "x-akamai": { "file-path": "schemas/t-compound.yaml" } }, { "additionalProperties": false, "description": "Adjusts both the contrast and brightness of an image.", "title": "Contrast", "type": "object", "required": [ "transformation" ], "properties": { "brightness": { "description": "Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of `1` produces a white image. A value of `-1` produces a black image. The default value is `0`, which leaves the image unchanged. The acceptable value range is `-1.0` to `1.0`. Values outside of the acceptable range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "contrast": { "description": "Adjusts the contrast of the image. Expressed as a range from `-1` to `1`, positive values increase contrast, negative values decrease it, while `0` leaves the image unchanged. Values outside of the `-1` to `1` range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Contrast", "description": "Identifies the type of transformation, `Contrast` in this case.", "type": "string", "enum": [ "Contrast" ] } }, "x-akamai": { "file-path": "schemas/t-contrast.yaml" } }, { "additionalProperties": false, "description": "Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears _goopy_. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.", "title": "Goop", "type": "object", "required": [ "transformation" ], "properties": { "chaos": { "description": "Specifies the greatest distance control points may move from their original position. A value of `1.0` shifts control points over as far as the next one in the original grid. A value of `0.0` leaves the image unchanged. Values under `0.5` work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "density": { "description": "Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium- to large-size images.", "oneOf": [ { "default": 4, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "power": { "description": "By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldn't need to vary the default value of `2.0`.", "oneOf": [ { "default": 2, "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "seed": { "description": "Specifies your own `seed` value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used, `Goop` distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Goop", "description": "Identifies the type of transformation, `Goop` in this case.", "type": "string", "enum": [ "Goop" ] } }, "x-akamai": { "file-path": "schemas/t-goop.yaml" } }, { "additionalProperties": false, "description": "Restricts image color to shades of gray only.", "title": "Grayscale", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Grayscale", "description": "Identifies the type of transformation, `Grayscale` in this case.", "type": "string", "enum": [ "Grayscale" ] }, "type": { "default": "Rec709", "description": "The algorithm used to transform colors to grays, either `Brightness`, `Lightness`, `Rec601`, or the default `Rec709`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "Rec601", "Rec709", "Brightness", "Lightness" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-grayscale.yaml" } }, { "additionalProperties": false, "description": "Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as `Grayscale` and `MaxColors`. If you're using more than one, consider the order to apply them for the desired results.", "title": "HSL", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightness": { "description": "A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green, whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than `1.0` decrease the lightness of colors in the image. Values greater than `1.0` increase the lightness of colors in the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSL", "description": "Identifies the type of transformation, `HSL` in this case.", "type": "string", "enum": [ "HSL" ] } }, "x-akamai": { "file-path": "schemas/t-hsl.yaml" } }, { "additionalProperties": false, "description": "Identical to HSL except it replaces `lightness` with `value`. For example, if you reduce the `lightness` of a light green, almost white, image, the color turns a vibrant green. Reducing the `value` turns the image a darker color, close to gray. This happens because the original image color is very close to white.", "title": "HSV", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0.0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSV", "description": "Identifies the type of transformation, `HSV` in this case.", "type": "string", "enum": [ "HSV" ] }, "value": { "description": "A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-hsv.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the dimensions of the source image. You need to select a dimension for comparison, which is either `width` and `height` or `both`.", "title": "IfDimension", "type": "object", "required": [ "transformation", "value" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "dimension": { "description": "The dimension to use to select the transformation, either `height`, `width`, or `both`. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "default": "width", "title": "String", "type": "string", "enum": [ "width", "height", "both" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "equal": { "description": "The transformation performed only if the source image's dimension is equal to the `value` listed.", "type": "object" }, "greaterThan": { "description": "The transformation performed if the source image's dimension is greater than the `value` listed.", "type": "object" }, "lessThan": { "description": "The transformation performed if the source image's dimension is less than the `value` listed.", "type": "object" }, "transformation": { "default": "IfDimension", "description": "Identifies the type of transformation, `IfDimension` in this case.", "type": "string", "enum": [ "IfDimension" ] }, "value": { "description": "The value to compare against the source image dimension. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-if-dimension.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the orientation of the source image. Defaults to the `default` transformation if no transformation is specified for the orientation.", "title": "IfOrientation", "type": "object", "required": [ "transformation" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "landscape": { "description": "The transformation performed if the source image uses landscape orientation.", "type": "object" }, "portrait": { "description": "The transformation performed if the source image uses portrait orientation.", "type": "object" }, "square": { "description": "The transformation performed if the source image uses a square orientation.", "type": "object" }, "transformation": { "default": "IfOrientation", "description": "Identifies the type of transformation, `IfOrientation` in this case.", "type": "string", "enum": [ "IfOrientation" ] } }, "x-akamai": { "file-path": "schemas/t-if-orientation.yaml" } }, { "additionalProperties": false, "description": "Set the maximum number of colors in the image palette. Reducing the number of colors in an image can help to reduce file size.", "title": "MaxColors", "type": "object", "required": [ "transformation", "colors" ], "properties": { "colors": { "description": "The value representing the maximum number of colors to use with the source image.", "oneOf": [ { "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MaxColors", "description": "Identifies the type of transformation, `MaxColors` in this case.", "type": "string", "enum": [ "MaxColors" ] } }, "x-akamai": { "file-path": "schemas/t-max-colors.yaml" } }, { "additionalProperties": false, "description": "Flips an image horizontally, vertically, or both.", "minProperties": 2, "title": "Mirror", "type": "object", "required": [ "transformation" ], "properties": { "horizontal": { "description": "Flips the image horizontally.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Mirror", "description": "Identifies the type of transformation, `Mirror` in this case.", "title": "IfDimension", "type": "string", "enum": [ "Mirror" ] }, "vertical": { "description": "Flips the image vertically.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-mirror.yaml" } }, { "additionalProperties": false, "description": "Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color's lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.", "title": "MonoHue", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MonoHue", "description": "Identifies the type of transformation, `MonoHue` in this case.", "type": "string", "enum": [ "MonoHue" ] } }, "x-akamai": { "file-path": "schemas/t-mono-hue.yaml" } }, { "additionalProperties": false, "description": "Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.", "title": "Opacity", "type": "object", "required": [ "transformation", "opacity" ], "properties": { "opacity": { "description": "Represents alpha values on a scale of `0` to `1`. Values below `1` increase transparency, and `0` is invisible. For images that have some transparency, values above `1` increase the opacity of the transparent portions.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Opacity", "description": "Identifies the type of transformation, `Opacity` in this case.", "type": "string", "enum": [ "Opacity" ] } }, "x-akamai": { "file-path": "schemas/t-opacity.yaml" } }, { "additionalProperties": false, "description": "Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.", "title": "RemoveColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value to remove.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "feather": { "description": "The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent, creating a softer edge. The first real-time request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "tolerance": { "description": "The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.", "oneOf": [ { "default": 0.2, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RemoveColor", "description": "Identifies the type of transformation, `RemoveColor` in this case.", "type": "string", "enum": [ "RemoveColor" ] } }, "x-akamai": { "file-path": "schemas/t-remove-color.yaml" } }, { "additionalProperties": false, "description": "Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as _sharpening_ an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image & Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.", "title": "UnsharpMask", "type": "object", "required": [ "transformation" ], "properties": { "gain": { "description": "Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "sigma": { "description": "The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels, `1.0` by default. High values emphasize large details and low values emphasize small details.", "oneOf": [ { "default": 1, "format": "float", "maximum": 10, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "threshold": { "description": "Set the minimum change required to include a detail in the filter. Higher values discard more changes.", "oneOf": [ { "default": 0.05, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "UnsharpMask", "description": "Identifies the type of transformation, `UnsharpMask` in this case.", "type": "string", "enum": [ "UnsharpMask" ] } }, "x-akamai": { "file-path": "schemas/t-unsharp-mask.yaml" } } ] } }, "transformations": { "description": "Set of image transformations to apply to the source image. If unspecified, no operations are performed.", "type": "array", "items": { "description": "A transformation to apply to the image/object/text.", "x-akamai": { "file-path": "schemas/transformation.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Places a specified `image` beside the source image. The API places the `image` on a major dimension, then aligns it on the minor dimension. Transparent pixels fill any area not covered by either image.", "title": "Append", "type": "object", "required": [ "transformation", "image" ], "properties": { "gravity": { "default": "Center", "description": "Specifies where to place the `image` relative to the source image. The available values represent the eight cardinal directions (`North`, `South`, `East`, `West`, `NorthEast`, `NorthWest`, `SouthEast`, `SouthWest`) and a `Center` by default.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravityPriority": { "description": "Determines the exact placement of the `image` when `gravity` is `Center` or a diagonal. The value is either `horizontal` or `vertical`. Use `horizontal` to append an `image` east or west of the source image. This aligns the `image` on the vertical gravity component, placing `Center` gravity east. Use `vertical` to append an `image` north or south of the source image. This aligns the `image` on the horizontal gravity component, placing `Center` gravity south.", "oneOf": [ { "default": "horizontal", "title": "String enum", "type": "string", "enum": [ "horizontal", "vertical" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "image": { "x-akamai": { "file-path": "schemas/image-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "A rectangular box, with a specified color and applied transformation.", "title": "Box image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the box, not the color of the edges of the box. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Box", "description": "Identifies the type of image, `Box` in this case.", "type": "string", "enum": [ "Box" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-box.yaml" } }, { "additionalProperties": false, "description": "A simple, solid, monochrome circle of a specified diameter on a transparent background.", "title": "Circle image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "diameter": { "description": "The diameter of the circle. The diameter will be the width and the height of the image in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Circle", "description": "Identifies the type of image, `Circle` in this case.", "type": "string", "enum": [ "Circle" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-circle.yaml" } }, { "additionalProperties": false, "description": "A snippet of text. Defines the font family, font size, fill color, outline stroke width, and outline color.", "title": "Text image", "type": "object", "required": [ "type", "text" ], "properties": { "fill": { "description": "The main fill color of the text.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "size": { "description": "The size in pixels to render the text.", "oneOf": [ { "default": 72, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "stroke": { "description": "The color of the outline of the text.", "oneOf": [ { "default": "#FFF", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "strokeSize": { "description": "The thickness in points of the outline of the text.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "text": { "description": "The line of text to render.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Text", "description": "Identifies the type of image, `Text` in this case.", "type": "string", "enum": [ "Text" ] }, "typeface": { "description": "The font family to apply to the text image. This may be the URL of a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.", "oneOf": [ { "default": "DejaVuSans", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-text.yaml" } }, { "additionalProperties": false, "description": "An image loaded from a URL.", "title": "URL image", "type": "object", "required": [ "url" ], "properties": { "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "URL", "description": "Identifies the type of image, `URL` in this case.", "type": "string", "enum": [ "URL" ] }, "url": { "description": "The URL of the image.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-url.yaml" } } ] }, "preserveMinorDimension": { "description": "Whether to preserve the source image's minor dimension, `false` by default. The minor dimension is the dimension opposite the dimension that the appending `image` is placed. For example, the dimensions of the source image are 100 × 100 pixels. The dimensions of the appending `image` are 50 × 150 pixels. The `gravity` is set to `East`. This makes the major dimension horizontal and the source image's minor dimension vertical. To preserve the source image's minor dimension at 100 pixels, the `preserveMinorDimension` is set to `true`. As a result of the append, the major dimension expanded with the appended image to 150 pixels. The source image's minor dimension was maintained at 100 pixels. The total combined dimension of the image is 150 × 100 pixels.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Append", "description": "Identifies the type of transformation, `Append` in this case.", "type": "string", "enum": [ "Append" ] } }, "x-akamai": { "file-path": "schemas/t-append.yaml" } }, { "additionalProperties": false, "description": "Changes the height or width of an image, either by cropping or expanding the area, to an aspect ratio of your choosing.", "title": "AspectCrop", "type": "object", "required": [ "transformation" ], "properties": { "allowExpansion": { "description": "Increases the size of the image canvas to achieve the requested aspect ratio instead of cropping the image. Use the Horizontal Offset and Vertical Offset settings to determine where to add the fully transparent pixels on the expanded image canvas.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height term of the aspect ratio to crop.", "oneOf": [ { "default": 1, "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "AspectCrop", "description": "Identifies the type of transformation, `AspectCrop` in this case.", "type": "string", "enum": [ "AspectCrop" ] }, "width": { "description": "The width term of the aspect ratio to crop.", "oneOf": [ { "default": 1, "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "xPosition": { "description": "Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.", "oneOf": [ { "default": 0.5, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "description": "Specifies the horizontal portion of the image you want to keep when cropping by aspect ratio crop. When using `allowExpansion`, this setting defines the horizontal position of the image on the new expanded image canvas.", "oneOf": [ { "default": 0.5, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-aspect-crop.yaml" } }, { "additionalProperties": false, "description": "Places a transparent image on a set background color. Specify the color in CSS hexadecimal format.", "title": "BackgroundColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value for the background.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "BackgroundColor", "description": "Identifies the type of transformation, `BackgroundColor` in this case.", "type": "string", "enum": [ "BackgroundColor" ] } }, "x-akamai": { "file-path": "schemas/t-background-color.yaml" } }, { "additionalProperties": false, "description": "Applies a Gaussian blur to the image.", "title": "Blur", "type": "object", "required": [ "transformation" ], "properties": { "sigma": { "description": "The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.", "oneOf": [ { "default": 5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Blur", "description": "Identifies the type of transformation, `Blur` in this case.", "type": "string", "enum": [ "Blur" ] } }, "x-akamai": { "file-path": "schemas/t-blur.yaml" } }, { "additionalProperties": false, "description": "Changes any color in an image within the specified volume of the HSL colorspace to transparent or semi-transparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.", "title": "ChromaKey", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120\u00b0 on the color wheel.", "oneOf": [ { "default": 120, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueFeather": { "description": "How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30\u00b0 around the Hue Tolerance.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueTolerance": { "description": "How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30\u00b0 around the specified hue.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessFeather": { "description": "How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessTolerance": { "description": "How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a color must be within 75% of the full color to full white or full black for full removal.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationFeather": { "description": "How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the Saturation Tolerance.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationTolerance": { "description": "How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "ChromaKey", "description": "Identifies the type of transformation, `ChromaKey` in this case.", "type": "string", "enum": [ "ChromaKey" ] } }, "x-akamai": { "file-path": "schemas/t-chroma-key.yaml" } }, { "additionalProperties": false, "description": "Applies another image to the source image, either as an overlay or an underlay. The image that's underneath is visible in areas that are beyond the edges of the top image or that are less than 100% opaque. A common use of an overlay composite is to add a watermark.", "title": "Composite", "type": "object", "required": [ "transformation", "image" ], "properties": { "gravity": { "default": "NorthWest", "description": "Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "image": { "x-akamai": { "file-path": "schemas/image-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "A rectangular box, with a specified color and applied transformation.", "title": "Box image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the box, not the color of the edges of the box. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Box", "description": "Identifies the type of image, `Box` in this case.", "type": "string", "enum": [ "Box" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-box.yaml" } }, { "additionalProperties": false, "description": "A simple, solid, monochrome circle of a specified diameter on a transparent background.", "title": "Circle image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "diameter": { "description": "The diameter of the circle. The diameter will be the width and the height of the image in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Circle", "description": "Identifies the type of image, `Circle` in this case.", "type": "string", "enum": [ "Circle" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-circle.yaml" } }, { "additionalProperties": false, "description": "A snippet of text. Defines the font family, font size, fill color, outline stroke width, and outline color.", "title": "Text image", "type": "object", "required": [ "type", "text" ], "properties": { "fill": { "description": "The main fill color of the text.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "size": { "description": "The size in pixels to render the text.", "oneOf": [ { "default": 72, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "stroke": { "description": "The color of the outline of the text.", "oneOf": [ { "default": "#FFF", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "strokeSize": { "description": "The thickness in points of the outline of the text.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "text": { "description": "The line of text to render.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Text", "description": "Identifies the type of image, `Text` in this case.", "type": "string", "enum": [ "Text" ] }, "typeface": { "description": "The font family to apply to the text image. This may be the URL of a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.", "oneOf": [ { "default": "DejaVuSans", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-text.yaml" } }, { "additionalProperties": false, "description": "An image loaded from a URL.", "title": "URL image", "type": "object", "required": [ "url" ], "properties": { "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "URL", "description": "Identifies the type of image, `URL` in this case.", "type": "string", "enum": [ "URL" ] }, "url": { "description": "The URL of the image.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-url.yaml" } } ] }, "placement": { "description": "Where to place the specified image, either `Over` or `Under` the existing image. Watermarks are usually applied over. Backgrounds are usually applied under.", "oneOf": [ { "default": "Over", "title": "String enum", "type": "string", "enum": [ "Over", "Under", "Mask", "Stencil" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "scale": { "description": "A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the `scaleDimension` to calculate the `scale` from the source image's width or height.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "scaleDimension": { "description": "The dimension, either `width` or `height`, of the source image to scale.", "oneOf": [ { "default": "width", "title": "String enum", "type": "string", "enum": [ "width", "height" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Composite", "description": "Identifies the type of transformation, `Composite` in this case.", "type": "string", "enum": [ "Composite" ] }, "xPosition": { "description": "The x-axis position of the image to apply.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "default": 0, "description": "The y-axis position of the image to apply.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-composite.yaml" } }, { "additionalProperties": false, "description": "An ordered combination of transformations to perform. Use to represent a sequence of transformations as a single transformation.", "title": "Compound", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Compound", "description": "Identifies the type of transformation, `Compound` in this case.", "type": "string", "enum": [ "Compound" ] }, "transformations": { "description": "A set of nested image transformations to apply to the source image.", "type": "array", "items": { "type": "object" } } }, "x-akamai": { "file-path": "schemas/t-compound.yaml" } }, { "additionalProperties": false, "description": "Adjusts both the contrast and brightness of an image.", "title": "Contrast", "type": "object", "required": [ "transformation" ], "properties": { "brightness": { "description": "Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of `1` produces a white image. A value of `-1` produces a black image. The default value is `0`, which leaves the image unchanged. The acceptable value range is `-1.0` to `1.0`. Values outside of the acceptable range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "contrast": { "description": "Adjusts the contrast of the image. Expressed as a range from `-1` to `1`, positive values increase contrast, negative values decrease it, while `0` leaves the image unchanged. Values outside of the `-1` to `1` range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Contrast", "description": "Identifies the type of transformation, `Contrast` in this case.", "type": "string", "enum": [ "Contrast" ] } }, "x-akamai": { "file-path": "schemas/t-contrast.yaml" } }, { "additionalProperties": false, "description": "Crops an image.", "title": "Crop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "allowExpansion": { "description": "If cropping an area outside of the existing canvas, expands the image canvas.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "NorthWest", "description": "Frame of reference for X and Y positions.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The number of pixels to crop along the y-axis.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Crop", "description": "Identifies the type of transformation, `Crop` in this case.", "type": "string", "enum": [ "Crop" ] }, "width": { "description": "The number of pixels to crop along the x-axis.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "xPosition": { "description": "The x-axis position of the image to crop from.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "description": "The y-axis position of the image to crop from.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-crop.yaml" } }, { "additionalProperties": false, "description": "Applies a method to detect faces in the source image and applies the rectangular crop on either the `biggest` face or `all` of the faces detected. Image & Video Manager tries to preserve faces in the image instead of using specified crop coordinates.", "title": "FaceCrop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "algorithm": { "description": "Specifies the type of algorithm used to detect faces in the image, either `cascade` for the cascade classifier algorithm or `dnn` for the deep neural network algorithm, `cascade` by default.", "oneOf": [ { "default": "cascade", "title": "String enum", "type": "string", "enum": [ "cascade", "dnn" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "confidence": { "description": "With `algorithm` set to `dnn`, specifies the minimum confidence needed to detect faces in the image. Values range from `0` to `1` for increased confidence, and possibly fewer faces detected.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "failGravity": { "default": "Center", "description": "Controls placement of the crop if Image & Video Manager does not detect any faces in the image. Directions are relative to the edges of the image being transformed.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "focus": { "description": "Distinguishes the faces detected, either `biggestFace` or `allFaces` to place the crop rectangle around the full set of faces. This is `all` by default.", "oneOf": [ { "default": "allFaces", "title": "String enum", "type": "string", "enum": [ "allFaces", "biggestFace" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "Center", "description": "Controls placement of the crop. Directions are relative to the face, plus padding.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the output image in pixels relative to the specified `style` value.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "The padding ratio based on the dimensions of the biggest face detected, `0.5` by default. Larger values increase padding.", "oneOf": [ { "default": 0.5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the faces detected in the source image, `zoom` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` places a raw crop around the faces, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and faces as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the faces, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "zoom", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FaceCrop", "description": "Identifies the type of transformation, `FaceCrop` in this case.", "type": "string", "enum": [ "FaceCrop" ] }, "width": { "description": "The width of the output image in pixels relative to the specified `style` value.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-face-crop.yaml" } }, { "additionalProperties": false, "description": "Identifies prominent features of the source image, then crops around as many of these features as possible relative to the specified `width` and `height` values.", "title": "FeatureCrop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "failGravity": { "default": "Center", "description": "Controls placement of the crop if Image & Video Manager does not detect any features in the image. Directions are relative to the edges of the image being transformed.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "featureRadius": { "description": "The size in pixels of the important features to search for. If identified, two features never appear closer together than this value, `8.0` by default.", "oneOf": [ { "default": 8, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "Center", "description": "Controls placement of the crop. Directions are relative to the region of interest plus padding.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "maxFeatures": { "description": "The maximum number of features to identify as important features, `32` by default. The strongest features are always chosen.", "oneOf": [ { "default": 32, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "minFeatureQuality": { "description": "Determines the minimum quality level of the feature identified. To consider a feature important, the feature needs to surpass this value. Image & Video Manager measures quality on a scale from `0` for the lowest quality to `1` for the highest quality, `.1` by default.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "Adds space around the region of interest. The amount of padding added is directly related to the size of the bounding box of the selected features. Specifically, the region of interest is expanded in all directions by the largest dimension of the bounding box of the selected features multiplied by this value.", "oneOf": [ { "default": 0.05, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the features identified in the source image, `fill` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` performs a raw crop around the features, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and features as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the features, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "zoom", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FeatureCrop", "description": "Identifies the type of transformation, `FeatureCrop` in this case.", "type": "string", "enum": [ "FeatureCrop" ] }, "width": { "description": "The width in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-feature-crop.yaml" } }, { "additionalProperties": false, "description": "Resizes an image to fit within a specific size box and then uses a fill of that same image to cover any transparent space at the edges. By default the fill image has a Blur transformation with a sigma value of 8 applied. Customize the transformation using the `fillTransformation` parameter.", "title": "FitAndFill", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "fillTransformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "height": { "description": "The height value of the resized image.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FitAndFill", "description": "Identifies the type of transformation, `FitAndFill` in this case.", "type": "string", "enum": [ "FitAndFill" ] }, "width": { "description": "The width value of the resized image.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-fit-and-fill.yaml" } }, { "additionalProperties": false, "description": "Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears _goopy_. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.", "title": "Goop", "type": "object", "required": [ "transformation" ], "properties": { "chaos": { "description": "Specifies the greatest distance control points may move from their original position. A value of `1.0` shifts control points over as far as the next one in the original grid. A value of `0.0` leaves the image unchanged. Values under `0.5` work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "density": { "description": "Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium- to large-size images.", "oneOf": [ { "default": 4, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "power": { "description": "By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldn't need to vary the default value of `2.0`.", "oneOf": [ { "default": 2, "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "seed": { "description": "Specifies your own `seed` value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used, `Goop` distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Goop", "description": "Identifies the type of transformation, `Goop` in this case.", "type": "string", "enum": [ "Goop" ] } }, "x-akamai": { "file-path": "schemas/t-goop.yaml" } }, { "additionalProperties": false, "description": "Restricts image color to shades of gray only.", "title": "Grayscale", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Grayscale", "description": "Identifies the type of transformation, `Grayscale` in this case.", "type": "string", "enum": [ "Grayscale" ] }, "type": { "default": "Rec709", "description": "The algorithm used to transform colors to grays, either `Brightness`, `Lightness`, `Rec601`, or the default `Rec709`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "Rec601", "Rec709", "Brightness", "Lightness" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-grayscale.yaml" } }, { "additionalProperties": false, "description": "Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as `Grayscale` and `MaxColors`. If you're using more than one, consider the order to apply them for the desired results.", "title": "HSL", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightness": { "description": "A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green, whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than `1.0` decrease the lightness of colors in the image. Values greater than `1.0` increase the lightness of colors in the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSL", "description": "Identifies the type of transformation, `HSL` in this case.", "type": "string", "enum": [ "HSL" ] } }, "x-akamai": { "file-path": "schemas/t-hsl.yaml" } }, { "additionalProperties": false, "description": "Identical to HSL except it replaces `lightness` with `value`. For example, if you reduce the `lightness` of a light green, almost white, image, the color turns a vibrant green. Reducing the `value` turns the image a darker color, close to gray. This happens because the original image color is very close to white.", "title": "HSV", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0.0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSV", "description": "Identifies the type of transformation, `HSV` in this case.", "type": "string", "enum": [ "HSV" ] }, "value": { "description": "A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-hsv.yaml" } }, { "additionalProperties": false, "description": "Apply artistic transformations to images quickly and dynamically by specifying transformations with a query string appended to the image URL.\n- transformation\n- query\n- allowedTransformations", "title": "ImQuery", "type": "object", "properties": { "allowedTransformations": { "description": "Specifies the transformations that can be applied using the query string parameter.", "type": "array", "items": { "type": "string", "enum": [ "Append", "AspectCrop", "BackgroundColor", "Blur", "Composite", "Contrast", "Crop", "ChromaKey", "FaceCrop", "FeatureCrop", "FitAndFill", "Goop", "Grayscale", "HSL", "HSV", "MaxColors", "Mirror", "MonoHue", "Opacity", "RegionOfInterestCrop", "RelativeCrop", "RemoveColor", "Resize", "Rotate", "Scale", "Shear", "Trim", "UnsharpMask", "IfDimension", "IfOrientation" ] } }, "query": { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } }, "transformation": { "default": "ImQuery", "description": "Identifies the type of transformation, `ImQuery` in this case.", "type": "string", "enum": [ "ImQuery" ] } }, "x-akamai": { "file-path": "schemas/t-im-query.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the dimensions of the source image. You need to select a dimension for comparison, which is either `width` and `height` or `both`.", "title": "IfDimension", "type": "object", "required": [ "transformation", "value" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "dimension": { "description": "The dimension to use to select the transformation, either `height`, `width`, or `both`. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "default": "width", "title": "String", "type": "string", "enum": [ "width", "height", "both" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "equal": { "description": "The transformation performed only if the source image's dimension is equal to the `value` listed.", "type": "object" }, "greaterThan": { "description": "The transformation performed if the source image's dimension is greater than the `value` listed.", "type": "object" }, "lessThan": { "description": "The transformation performed if the source image's dimension is less than the `value` listed.", "type": "object" }, "transformation": { "default": "IfDimension", "description": "Identifies the type of transformation, `IfDimension` in this case.", "type": "string", "enum": [ "IfDimension" ] }, "value": { "description": "The value to compare against the source image dimension. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-if-dimension.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the orientation of the source image. Defaults to the `default` transformation if no transformation is specified for the orientation.", "title": "IfOrientation", "type": "object", "required": [ "transformation" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "landscape": { "description": "The transformation performed if the source image uses landscape orientation.", "type": "object" }, "portrait": { "description": "The transformation performed if the source image uses portrait orientation.", "type": "object" }, "square": { "description": "The transformation performed if the source image uses a square orientation.", "type": "object" }, "transformation": { "default": "IfOrientation", "description": "Identifies the type of transformation, `IfOrientation` in this case.", "type": "string", "enum": [ "IfOrientation" ] } }, "x-akamai": { "file-path": "schemas/t-if-orientation.yaml" } }, { "additionalProperties": false, "description": "Set the maximum number of colors in the image palette. Reducing the number of colors in an image can help to reduce file size.", "title": "MaxColors", "type": "object", "required": [ "transformation", "colors" ], "properties": { "colors": { "description": "The value representing the maximum number of colors to use with the source image.", "oneOf": [ { "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MaxColors", "description": "Identifies the type of transformation, `MaxColors` in this case.", "type": "string", "enum": [ "MaxColors" ] } }, "x-akamai": { "file-path": "schemas/t-max-colors.yaml" } }, { "additionalProperties": false, "description": "Flips an image horizontally, vertically, or both.", "minProperties": 2, "title": "Mirror", "type": "object", "required": [ "transformation" ], "properties": { "horizontal": { "description": "Flips the image horizontally.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Mirror", "description": "Identifies the type of transformation, `Mirror` in this case.", "title": "IfDimension", "type": "string", "enum": [ "Mirror" ] }, "vertical": { "description": "Flips the image vertically.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-mirror.yaml" } }, { "additionalProperties": false, "description": "Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color's lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.", "title": "MonoHue", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MonoHue", "description": "Identifies the type of transformation, `MonoHue` in this case.", "type": "string", "enum": [ "MonoHue" ] } }, "x-akamai": { "file-path": "schemas/t-mono-hue.yaml" } }, { "additionalProperties": false, "description": "Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.", "title": "Opacity", "type": "object", "required": [ "transformation", "opacity" ], "properties": { "opacity": { "description": "Represents alpha values on a scale of `0` to `1`. Values below `1` increase transparency, and `0` is invisible. For images that have some transparency, values above `1` increase the opacity of the transparent portions.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Opacity", "description": "Identifies the type of transformation, `Opacity` in this case.", "type": "string", "enum": [ "Opacity" ] } }, "x-akamai": { "file-path": "schemas/t-opacity.yaml" } }, { "additionalProperties": false, "description": "Crops to a region around a specified area of interest relative to the specified `width` and `height` values.", "title": "RegionOfInterestCrop", "type": "object", "required": [ "transformation", "width", "height", "regionOfInterest" ], "properties": { "gravity": { "default": "Center", "description": "The placement of the crop area relative to the specified area of interest.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "regionOfInterest": { "x-akamai": { "file-path": "schemas/shape-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Defines a circle with a specified `radius` from its `center` point.", "title": "Circle", "type": "object", "required": [ "center", "radius" ], "properties": { "center": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, "radius": { "description": "The radius of the circle measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-circle.yaml" } }, { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, { "additionalProperties": false, "description": "Defines a polygon from a series of connected points.", "title": "Polygon", "type": "object", "required": [ "points" ], "properties": { "points": { "description": "Series of PointShapeType objects. The last and first points connect to close the shape automatically.", "type": "array", "items": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } } } }, "x-akamai": { "file-path": "schemas/shape-type-polygon.yaml" } }, { "additionalProperties": false, "description": "Defines a rectangle's `width` and `height` relative to an `anchor` point at the top left corner.", "title": "Rectangle", "type": "object", "required": [ "anchor", "width", "height" ], "properties": { "anchor": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, "height": { "description": "Extends the rectangle down from the `anchor` point.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "width": { "description": "Extends the rectangle right from the `anchor` point.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-rectangle.yaml" } }, { "additionalProperties": false, "description": "Identifies a combined shape based on a set of other shapes.", "title": "Union", "type": "object", "required": [ "shapes" ], "properties": { "shapes": { "description": "A nested shape used to describe a more complex shape.", "type": "array", "items": { "description": "A nested shape used to describe a more complex shape.", "title": "Nested shape", "type": "object", "x-akamai": { "file-path": "schemas/shape-type-nested.yaml" } } } }, "x-akamai": { "file-path": "schemas/shape-type-union.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the specified area of interest in the source image, `zoom` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` places raw crop around the point of interest, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and point of interest as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the point of interest, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "fill", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RegionOfInterestCrop", "description": "Identifies the type of transformation, `RegionOfInterestCrop` in this case.", "type": "string", "enum": [ "RegionOfInterestCrop" ] }, "width": { "description": "The width in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-region-of-interest-crop.yaml" } }, { "additionalProperties": false, "description": "Shrinks or expands an image relative to the image's specified dimensions. Image & Video Manager fills the expanded areas with transparency. Positive values shrink the side, while negative values expand it.", "title": "RelativeCrop", "type": "object", "required": [ "transformation" ], "properties": { "east": { "description": "The number of pixels to shrink or expand the right side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "north": { "description": "The number of pixels to shrink or expand the top side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "south": { "description": "The number of pixels to shrink or expand the bottom side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RelativeCrop", "description": "Identifies the type of transformation, `RelativeCrop` in this case.", "type": "string", "enum": [ "RelativeCrop" ] }, "west": { "description": "The number of pixels to shrink or expand the left side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-relative-crop.yaml" } }, { "additionalProperties": false, "description": "Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.", "title": "RemoveColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value to remove.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "feather": { "description": "The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent, creating a softer edge. The first real-time request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "tolerance": { "description": "The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.", "oneOf": [ { "default": 0.2, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RemoveColor", "description": "Identifies the type of transformation, `RemoveColor` in this case.", "type": "string", "enum": [ "RemoveColor" ] } }, "x-akamai": { "file-path": "schemas/t-remove-color.yaml" } }, { "additionalProperties": false, "description": "Resizes an image to a particular, absolute dimension. If you don't enter a `width` or a `height`, the image is resized with the `fit` aspect preservation mode, which selects a value for the missing dimension that preserves the image's aspect.", "title": "Resize", "type": "object", "required": [ "transformation" ], "properties": { "aspect": { "description": "Preserves the aspect ratio. Select `fit` to make the image fit entirely within the selected width and height. When using `fit`, the resulting image has the largest possible size for the specified dimensions. Select `fill` to size the image so it both completely fills the dimensions and has the smallest possible file size. Otherwise `ignore` changes the original aspect ratio to fit within an arbitrarily shaped rectangle.", "oneOf": [ { "default": "fit", "title": "String enum", "type": "string", "enum": [ "fit", "fill", "ignore" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height to resize the source image to. Must be set if `width` is not specified.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Resize", "description": "Identifies the type of transformation, `Resize` in this case.", "type": "string", "enum": [ "Resize" ] }, "type": { "description": "Sets constraints for the image resize. Select `normal` to resize in all cases, either increasing or decreasing the dimensions. Select `downsize` to ignore this transformation if the result would be larger than the original. Select `upsize` to ignore this transformation if the result would be smaller.", "oneOf": [ { "default": "normal", "title": "String enum", "type": "string", "enum": [ "normal", "upsize", "downsize" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "width": { "description": "The width to resize the source image to. Must be set if `height` is not specified.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-resize.yaml" } }, { "additionalProperties": false, "description": "Rotate the image around its center by indicating the degrees of rotation.", "title": "Rotate", "type": "object", "required": [ "transformation", "degrees" ], "properties": { "degrees": { "description": "The value to rotate the image by. Positive values rotate clockwise, while negative values rotate counter-clockwise.", "oneOf": [ { "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Rotate", "description": "Identifies the type of transformation, `Rotate` in this case.", "type": "string", "enum": [ "Rotate" ] } }, "x-akamai": { "file-path": "schemas/t-rotate.yaml" } }, { "additionalProperties": false, "description": "Changes the image's size to different dimensions relative to its starting size.", "title": "Scale", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "height": { "description": "Scaling factor for the input height to determine the output height of the image, where values between `0` and `1` decrease size. Image dimensions need to be non-zero positive numbers.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Scale", "description": "Identifies the type of transformation, `Scale` in this case.", "type": "string", "enum": [ "Scale" ] }, "width": { "description": "Scaling factor for the input width to determine the output width of the image, where `1` leaves the width unchanged. Values greater than `1` increase the image size. Image dimensions need to be non-zero positive numbers.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-scale.yaml" } }, { "additionalProperties": false, "description": "Slants an image into a parallelogram, as a percent of the starting dimension as represented in decimal format. You need to specify at least one axis property. Transparent pixels fill empty areas around the sheared image as needed, so it's often useful to use a `BackgroundColor` transformation for these areas.", "title": "Shear", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Shear", "description": "Identifies the type of transformation, `Shear` in this case.", "type": "string", "enum": [ "Shear" ] }, "xShear": { "description": "The amount to shear along the x-axis, measured in multiples of the image's width. Required if `yShear` is not specified.", "oneOf": [ { "default": 0, "format": "float", "maximum": 5, "minimum": -5, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yShear": { "description": "The amount to shear along the y-axis, measured in multiples of the image's height. Required if `xShear` is not specified.", "oneOf": [ { "default": 0, "format": "float", "maximum": 5, "minimum": -5, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-shear.yaml" } }, { "additionalProperties": false, "description": "Automatically crops uniform backgrounds from the edges of an image.", "title": "Trim", "type": "object", "required": [ "transformation" ], "properties": { "fuzz": { "description": "The fuzz tolerance of the trim, a value between `0` and `1` that determines the acceptable amount of background variation before trimming stops.", "oneOf": [ { "default": 0.08, "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "The amount of padding in pixels to add to the trimmed image.", "oneOf": [ { "default": 0, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Trim", "description": "Identifies the type of transformation, `Trim` in this case.", "type": "string", "enum": [ "Trim" ] } }, "x-akamai": { "file-path": "schemas/t-trim.yaml" } }, { "additionalProperties": false, "description": "Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as _sharpening_ an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image & Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.", "title": "UnsharpMask", "type": "object", "required": [ "transformation" ], "properties": { "gain": { "description": "Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "sigma": { "description": "The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels, `1.0` by default. High values emphasize large details and low values emphasize small details.", "oneOf": [ { "default": 1, "format": "float", "maximum": 10, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "threshold": { "description": "Set the minimum change required to include a detail in the filter. Higher values discard more changes.", "oneOf": [ { "default": 0.05, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "UnsharpMask", "description": "Identifies the type of transformation, `UnsharpMask` in this case.", "type": "string", "enum": [ "UnsharpMask" ] } }, "x-akamai": { "file-path": "schemas/t-unsharp-mask.yaml" } } ] } }, "video": { "default": false, "description": "Identifies this as an image policy.", "readOnly": true, "type": "boolean", "enum": [ false ] } }, "x-akamai": { "file-path": "schemas/policy-image-specific.yaml" } }, { "additionalProperties": false, "properties": { "breakpoints": { "additionalProperties": false, "description": "The breakpoint widths (in pixels) to use to create derivative images or videos.", "title": "Breakpoints", "type": "object", "properties": { "widths": { "description": "Specifies each integer breakpoint width value.", "minItems": 1, "type": "array", "items": { "maximum": 5000, "minimum": 1, "type": "integer" } } } }, "dateCreated": { "description": "Date this policy version was created in ISO 8601 extended notation format.", "readOnly": true, "type": "string" }, "hosts": { "description": "Hosts that are allowed for image or video URLs within transformations or variables.", "type": "array", "items": { "type": "string" } }, "id": { "description": "Unique identifier for a policy which can be up to 64 alphanumeric characters and can include underscores or dashes.", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "readOnly": true, "type": "string" }, "previousVersion": { "description": "The previous version number of this policy version.", "readOnly": true, "type": "integer" }, "rolloutDuration": { "default": 3600, "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. This value has no effect on the staging network.", "maximum": 604800, "minimum": 3600, "type": "integer", "writeOnly": true }, "rolloutInfo": { "additionalProperties": false, "description": "Contains information about policy rollout start and completion times.", "readOnly": true, "type": "object", "properties": { "endTime": { "description": "The estimated time that rollout for this policy will end in UNIX timestamp format.", "type": "integer" }, "rolloutDuration": { "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. Policies on the staging network deploy as quickly as possible without rollout. For staging policies this value will always be 1.", "maximum": 604800, "minimum": 3600, "type": "integer" }, "startTime": { "description": "The estimated time that rollout for this policy will begin in UNIX timestamp format.", "type": "integer" } } }, "user": { "description": "The user who created this policy version.", "readOnly": true, "type": "string" }, "variables": { "description": "Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as an Inline Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.", "type": "array", "items": { "additionalProperties": false, "title": "Variable", "type": "object", "required": [ "name", "type", "defaultValue" ], "properties": { "defaultValue": { "description": "The default value of the variable if no query parameter is provided. It needs to be one of the `enumOptions` if any are provided.", "type": "string" }, "enumOptions": { "description": "Optionally limits the set of possible values for a variable. References to an enum `id` insert a corresponding `value`.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "id", "value" ], "properties": { "id": { "description": "The unique identifier for each enum value, up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "value": { "description": "The value of the variable when the `id` is provided.", "type": "string" } } } }, "name": { "description": "The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "postfix": { "description": "A postfix added to the value provided for the variable, or to the default value.", "type": "string" }, "prefix": { "description": "A prefix added to the value provided for the variable, or to the default value.", "type": "string" }, "type": { "description": "The type of value for the variable, either `bool`, `number`, `url`, `color`, `gravity`, `placement`, `scaleDimension`, `grayscaleType`, `aspect`, `resizeType`, `dimension`, `perceptualQuality`, `string`, or `focus`.", "type": "string", "enum": [ "bool", "number", "url", "color", "gravity", "placement", "scaleDimension", "grayscaleType", "aspect", "resizeType", "dimension", "perceptualQuality", "string", "focus" ] } }, "x-akamai": { "file-path": "schemas/variable.yaml" } } }, "version": { "description": "The version number of this policy version.", "readOnly": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/policy-shared.yaml" } } ] }, { "description": "Specifies details for each policy such as video size.", "title": "Video policy", "type": "object", "x-akamai": { "file-path": "schemas/policy-video.yaml" }, "allOf": [ { "additionalProperties": false, "type": "object", "properties": { "output": { "additionalProperties": false, "description": "Dictates the output quality for each resized video.", "title": "Output", "type": "object", "properties": { "perceptualQuality": { "description": "The quality of derivative videos. High preserves video quality with reduced byte savings while low reduces video quality to increase byte savings.", "oneOf": [ { "default": "medium", "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "placeholderVideoUrl": { "description": "Allows you to add a specific placeholder video that appears when a user first requests a video, but before Image & Video Manager processes the video. If not specified the original video plays during the processing time.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "videoAdaptiveQuality": { "description": "Overrides the quality of video to serve when Image & Video Manager detects a slow connection with a round-trip time (RTT) of 300 ms. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of videos for users with faster connections.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } } }, "video": { "default": true, "description": "Identifies this as a video policy.", "readOnly": true, "type": "boolean", "enum": [ true ] } }, "x-akamai": { "file-path": "schemas/policy-video-specific.yaml" } }, { "additionalProperties": false, "properties": { "breakpoints": { "additionalProperties": false, "description": "The breakpoint widths (in pixels) to use to create derivative images or videos.", "title": "Breakpoints", "type": "object", "properties": { "widths": { "description": "Specifies each integer breakpoint width value.", "minItems": 1, "type": "array", "items": { "maximum": 5000, "minimum": 1, "type": "integer" } } } }, "dateCreated": { "description": "Date this policy version was created in ISO 8601 extended notation format.", "readOnly": true, "type": "string" }, "hosts": { "description": "Hosts that are allowed for image or video URLs within transformations or variables.", "type": "array", "items": { "type": "string" } }, "id": { "description": "Unique identifier for a policy which can be up to 64 alphanumeric characters and can include underscores or dashes.", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "readOnly": true, "type": "string" }, "previousVersion": { "description": "The previous version number of this policy version.", "readOnly": true, "type": "integer" }, "rolloutDuration": { "default": 3600, "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. This value has no effect on the staging network.", "maximum": 604800, "minimum": 3600, "type": "integer", "writeOnly": true }, "rolloutInfo": { "additionalProperties": false, "description": "Contains information about policy rollout start and completion times.", "readOnly": true, "type": "object", "properties": { "endTime": { "description": "The estimated time that rollout for this policy will end in UNIX timestamp format.", "type": "integer" }, "rolloutDuration": { "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. Policies on the staging network deploy as quickly as possible without rollout. For staging policies this value will always be 1.", "maximum": 604800, "minimum": 3600, "type": "integer" }, "startTime": { "description": "The estimated time that rollout for this policy will begin in UNIX timestamp format.", "type": "integer" } } }, "user": { "description": "The user who created this policy version.", "readOnly": true, "type": "string" }, "variables": { "description": "Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as an Inline Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.", "type": "array", "items": { "additionalProperties": false, "title": "Variable", "type": "object", "required": [ "name", "type", "defaultValue" ], "properties": { "defaultValue": { "description": "The default value of the variable if no query parameter is provided. It needs to be one of the `enumOptions` if any are provided.", "type": "string" }, "enumOptions": { "description": "Optionally limits the set of possible values for a variable. References to an enum `id` insert a corresponding `value`.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "id", "value" ], "properties": { "id": { "description": "The unique identifier for each enum value, up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "value": { "description": "The value of the variable when the `id` is provided.", "type": "string" } } } }, "name": { "description": "The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "postfix": { "description": "A postfix added to the value provided for the variable, or to the default value.", "type": "string" }, "prefix": { "description": "A prefix added to the value provided for the variable, or to the default value.", "type": "string" }, "type": { "description": "The type of value for the variable, either `bool`, `number`, `url`, `color`, `gravity`, `placement`, `scaleDimension`, `grayscaleType`, `aspect`, `resizeType`, `dimension`, `perceptualQuality`, `string`, or `focus`.", "type": "string", "enum": [ "bool", "number", "url", "color", "gravity", "placement", "scaleDimension", "grayscaleType", "aspect", "resizeType", "dimension", "perceptualQuality", "string", "focus" ] } }, "x-akamai": { "file-path": "schemas/variable.yaml" } } }, "version": { "description": "The version number of this policy version.", "readOnly": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/policy-shared.yaml" } } ] } ] } } } }, "404": { "description": "Not found.", "content": { "application/problem+json": { "example": { "detail": "Policy not found", "instance": "/imaging/error-instances/55f404af-a021-4e3c-bbae-2937f95fa280", "requestId": "601c6ce7e3c95084", "status": 404, "title": "Not Found", "type": "/imaging/error-types/IVM_9000" }, "schema": { "additionalProperties": false, "description": "Error messaging.", "type": "object", "properties": { "detail": { "description": "A detailed description of the error.", "type": "string" }, "httpStatus": { "description": "The HTTP code for the error.", "type": "integer" }, "instance": { "description": "A reference to unique instance of the error.", "type": "string" }, "requestId": { "description": "An additional instance identifier for the error.", "type": "string" }, "title": { "description": "The summary description of the error.", "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } } } }, "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "put": { "description": "Run this operation to update an existing policy or create a new policy. Run the [List policies](https://techdocs.akamai.com/ivm/reference/get-policies) operation to get the list of existing policies and their policy IDs. Confirm the `policyId` doesn't already exist.", "operationId": "put-policy", "summary": "Create or modify a policy", "tags": [ "Policies" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Image & Video Manager API", "url": "https://techdocs.akamai.com/ivm/reference/put-policy" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "breakpoints": { "widths": [ 720, 1280, 1920, 5000 ] }, "output": { "perceptualQuality": "mediumHigh" }, "transformations": [ { "gravity": "SouthWest", "transformation": "Composite", "xPosition": 0, "yPosition": 0, "image": { "url": "www.customer.com/watermark.png" } } ] }, "schema": { "x-akamai": { "file-path": "schemas/policy.yaml" }, "oneOf": [ { "description": "Specifies details for each policy, such as variations in image size and formats and the transformations to apply.", "title": "Image policy", "type": "object", "x-akamai": { "file-path": "schemas/policy-image.yaml" }, "allOf": [ { "additionalProperties": false, "type": "object", "properties": { "output": { "additionalProperties": false, "description": "Dictates the output quality, either `quality` or `perceptualQuality`, and the formats created for each resized image. If unspecified, you get image formats that support all browsers at the default quality level of `85`, including WEBP, JPEG2000, and JPEG-XR for specific browsers.", "title": "Output", "type": "object", "properties": { "adaptiveQuality": { "description": "Overrides the quality of the image to serve when Image & Video Manager detects a slow connection with a round-trip time (RTT) of less than 300 ms. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of images for users with standard connections.", "maximum": 100, "minimum": 1, "type": "integer" }, "allowedFormats": { "description": "The graphics file formats allowed for browser specific results, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "minItems": 1, "readOnly": true, "type": "array", "uniqueItems": true, "default": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ], "items": { "description": "The values of the allowed graphics file formats, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "type": "string", "enum": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ] } }, "forcedFormats": { "description": "The forced extra formats for the `imFormat` query parameter, which requests a specific browser type. By default, Image & Video Manager detects the browser and returns the appropriate image.", "readOnly": true, "type": "array", "uniqueItems": true, "default": [], "items": { "description": "The values of the forced extra formats, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "type": "string", "enum": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ] } }, "perceptualQuality": { "description": "Mutually exclusive with `quality`. The perceptual quality to use when comparing resulting images, which overrides the `quality` setting. Perceptual quality tunes each image format's quality dynamically based on the human-perceived quality of the output image. This can result in greater byte savings as compared to using regular `quality` because many images can be encoded at a much lower quality without compromising the perceived quality of the image. In addition, certain images may need to be encoded at a slightly higher quality in order to maintain human-perceived quality. Value tiers are `high`, `mediumHigh`, `medium`, `mediumLow`, and `low`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "perceptualQualityFloor": { "description": "Applies only when `perceptualQuality` is set. Sets a minimum image quality to respect when using perceptual quality. Perceptual quality won't reduce the quality below this value, even if it determines the compressed image to be acceptably visually similar.", "maximum": 100, "minimum": 1, "type": "integer" }, "quality": { "description": "Mutually exclusive with `perceptualQuality`, used by default if neither is specified. The chosen quality of output images from 1-100, with 1 being the lowest quality and 100 being the highest.", "oneOf": [ { "default": 85, "maximum": 100, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } } }, "postBreakpointTransformations": { "description": "Post-processing Transformations are applied to the image after image and quality settings have been applied.", "type": "array", "items": { "description": "A transformation to apply to the image/object/text.", "x-akamai": { "file-path": "schemas/transformation-post-breakpoint.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Places a transparent image on a set background color. Specify the color in CSS hexadecimal format.", "title": "BackgroundColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value for the background.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "BackgroundColor", "description": "Identifies the type of transformation, `BackgroundColor` in this case.", "type": "string", "enum": [ "BackgroundColor" ] } }, "x-akamai": { "file-path": "schemas/t-background-color.yaml" } }, { "additionalProperties": false, "description": "Applies a Gaussian blur to the image.", "title": "Blur", "type": "object", "required": [ "transformation" ], "properties": { "sigma": { "description": "The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.", "oneOf": [ { "default": 5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Blur", "description": "Identifies the type of transformation, `Blur` in this case.", "type": "string", "enum": [ "Blur" ] } }, "x-akamai": { "file-path": "schemas/t-blur.yaml" } }, { "additionalProperties": false, "description": "Changes any color in an image within the specified volume of the HSL colorspace to transparent or semi-transparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.", "title": "ChromaKey", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120\u00b0 on the color wheel.", "oneOf": [ { "default": 120, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueFeather": { "description": "How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30\u00b0 around the Hue Tolerance.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueTolerance": { "description": "How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30\u00b0 around the specified hue.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessFeather": { "description": "How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessTolerance": { "description": "How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a color must be within 75% of the full color to full white or full black for full removal.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationFeather": { "description": "How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the Saturation Tolerance.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationTolerance": { "description": "How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "ChromaKey", "description": "Identifies the type of transformation, `ChromaKey` in this case.", "type": "string", "enum": [ "ChromaKey" ] } }, "x-akamai": { "file-path": "schemas/t-chroma-key.yaml" } }, { "additionalProperties": false, "description": "An ordered combination of transformations to perform. Use to represent a sequence of transformations as a single transformation.", "title": "Compound", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Compound", "description": "Identifies the type of transformation, `Compound` in this case.", "type": "string", "enum": [ "Compound" ] }, "transformations": { "description": "A set of nested image transformations to apply to the source image.", "type": "array", "items": { "type": "object" } } }, "x-akamai": { "file-path": "schemas/t-compound.yaml" } }, { "additionalProperties": false, "description": "Adjusts both the contrast and brightness of an image.", "title": "Contrast", "type": "object", "required": [ "transformation" ], "properties": { "brightness": { "description": "Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of `1` produces a white image. A value of `-1` produces a black image. The default value is `0`, which leaves the image unchanged. The acceptable value range is `-1.0` to `1.0`. Values outside of the acceptable range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "contrast": { "description": "Adjusts the contrast of the image. Expressed as a range from `-1` to `1`, positive values increase contrast, negative values decrease it, while `0` leaves the image unchanged. Values outside of the `-1` to `1` range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Contrast", "description": "Identifies the type of transformation, `Contrast` in this case.", "type": "string", "enum": [ "Contrast" ] } }, "x-akamai": { "file-path": "schemas/t-contrast.yaml" } }, { "additionalProperties": false, "description": "Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears _goopy_. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.", "title": "Goop", "type": "object", "required": [ "transformation" ], "properties": { "chaos": { "description": "Specifies the greatest distance control points may move from their original position. A value of `1.0` shifts control points over as far as the next one in the original grid. A value of `0.0` leaves the image unchanged. Values under `0.5` work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "density": { "description": "Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium- to large-size images.", "oneOf": [ { "default": 4, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "power": { "description": "By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldn't need to vary the default value of `2.0`.", "oneOf": [ { "default": 2, "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "seed": { "description": "Specifies your own `seed` value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used, `Goop` distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Goop", "description": "Identifies the type of transformation, `Goop` in this case.", "type": "string", "enum": [ "Goop" ] } }, "x-akamai": { "file-path": "schemas/t-goop.yaml" } }, { "additionalProperties": false, "description": "Restricts image color to shades of gray only.", "title": "Grayscale", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Grayscale", "description": "Identifies the type of transformation, `Grayscale` in this case.", "type": "string", "enum": [ "Grayscale" ] }, "type": { "default": "Rec709", "description": "The algorithm used to transform colors to grays, either `Brightness`, `Lightness`, `Rec601`, or the default `Rec709`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "Rec601", "Rec709", "Brightness", "Lightness" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-grayscale.yaml" } }, { "additionalProperties": false, "description": "Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as `Grayscale` and `MaxColors`. If you're using more than one, consider the order to apply them for the desired results.", "title": "HSL", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightness": { "description": "A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green, whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than `1.0` decrease the lightness of colors in the image. Values greater than `1.0` increase the lightness of colors in the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSL", "description": "Identifies the type of transformation, `HSL` in this case.", "type": "string", "enum": [ "HSL" ] } }, "x-akamai": { "file-path": "schemas/t-hsl.yaml" } }, { "additionalProperties": false, "description": "Identical to HSL except it replaces `lightness` with `value`. For example, if you reduce the `lightness` of a light green, almost white, image, the color turns a vibrant green. Reducing the `value` turns the image a darker color, close to gray. This happens because the original image color is very close to white.", "title": "HSV", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0.0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSV", "description": "Identifies the type of transformation, `HSV` in this case.", "type": "string", "enum": [ "HSV" ] }, "value": { "description": "A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-hsv.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the dimensions of the source image. You need to select a dimension for comparison, which is either `width` and `height` or `both`.", "title": "IfDimension", "type": "object", "required": [ "transformation", "value" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "dimension": { "description": "The dimension to use to select the transformation, either `height`, `width`, or `both`. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "default": "width", "title": "String", "type": "string", "enum": [ "width", "height", "both" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "equal": { "description": "The transformation performed only if the source image's dimension is equal to the `value` listed.", "type": "object" }, "greaterThan": { "description": "The transformation performed if the source image's dimension is greater than the `value` listed.", "type": "object" }, "lessThan": { "description": "The transformation performed if the source image's dimension is less than the `value` listed.", "type": "object" }, "transformation": { "default": "IfDimension", "description": "Identifies the type of transformation, `IfDimension` in this case.", "type": "string", "enum": [ "IfDimension" ] }, "value": { "description": "The value to compare against the source image dimension. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-if-dimension.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the orientation of the source image. Defaults to the `default` transformation if no transformation is specified for the orientation.", "title": "IfOrientation", "type": "object", "required": [ "transformation" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "landscape": { "description": "The transformation performed if the source image uses landscape orientation.", "type": "object" }, "portrait": { "description": "The transformation performed if the source image uses portrait orientation.", "type": "object" }, "square": { "description": "The transformation performed if the source image uses a square orientation.", "type": "object" }, "transformation": { "default": "IfOrientation", "description": "Identifies the type of transformation, `IfOrientation` in this case.", "type": "string", "enum": [ "IfOrientation" ] } }, "x-akamai": { "file-path": "schemas/t-if-orientation.yaml" } }, { "additionalProperties": false, "description": "Set the maximum number of colors in the image palette. Reducing the number of colors in an image can help to reduce file size.", "title": "MaxColors", "type": "object", "required": [ "transformation", "colors" ], "properties": { "colors": { "description": "The value representing the maximum number of colors to use with the source image.", "oneOf": [ { "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MaxColors", "description": "Identifies the type of transformation, `MaxColors` in this case.", "type": "string", "enum": [ "MaxColors" ] } }, "x-akamai": { "file-path": "schemas/t-max-colors.yaml" } }, { "additionalProperties": false, "description": "Flips an image horizontally, vertically, or both.", "minProperties": 2, "title": "Mirror", "type": "object", "required": [ "transformation" ], "properties": { "horizontal": { "description": "Flips the image horizontally.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Mirror", "description": "Identifies the type of transformation, `Mirror` in this case.", "title": "IfDimension", "type": "string", "enum": [ "Mirror" ] }, "vertical": { "description": "Flips the image vertically.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-mirror.yaml" } }, { "additionalProperties": false, "description": "Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color's lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.", "title": "MonoHue", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MonoHue", "description": "Identifies the type of transformation, `MonoHue` in this case.", "type": "string", "enum": [ "MonoHue" ] } }, "x-akamai": { "file-path": "schemas/t-mono-hue.yaml" } }, { "additionalProperties": false, "description": "Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.", "title": "Opacity", "type": "object", "required": [ "transformation", "opacity" ], "properties": { "opacity": { "description": "Represents alpha values on a scale of `0` to `1`. Values below `1` increase transparency, and `0` is invisible. For images that have some transparency, values above `1` increase the opacity of the transparent portions.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Opacity", "description": "Identifies the type of transformation, `Opacity` in this case.", "type": "string", "enum": [ "Opacity" ] } }, "x-akamai": { "file-path": "schemas/t-opacity.yaml" } }, { "additionalProperties": false, "description": "Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.", "title": "RemoveColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value to remove.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "feather": { "description": "The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent, creating a softer edge. The first real-time request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "tolerance": { "description": "The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.", "oneOf": [ { "default": 0.2, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RemoveColor", "description": "Identifies the type of transformation, `RemoveColor` in this case.", "type": "string", "enum": [ "RemoveColor" ] } }, "x-akamai": { "file-path": "schemas/t-remove-color.yaml" } }, { "additionalProperties": false, "description": "Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as _sharpening_ an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image & Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.", "title": "UnsharpMask", "type": "object", "required": [ "transformation" ], "properties": { "gain": { "description": "Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "sigma": { "description": "The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels, `1.0` by default. High values emphasize large details and low values emphasize small details.", "oneOf": [ { "default": 1, "format": "float", "maximum": 10, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "threshold": { "description": "Set the minimum change required to include a detail in the filter. Higher values discard more changes.", "oneOf": [ { "default": 0.05, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "UnsharpMask", "description": "Identifies the type of transformation, `UnsharpMask` in this case.", "type": "string", "enum": [ "UnsharpMask" ] } }, "x-akamai": { "file-path": "schemas/t-unsharp-mask.yaml" } } ] } }, "transformations": { "description": "Set of image transformations to apply to the source image. If unspecified, no operations are performed.", "type": "array", "items": { "description": "A transformation to apply to the image/object/text.", "x-akamai": { "file-path": "schemas/transformation.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Places a specified `image` beside the source image. The API places the `image` on a major dimension, then aligns it on the minor dimension. Transparent pixels fill any area not covered by either image.", "title": "Append", "type": "object", "required": [ "transformation", "image" ], "properties": { "gravity": { "default": "Center", "description": "Specifies where to place the `image` relative to the source image. The available values represent the eight cardinal directions (`North`, `South`, `East`, `West`, `NorthEast`, `NorthWest`, `SouthEast`, `SouthWest`) and a `Center` by default.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravityPriority": { "description": "Determines the exact placement of the `image` when `gravity` is `Center` or a diagonal. The value is either `horizontal` or `vertical`. Use `horizontal` to append an `image` east or west of the source image. This aligns the `image` on the vertical gravity component, placing `Center` gravity east. Use `vertical` to append an `image` north or south of the source image. This aligns the `image` on the horizontal gravity component, placing `Center` gravity south.", "oneOf": [ { "default": "horizontal", "title": "String enum", "type": "string", "enum": [ "horizontal", "vertical" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "image": { "x-akamai": { "file-path": "schemas/image-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "A rectangular box, with a specified color and applied transformation.", "title": "Box image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the box, not the color of the edges of the box. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Box", "description": "Identifies the type of image, `Box` in this case.", "type": "string", "enum": [ "Box" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-box.yaml" } }, { "additionalProperties": false, "description": "A simple, solid, monochrome circle of a specified diameter on a transparent background.", "title": "Circle image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "diameter": { "description": "The diameter of the circle. The diameter will be the width and the height of the image in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Circle", "description": "Identifies the type of image, `Circle` in this case.", "type": "string", "enum": [ "Circle" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-circle.yaml" } }, { "additionalProperties": false, "description": "A snippet of text. Defines the font family, font size, fill color, outline stroke width, and outline color.", "title": "Text image", "type": "object", "required": [ "type", "text" ], "properties": { "fill": { "description": "The main fill color of the text.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "size": { "description": "The size in pixels to render the text.", "oneOf": [ { "default": 72, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "stroke": { "description": "The color of the outline of the text.", "oneOf": [ { "default": "#FFF", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "strokeSize": { "description": "The thickness in points of the outline of the text.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "text": { "description": "The line of text to render.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Text", "description": "Identifies the type of image, `Text` in this case.", "type": "string", "enum": [ "Text" ] }, "typeface": { "description": "The font family to apply to the text image. This may be the URL of a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.", "oneOf": [ { "default": "DejaVuSans", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-text.yaml" } }, { "additionalProperties": false, "description": "An image loaded from a URL.", "title": "URL image", "type": "object", "required": [ "url" ], "properties": { "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "URL", "description": "Identifies the type of image, `URL` in this case.", "type": "string", "enum": [ "URL" ] }, "url": { "description": "The URL of the image.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-url.yaml" } } ] }, "preserveMinorDimension": { "description": "Whether to preserve the source image's minor dimension, `false` by default. The minor dimension is the dimension opposite the dimension that the appending `image` is placed. For example, the dimensions of the source image are 100 × 100 pixels. The dimensions of the appending `image` are 50 × 150 pixels. The `gravity` is set to `East`. This makes the major dimension horizontal and the source image's minor dimension vertical. To preserve the source image's minor dimension at 100 pixels, the `preserveMinorDimension` is set to `true`. As a result of the append, the major dimension expanded with the appended image to 150 pixels. The source image's minor dimension was maintained at 100 pixels. The total combined dimension of the image is 150 × 100 pixels.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Append", "description": "Identifies the type of transformation, `Append` in this case.", "type": "string", "enum": [ "Append" ] } }, "x-akamai": { "file-path": "schemas/t-append.yaml" } }, { "additionalProperties": false, "description": "Changes the height or width of an image, either by cropping or expanding the area, to an aspect ratio of your choosing.", "title": "AspectCrop", "type": "object", "required": [ "transformation" ], "properties": { "allowExpansion": { "description": "Increases the size of the image canvas to achieve the requested aspect ratio instead of cropping the image. Use the Horizontal Offset and Vertical Offset settings to determine where to add the fully transparent pixels on the expanded image canvas.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height term of the aspect ratio to crop.", "oneOf": [ { "default": 1, "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "AspectCrop", "description": "Identifies the type of transformation, `AspectCrop` in this case.", "type": "string", "enum": [ "AspectCrop" ] }, "width": { "description": "The width term of the aspect ratio to crop.", "oneOf": [ { "default": 1, "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "xPosition": { "description": "Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.", "oneOf": [ { "default": 0.5, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "description": "Specifies the horizontal portion of the image you want to keep when cropping by aspect ratio crop. When using `allowExpansion`, this setting defines the horizontal position of the image on the new expanded image canvas.", "oneOf": [ { "default": 0.5, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-aspect-crop.yaml" } }, { "additionalProperties": false, "description": "Places a transparent image on a set background color. Specify the color in CSS hexadecimal format.", "title": "BackgroundColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value for the background.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "BackgroundColor", "description": "Identifies the type of transformation, `BackgroundColor` in this case.", "type": "string", "enum": [ "BackgroundColor" ] } }, "x-akamai": { "file-path": "schemas/t-background-color.yaml" } }, { "additionalProperties": false, "description": "Applies a Gaussian blur to the image.", "title": "Blur", "type": "object", "required": [ "transformation" ], "properties": { "sigma": { "description": "The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.", "oneOf": [ { "default": 5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Blur", "description": "Identifies the type of transformation, `Blur` in this case.", "type": "string", "enum": [ "Blur" ] } }, "x-akamai": { "file-path": "schemas/t-blur.yaml" } }, { "additionalProperties": false, "description": "Changes any color in an image within the specified volume of the HSL colorspace to transparent or semi-transparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.", "title": "ChromaKey", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120\u00b0 on the color wheel.", "oneOf": [ { "default": 120, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueFeather": { "description": "How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30\u00b0 around the Hue Tolerance.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueTolerance": { "description": "How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30\u00b0 around the specified hue.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessFeather": { "description": "How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessTolerance": { "description": "How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a color must be within 75% of the full color to full white or full black for full removal.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationFeather": { "description": "How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the Saturation Tolerance.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationTolerance": { "description": "How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "ChromaKey", "description": "Identifies the type of transformation, `ChromaKey` in this case.", "type": "string", "enum": [ "ChromaKey" ] } }, "x-akamai": { "file-path": "schemas/t-chroma-key.yaml" } }, { "additionalProperties": false, "description": "Applies another image to the source image, either as an overlay or an underlay. The image that's underneath is visible in areas that are beyond the edges of the top image or that are less than 100% opaque. A common use of an overlay composite is to add a watermark.", "title": "Composite", "type": "object", "required": [ "transformation", "image" ], "properties": { "gravity": { "default": "NorthWest", "description": "Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "image": { "x-akamai": { "file-path": "schemas/image-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "A rectangular box, with a specified color and applied transformation.", "title": "Box image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the box, not the color of the edges of the box. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Box", "description": "Identifies the type of image, `Box` in this case.", "type": "string", "enum": [ "Box" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-box.yaml" } }, { "additionalProperties": false, "description": "A simple, solid, monochrome circle of a specified diameter on a transparent background.", "title": "Circle image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "diameter": { "description": "The diameter of the circle. The diameter will be the width and the height of the image in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Circle", "description": "Identifies the type of image, `Circle` in this case.", "type": "string", "enum": [ "Circle" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-circle.yaml" } }, { "additionalProperties": false, "description": "A snippet of text. Defines the font family, font size, fill color, outline stroke width, and outline color.", "title": "Text image", "type": "object", "required": [ "type", "text" ], "properties": { "fill": { "description": "The main fill color of the text.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "size": { "description": "The size in pixels to render the text.", "oneOf": [ { "default": 72, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "stroke": { "description": "The color of the outline of the text.", "oneOf": [ { "default": "#FFF", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "strokeSize": { "description": "The thickness in points of the outline of the text.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "text": { "description": "The line of text to render.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Text", "description": "Identifies the type of image, `Text` in this case.", "type": "string", "enum": [ "Text" ] }, "typeface": { "description": "The font family to apply to the text image. This may be the URL of a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.", "oneOf": [ { "default": "DejaVuSans", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-text.yaml" } }, { "additionalProperties": false, "description": "An image loaded from a URL.", "title": "URL image", "type": "object", "required": [ "url" ], "properties": { "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "URL", "description": "Identifies the type of image, `URL` in this case.", "type": "string", "enum": [ "URL" ] }, "url": { "description": "The URL of the image.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-url.yaml" } } ] }, "placement": { "description": "Where to place the specified image, either `Over` or `Under` the existing image. Watermarks are usually applied over. Backgrounds are usually applied under.", "oneOf": [ { "default": "Over", "title": "String enum", "type": "string", "enum": [ "Over", "Under", "Mask", "Stencil" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "scale": { "description": "A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the `scaleDimension` to calculate the `scale` from the source image's width or height.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "scaleDimension": { "description": "The dimension, either `width` or `height`, of the source image to scale.", "oneOf": [ { "default": "width", "title": "String enum", "type": "string", "enum": [ "width", "height" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Composite", "description": "Identifies the type of transformation, `Composite` in this case.", "type": "string", "enum": [ "Composite" ] }, "xPosition": { "description": "The x-axis position of the image to apply.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "default": 0, "description": "The y-axis position of the image to apply.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-composite.yaml" } }, { "additionalProperties": false, "description": "An ordered combination of transformations to perform. Use to represent a sequence of transformations as a single transformation.", "title": "Compound", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Compound", "description": "Identifies the type of transformation, `Compound` in this case.", "type": "string", "enum": [ "Compound" ] }, "transformations": { "description": "A set of nested image transformations to apply to the source image.", "type": "array", "items": { "type": "object" } } }, "x-akamai": { "file-path": "schemas/t-compound.yaml" } }, { "additionalProperties": false, "description": "Adjusts both the contrast and brightness of an image.", "title": "Contrast", "type": "object", "required": [ "transformation" ], "properties": { "brightness": { "description": "Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of `1` produces a white image. A value of `-1` produces a black image. The default value is `0`, which leaves the image unchanged. The acceptable value range is `-1.0` to `1.0`. Values outside of the acceptable range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "contrast": { "description": "Adjusts the contrast of the image. Expressed as a range from `-1` to `1`, positive values increase contrast, negative values decrease it, while `0` leaves the image unchanged. Values outside of the `-1` to `1` range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Contrast", "description": "Identifies the type of transformation, `Contrast` in this case.", "type": "string", "enum": [ "Contrast" ] } }, "x-akamai": { "file-path": "schemas/t-contrast.yaml" } }, { "additionalProperties": false, "description": "Crops an image.", "title": "Crop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "allowExpansion": { "description": "If cropping an area outside of the existing canvas, expands the image canvas.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "NorthWest", "description": "Frame of reference for X and Y positions.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The number of pixels to crop along the y-axis.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Crop", "description": "Identifies the type of transformation, `Crop` in this case.", "type": "string", "enum": [ "Crop" ] }, "width": { "description": "The number of pixels to crop along the x-axis.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "xPosition": { "description": "The x-axis position of the image to crop from.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "description": "The y-axis position of the image to crop from.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-crop.yaml" } }, { "additionalProperties": false, "description": "Applies a method to detect faces in the source image and applies the rectangular crop on either the `biggest` face or `all` of the faces detected. Image & Video Manager tries to preserve faces in the image instead of using specified crop coordinates.", "title": "FaceCrop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "algorithm": { "description": "Specifies the type of algorithm used to detect faces in the image, either `cascade` for the cascade classifier algorithm or `dnn` for the deep neural network algorithm, `cascade` by default.", "oneOf": [ { "default": "cascade", "title": "String enum", "type": "string", "enum": [ "cascade", "dnn" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "confidence": { "description": "With `algorithm` set to `dnn`, specifies the minimum confidence needed to detect faces in the image. Values range from `0` to `1` for increased confidence, and possibly fewer faces detected.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "failGravity": { "default": "Center", "description": "Controls placement of the crop if Image & Video Manager does not detect any faces in the image. Directions are relative to the edges of the image being transformed.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "focus": { "description": "Distinguishes the faces detected, either `biggestFace` or `allFaces` to place the crop rectangle around the full set of faces. This is `all` by default.", "oneOf": [ { "default": "allFaces", "title": "String enum", "type": "string", "enum": [ "allFaces", "biggestFace" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "Center", "description": "Controls placement of the crop. Directions are relative to the face, plus padding.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the output image in pixels relative to the specified `style` value.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "The padding ratio based on the dimensions of the biggest face detected, `0.5` by default. Larger values increase padding.", "oneOf": [ { "default": 0.5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the faces detected in the source image, `zoom` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` places a raw crop around the faces, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and faces as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the faces, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "zoom", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FaceCrop", "description": "Identifies the type of transformation, `FaceCrop` in this case.", "type": "string", "enum": [ "FaceCrop" ] }, "width": { "description": "The width of the output image in pixels relative to the specified `style` value.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-face-crop.yaml" } }, { "additionalProperties": false, "description": "Identifies prominent features of the source image, then crops around as many of these features as possible relative to the specified `width` and `height` values.", "title": "FeatureCrop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "failGravity": { "default": "Center", "description": "Controls placement of the crop if Image & Video Manager does not detect any features in the image. Directions are relative to the edges of the image being transformed.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "featureRadius": { "description": "The size in pixels of the important features to search for. If identified, two features never appear closer together than this value, `8.0` by default.", "oneOf": [ { "default": 8, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "Center", "description": "Controls placement of the crop. Directions are relative to the region of interest plus padding.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "maxFeatures": { "description": "The maximum number of features to identify as important features, `32` by default. The strongest features are always chosen.", "oneOf": [ { "default": 32, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "minFeatureQuality": { "description": "Determines the minimum quality level of the feature identified. To consider a feature important, the feature needs to surpass this value. Image & Video Manager measures quality on a scale from `0` for the lowest quality to `1` for the highest quality, `.1` by default.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "Adds space around the region of interest. The amount of padding added is directly related to the size of the bounding box of the selected features. Specifically, the region of interest is expanded in all directions by the largest dimension of the bounding box of the selected features multiplied by this value.", "oneOf": [ { "default": 0.05, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the features identified in the source image, `fill` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` performs a raw crop around the features, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and features as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the features, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "zoom", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FeatureCrop", "description": "Identifies the type of transformation, `FeatureCrop` in this case.", "type": "string", "enum": [ "FeatureCrop" ] }, "width": { "description": "The width in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-feature-crop.yaml" } }, { "additionalProperties": false, "description": "Resizes an image to fit within a specific size box and then uses a fill of that same image to cover any transparent space at the edges. By default the fill image has a Blur transformation with a sigma value of 8 applied. Customize the transformation using the `fillTransformation` parameter.", "title": "FitAndFill", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "fillTransformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "height": { "description": "The height value of the resized image.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FitAndFill", "description": "Identifies the type of transformation, `FitAndFill` in this case.", "type": "string", "enum": [ "FitAndFill" ] }, "width": { "description": "The width value of the resized image.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-fit-and-fill.yaml" } }, { "additionalProperties": false, "description": "Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears _goopy_. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.", "title": "Goop", "type": "object", "required": [ "transformation" ], "properties": { "chaos": { "description": "Specifies the greatest distance control points may move from their original position. A value of `1.0` shifts control points over as far as the next one in the original grid. A value of `0.0` leaves the image unchanged. Values under `0.5` work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "density": { "description": "Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium- to large-size images.", "oneOf": [ { "default": 4, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "power": { "description": "By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldn't need to vary the default value of `2.0`.", "oneOf": [ { "default": 2, "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "seed": { "description": "Specifies your own `seed` value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used, `Goop` distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Goop", "description": "Identifies the type of transformation, `Goop` in this case.", "type": "string", "enum": [ "Goop" ] } }, "x-akamai": { "file-path": "schemas/t-goop.yaml" } }, { "additionalProperties": false, "description": "Restricts image color to shades of gray only.", "title": "Grayscale", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Grayscale", "description": "Identifies the type of transformation, `Grayscale` in this case.", "type": "string", "enum": [ "Grayscale" ] }, "type": { "default": "Rec709", "description": "The algorithm used to transform colors to grays, either `Brightness`, `Lightness`, `Rec601`, or the default `Rec709`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "Rec601", "Rec709", "Brightness", "Lightness" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-grayscale.yaml" } }, { "additionalProperties": false, "description": "Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as `Grayscale` and `MaxColors`. If you're using more than one, consider the order to apply them for the desired results.", "title": "HSL", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightness": { "description": "A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green, whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than `1.0` decrease the lightness of colors in the image. Values greater than `1.0` increase the lightness of colors in the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSL", "description": "Identifies the type of transformation, `HSL` in this case.", "type": "string", "enum": [ "HSL" ] } }, "x-akamai": { "file-path": "schemas/t-hsl.yaml" } }, { "additionalProperties": false, "description": "Identical to HSL except it replaces `lightness` with `value`. For example, if you reduce the `lightness` of a light green, almost white, image, the color turns a vibrant green. Reducing the `value` turns the image a darker color, close to gray. This happens because the original image color is very close to white.", "title": "HSV", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0.0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSV", "description": "Identifies the type of transformation, `HSV` in this case.", "type": "string", "enum": [ "HSV" ] }, "value": { "description": "A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-hsv.yaml" } }, { "additionalProperties": false, "description": "Apply artistic transformations to images quickly and dynamically by specifying transformations with a query string appended to the image URL.\n- transformation\n- query\n- allowedTransformations", "title": "ImQuery", "type": "object", "properties": { "allowedTransformations": { "description": "Specifies the transformations that can be applied using the query string parameter.", "type": "array", "items": { "type": "string", "enum": [ "Append", "AspectCrop", "BackgroundColor", "Blur", "Composite", "Contrast", "Crop", "ChromaKey", "FaceCrop", "FeatureCrop", "FitAndFill", "Goop", "Grayscale", "HSL", "HSV", "MaxColors", "Mirror", "MonoHue", "Opacity", "RegionOfInterestCrop", "RelativeCrop", "RemoveColor", "Resize", "Rotate", "Scale", "Shear", "Trim", "UnsharpMask", "IfDimension", "IfOrientation" ] } }, "query": { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } }, "transformation": { "default": "ImQuery", "description": "Identifies the type of transformation, `ImQuery` in this case.", "type": "string", "enum": [ "ImQuery" ] } }, "x-akamai": { "file-path": "schemas/t-im-query.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the dimensions of the source image. You need to select a dimension for comparison, which is either `width` and `height` or `both`.", "title": "IfDimension", "type": "object", "required": [ "transformation", "value" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "dimension": { "description": "The dimension to use to select the transformation, either `height`, `width`, or `both`. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "default": "width", "title": "String", "type": "string", "enum": [ "width", "height", "both" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "equal": { "description": "The transformation performed only if the source image's dimension is equal to the `value` listed.", "type": "object" }, "greaterThan": { "description": "The transformation performed if the source image's dimension is greater than the `value` listed.", "type": "object" }, "lessThan": { "description": "The transformation performed if the source image's dimension is less than the `value` listed.", "type": "object" }, "transformation": { "default": "IfDimension", "description": "Identifies the type of transformation, `IfDimension` in this case.", "type": "string", "enum": [ "IfDimension" ] }, "value": { "description": "The value to compare against the source image dimension. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-if-dimension.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the orientation of the source image. Defaults to the `default` transformation if no transformation is specified for the orientation.", "title": "IfOrientation", "type": "object", "required": [ "transformation" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "landscape": { "description": "The transformation performed if the source image uses landscape orientation.", "type": "object" }, "portrait": { "description": "The transformation performed if the source image uses portrait orientation.", "type": "object" }, "square": { "description": "The transformation performed if the source image uses a square orientation.", "type": "object" }, "transformation": { "default": "IfOrientation", "description": "Identifies the type of transformation, `IfOrientation` in this case.", "type": "string", "enum": [ "IfOrientation" ] } }, "x-akamai": { "file-path": "schemas/t-if-orientation.yaml" } }, { "additionalProperties": false, "description": "Set the maximum number of colors in the image palette. Reducing the number of colors in an image can help to reduce file size.", "title": "MaxColors", "type": "object", "required": [ "transformation", "colors" ], "properties": { "colors": { "description": "The value representing the maximum number of colors to use with the source image.", "oneOf": [ { "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MaxColors", "description": "Identifies the type of transformation, `MaxColors` in this case.", "type": "string", "enum": [ "MaxColors" ] } }, "x-akamai": { "file-path": "schemas/t-max-colors.yaml" } }, { "additionalProperties": false, "description": "Flips an image horizontally, vertically, or both.", "minProperties": 2, "title": "Mirror", "type": "object", "required": [ "transformation" ], "properties": { "horizontal": { "description": "Flips the image horizontally.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Mirror", "description": "Identifies the type of transformation, `Mirror` in this case.", "title": "IfDimension", "type": "string", "enum": [ "Mirror" ] }, "vertical": { "description": "Flips the image vertically.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-mirror.yaml" } }, { "additionalProperties": false, "description": "Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color's lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.", "title": "MonoHue", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MonoHue", "description": "Identifies the type of transformation, `MonoHue` in this case.", "type": "string", "enum": [ "MonoHue" ] } }, "x-akamai": { "file-path": "schemas/t-mono-hue.yaml" } }, { "additionalProperties": false, "description": "Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.", "title": "Opacity", "type": "object", "required": [ "transformation", "opacity" ], "properties": { "opacity": { "description": "Represents alpha values on a scale of `0` to `1`. Values below `1` increase transparency, and `0` is invisible. For images that have some transparency, values above `1` increase the opacity of the transparent portions.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Opacity", "description": "Identifies the type of transformation, `Opacity` in this case.", "type": "string", "enum": [ "Opacity" ] } }, "x-akamai": { "file-path": "schemas/t-opacity.yaml" } }, { "additionalProperties": false, "description": "Crops to a region around a specified area of interest relative to the specified `width` and `height` values.", "title": "RegionOfInterestCrop", "type": "object", "required": [ "transformation", "width", "height", "regionOfInterest" ], "properties": { "gravity": { "default": "Center", "description": "The placement of the crop area relative to the specified area of interest.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "regionOfInterest": { "x-akamai": { "file-path": "schemas/shape-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Defines a circle with a specified `radius` from its `center` point.", "title": "Circle", "type": "object", "required": [ "center", "radius" ], "properties": { "center": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, "radius": { "description": "The radius of the circle measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-circle.yaml" } }, { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, { "additionalProperties": false, "description": "Defines a polygon from a series of connected points.", "title": "Polygon", "type": "object", "required": [ "points" ], "properties": { "points": { "description": "Series of PointShapeType objects. The last and first points connect to close the shape automatically.", "type": "array", "items": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } } } }, "x-akamai": { "file-path": "schemas/shape-type-polygon.yaml" } }, { "additionalProperties": false, "description": "Defines a rectangle's `width` and `height` relative to an `anchor` point at the top left corner.", "title": "Rectangle", "type": "object", "required": [ "anchor", "width", "height" ], "properties": { "anchor": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, "height": { "description": "Extends the rectangle down from the `anchor` point.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "width": { "description": "Extends the rectangle right from the `anchor` point.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-rectangle.yaml" } }, { "additionalProperties": false, "description": "Identifies a combined shape based on a set of other shapes.", "title": "Union", "type": "object", "required": [ "shapes" ], "properties": { "shapes": { "description": "A nested shape used to describe a more complex shape.", "type": "array", "items": { "description": "A nested shape used to describe a more complex shape.", "title": "Nested shape", "type": "object", "x-akamai": { "file-path": "schemas/shape-type-nested.yaml" } } } }, "x-akamai": { "file-path": "schemas/shape-type-union.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the specified area of interest in the source image, `zoom` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` places raw crop around the point of interest, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and point of interest as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the point of interest, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "fill", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RegionOfInterestCrop", "description": "Identifies the type of transformation, `RegionOfInterestCrop` in this case.", "type": "string", "enum": [ "RegionOfInterestCrop" ] }, "width": { "description": "The width in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-region-of-interest-crop.yaml" } }, { "additionalProperties": false, "description": "Shrinks or expands an image relative to the image's specified dimensions. Image & Video Manager fills the expanded areas with transparency. Positive values shrink the side, while negative values expand it.", "title": "RelativeCrop", "type": "object", "required": [ "transformation" ], "properties": { "east": { "description": "The number of pixels to shrink or expand the right side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "north": { "description": "The number of pixels to shrink or expand the top side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "south": { "description": "The number of pixels to shrink or expand the bottom side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RelativeCrop", "description": "Identifies the type of transformation, `RelativeCrop` in this case.", "type": "string", "enum": [ "RelativeCrop" ] }, "west": { "description": "The number of pixels to shrink or expand the left side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-relative-crop.yaml" } }, { "additionalProperties": false, "description": "Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.", "title": "RemoveColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value to remove.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "feather": { "description": "The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent, creating a softer edge. The first real-time request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "tolerance": { "description": "The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.", "oneOf": [ { "default": 0.2, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RemoveColor", "description": "Identifies the type of transformation, `RemoveColor` in this case.", "type": "string", "enum": [ "RemoveColor" ] } }, "x-akamai": { "file-path": "schemas/t-remove-color.yaml" } }, { "additionalProperties": false, "description": "Resizes an image to a particular, absolute dimension. If you don't enter a `width` or a `height`, the image is resized with the `fit` aspect preservation mode, which selects a value for the missing dimension that preserves the image's aspect.", "title": "Resize", "type": "object", "required": [ "transformation" ], "properties": { "aspect": { "description": "Preserves the aspect ratio. Select `fit` to make the image fit entirely within the selected width and height. When using `fit`, the resulting image has the largest possible size for the specified dimensions. Select `fill` to size the image so it both completely fills the dimensions and has the smallest possible file size. Otherwise `ignore` changes the original aspect ratio to fit within an arbitrarily shaped rectangle.", "oneOf": [ { "default": "fit", "title": "String enum", "type": "string", "enum": [ "fit", "fill", "ignore" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height to resize the source image to. Must be set if `width` is not specified.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Resize", "description": "Identifies the type of transformation, `Resize` in this case.", "type": "string", "enum": [ "Resize" ] }, "type": { "description": "Sets constraints for the image resize. Select `normal` to resize in all cases, either increasing or decreasing the dimensions. Select `downsize` to ignore this transformation if the result would be larger than the original. Select `upsize` to ignore this transformation if the result would be smaller.", "oneOf": [ { "default": "normal", "title": "String enum", "type": "string", "enum": [ "normal", "upsize", "downsize" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "width": { "description": "The width to resize the source image to. Must be set if `height` is not specified.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-resize.yaml" } }, { "additionalProperties": false, "description": "Rotate the image around its center by indicating the degrees of rotation.", "title": "Rotate", "type": "object", "required": [ "transformation", "degrees" ], "properties": { "degrees": { "description": "The value to rotate the image by. Positive values rotate clockwise, while negative values rotate counter-clockwise.", "oneOf": [ { "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Rotate", "description": "Identifies the type of transformation, `Rotate` in this case.", "type": "string", "enum": [ "Rotate" ] } }, "x-akamai": { "file-path": "schemas/t-rotate.yaml" } }, { "additionalProperties": false, "description": "Changes the image's size to different dimensions relative to its starting size.", "title": "Scale", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "height": { "description": "Scaling factor for the input height to determine the output height of the image, where values between `0` and `1` decrease size. Image dimensions need to be non-zero positive numbers.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Scale", "description": "Identifies the type of transformation, `Scale` in this case.", "type": "string", "enum": [ "Scale" ] }, "width": { "description": "Scaling factor for the input width to determine the output width of the image, where `1` leaves the width unchanged. Values greater than `1` increase the image size. Image dimensions need to be non-zero positive numbers.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-scale.yaml" } }, { "additionalProperties": false, "description": "Slants an image into a parallelogram, as a percent of the starting dimension as represented in decimal format. You need to specify at least one axis property. Transparent pixels fill empty areas around the sheared image as needed, so it's often useful to use a `BackgroundColor` transformation for these areas.", "title": "Shear", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Shear", "description": "Identifies the type of transformation, `Shear` in this case.", "type": "string", "enum": [ "Shear" ] }, "xShear": { "description": "The amount to shear along the x-axis, measured in multiples of the image's width. Required if `yShear` is not specified.", "oneOf": [ { "default": 0, "format": "float", "maximum": 5, "minimum": -5, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yShear": { "description": "The amount to shear along the y-axis, measured in multiples of the image's height. Required if `xShear` is not specified.", "oneOf": [ { "default": 0, "format": "float", "maximum": 5, "minimum": -5, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-shear.yaml" } }, { "additionalProperties": false, "description": "Automatically crops uniform backgrounds from the edges of an image.", "title": "Trim", "type": "object", "required": [ "transformation" ], "properties": { "fuzz": { "description": "The fuzz tolerance of the trim, a value between `0` and `1` that determines the acceptable amount of background variation before trimming stops.", "oneOf": [ { "default": 0.08, "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "The amount of padding in pixels to add to the trimmed image.", "oneOf": [ { "default": 0, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Trim", "description": "Identifies the type of transformation, `Trim` in this case.", "type": "string", "enum": [ "Trim" ] } }, "x-akamai": { "file-path": "schemas/t-trim.yaml" } }, { "additionalProperties": false, "description": "Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as _sharpening_ an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image & Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.", "title": "UnsharpMask", "type": "object", "required": [ "transformation" ], "properties": { "gain": { "description": "Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "sigma": { "description": "The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels, `1.0` by default. High values emphasize large details and low values emphasize small details.", "oneOf": [ { "default": 1, "format": "float", "maximum": 10, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "threshold": { "description": "Set the minimum change required to include a detail in the filter. Higher values discard more changes.", "oneOf": [ { "default": 0.05, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "UnsharpMask", "description": "Identifies the type of transformation, `UnsharpMask` in this case.", "type": "string", "enum": [ "UnsharpMask" ] } }, "x-akamai": { "file-path": "schemas/t-unsharp-mask.yaml" } } ] } }, "video": { "default": false, "description": "Identifies this as an image policy.", "readOnly": true, "type": "boolean", "enum": [ false ] } }, "x-akamai": { "file-path": "schemas/policy-image-specific.yaml" } }, { "additionalProperties": false, "properties": { "breakpoints": { "additionalProperties": false, "description": "The breakpoint widths (in pixels) to use to create derivative images or videos.", "title": "Breakpoints", "type": "object", "properties": { "widths": { "description": "Specifies each integer breakpoint width value.", "minItems": 1, "type": "array", "items": { "maximum": 5000, "minimum": 1, "type": "integer" } } } }, "dateCreated": { "description": "Date this policy version was created in ISO 8601 extended notation format.", "readOnly": true, "type": "string" }, "hosts": { "description": "Hosts that are allowed for image or video URLs within transformations or variables.", "type": "array", "items": { "type": "string" } }, "id": { "description": "Unique identifier for a policy which can be up to 64 alphanumeric characters and can include underscores or dashes.", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "readOnly": true, "type": "string" }, "previousVersion": { "description": "The previous version number of this policy version.", "readOnly": true, "type": "integer" }, "rolloutDuration": { "default": 3600, "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. This value has no effect on the staging network.", "maximum": 604800, "minimum": 3600, "type": "integer", "writeOnly": true }, "rolloutInfo": { "additionalProperties": false, "description": "Contains information about policy rollout start and completion times.", "readOnly": true, "type": "object", "properties": { "endTime": { "description": "The estimated time that rollout for this policy will end in UNIX timestamp format.", "type": "integer" }, "rolloutDuration": { "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. Policies on the staging network deploy as quickly as possible without rollout. For staging policies this value will always be 1.", "maximum": 604800, "minimum": 3600, "type": "integer" }, "startTime": { "description": "The estimated time that rollout for this policy will begin in UNIX timestamp format.", "type": "integer" } } }, "user": { "description": "The user who created this policy version.", "readOnly": true, "type": "string" }, "variables": { "description": "Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as an Inline Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.", "type": "array", "items": { "additionalProperties": false, "title": "Variable", "type": "object", "required": [ "name", "type", "defaultValue" ], "properties": { "defaultValue": { "description": "The default value of the variable if no query parameter is provided. It needs to be one of the `enumOptions` if any are provided.", "type": "string" }, "enumOptions": { "description": "Optionally limits the set of possible values for a variable. References to an enum `id` insert a corresponding `value`.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "id", "value" ], "properties": { "id": { "description": "The unique identifier for each enum value, up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "value": { "description": "The value of the variable when the `id` is provided.", "type": "string" } } } }, "name": { "description": "The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "postfix": { "description": "A postfix added to the value provided for the variable, or to the default value.", "type": "string" }, "prefix": { "description": "A prefix added to the value provided for the variable, or to the default value.", "type": "string" }, "type": { "description": "The type of value for the variable, either `bool`, `number`, `url`, `color`, `gravity`, `placement`, `scaleDimension`, `grayscaleType`, `aspect`, `resizeType`, `dimension`, `perceptualQuality`, `string`, or `focus`.", "type": "string", "enum": [ "bool", "number", "url", "color", "gravity", "placement", "scaleDimension", "grayscaleType", "aspect", "resizeType", "dimension", "perceptualQuality", "string", "focus" ] } }, "x-akamai": { "file-path": "schemas/variable.yaml" } } }, "version": { "description": "The version number of this policy version.", "readOnly": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/policy-shared.yaml" } } ] }, { "description": "Specifies details for each policy such as video size.", "title": "Video policy", "type": "object", "x-akamai": { "file-path": "schemas/policy-video.yaml" }, "allOf": [ { "additionalProperties": false, "type": "object", "properties": { "output": { "additionalProperties": false, "description": "Dictates the output quality for each resized video.", "title": "Output", "type": "object", "properties": { "perceptualQuality": { "description": "The quality of derivative videos. High preserves video quality with reduced byte savings while low reduces video quality to increase byte savings.", "oneOf": [ { "default": "medium", "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "placeholderVideoUrl": { "description": "Allows you to add a specific placeholder video that appears when a user first requests a video, but before Image & Video Manager processes the video. If not specified the original video plays during the processing time.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "videoAdaptiveQuality": { "description": "Overrides the quality of video to serve when Image & Video Manager detects a slow connection with a round-trip time (RTT) of 300 ms. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of videos for users with faster connections.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } } }, "video": { "default": true, "description": "Identifies this as a video policy.", "readOnly": true, "type": "boolean", "enum": [ true ] } }, "x-akamai": { "file-path": "schemas/policy-video-specific.yaml" } }, { "additionalProperties": false, "properties": { "breakpoints": { "additionalProperties": false, "description": "The breakpoint widths (in pixels) to use to create derivative images or videos.", "title": "Breakpoints", "type": "object", "properties": { "widths": { "description": "Specifies each integer breakpoint width value.", "minItems": 1, "type": "array", "items": { "maximum": 5000, "minimum": 1, "type": "integer" } } } }, "dateCreated": { "description": "Date this policy version was created in ISO 8601 extended notation format.", "readOnly": true, "type": "string" }, "hosts": { "description": "Hosts that are allowed for image or video URLs within transformations or variables.", "type": "array", "items": { "type": "string" } }, "id": { "description": "Unique identifier for a policy which can be up to 64 alphanumeric characters and can include underscores or dashes.", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "readOnly": true, "type": "string" }, "previousVersion": { "description": "The previous version number of this policy version.", "readOnly": true, "type": "integer" }, "rolloutDuration": { "default": 3600, "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. This value has no effect on the staging network.", "maximum": 604800, "minimum": 3600, "type": "integer", "writeOnly": true }, "rolloutInfo": { "additionalProperties": false, "description": "Contains information about policy rollout start and completion times.", "readOnly": true, "type": "object", "properties": { "endTime": { "description": "The estimated time that rollout for this policy will end in UNIX timestamp format.", "type": "integer" }, "rolloutDuration": { "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. Policies on the staging network deploy as quickly as possible without rollout. For staging policies this value will always be 1.", "maximum": 604800, "minimum": 3600, "type": "integer" }, "startTime": { "description": "The estimated time that rollout for this policy will begin in UNIX timestamp format.", "type": "integer" } } }, "user": { "description": "The user who created this policy version.", "readOnly": true, "type": "string" }, "variables": { "description": "Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as an Inline Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.", "type": "array", "items": { "additionalProperties": false, "title": "Variable", "type": "object", "required": [ "name", "type", "defaultValue" ], "properties": { "defaultValue": { "description": "The default value of the variable if no query parameter is provided. It needs to be one of the `enumOptions` if any are provided.", "type": "string" }, "enumOptions": { "description": "Optionally limits the set of possible values for a variable. References to an enum `id` insert a corresponding `value`.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "id", "value" ], "properties": { "id": { "description": "The unique identifier for each enum value, up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "value": { "description": "The value of the variable when the `id` is provided.", "type": "string" } } } }, "name": { "description": "The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "postfix": { "description": "A postfix added to the value provided for the variable, or to the default value.", "type": "string" }, "prefix": { "description": "A prefix added to the value provided for the variable, or to the default value.", "type": "string" }, "type": { "description": "The type of value for the variable, either `bool`, `number`, `url`, `color`, `gravity`, `placement`, `scaleDimension`, `grayscaleType`, `aspect`, `resizeType`, `dimension`, `perceptualQuality`, `string`, or `focus`.", "type": "string", "enum": [ "bool", "number", "url", "color", "gravity", "placement", "scaleDimension", "grayscaleType", "aspect", "resizeType", "dimension", "perceptualQuality", "string", "focus" ] } }, "x-akamai": { "file-path": "schemas/variable.yaml" } } }, "version": { "description": "The version number of this policy version.", "readOnly": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/policy-shared.yaml" } } ] } ] } } } }, "responses": { "200": { "description": "Policy updated.", "content": { "application/json": { "example": { "description": "Policy `watermark` updated.", "id": "watermark", "operationPerformed": "UPDATED" }, "schema": { "additionalProperties": false, "description": "The type of operation performed on an Image & Video Manager resource.", "type": "object", "properties": { "description": { "description": "The description of the resource.", "type": "string" }, "id": { "description": "Unique identifier for a resource.", "type": "string" }, "operationPerformed": { "description": "The action performed on the resource, either `CREATED`, `UPDATED`, `DELETED`, or `CANCELLED`.", "type": "string", "enum": [ "CREATED", "UPDATED", "DELETED", "CANCELLED" ] } }, "x-akamai": { "file-path": "schemas/operation-performed.yaml" } } } } }, "201": { "description": "Policy created.", "content": { "application/json": { "example": { "description": "Policy `watermark` created.", "id": "watermark", "operationPerformed": "CREATED" }, "schema": { "additionalProperties": false, "description": "The type of operation performed on an Image & Video Manager resource.", "type": "object", "properties": { "description": { "description": "The description of the resource.", "type": "string" }, "id": { "description": "Unique identifier for a resource.", "type": "string" }, "operationPerformed": { "description": "The action performed on the resource, either `CREATED`, `UPDATED`, `DELETED`, or `CANCELLED`.", "type": "string", "enum": [ "CREATED", "UPDATED", "DELETED", "CANCELLED" ] } }, "x-akamai": { "file-path": "schemas/operation-performed.yaml" } } } } }, "400": { "description": "Invalid policy.", "content": { "application/problem+json": { "example": { "detail": "You may not exceed 200 derivative image widths on this API token. Reduce the number of widths before activating. Note: If the widths field is empty, Image & Video Manager defines five default widths.", "instance": "/imaging/error-instances/bf39e042-9d21-4ef3-88f1-eacf487d12f8", "requestId": "5fb7efe81b819c76", "status": 400, "title": "Bad Request", "type": "/imaging/error-types/IVM_9000" }, "schema": { "additionalProperties": false, "description": "Error messaging.", "type": "object", "properties": { "detail": { "description": "A detailed description of the error.", "type": "string" }, "httpStatus": { "description": "The HTTP code for the error.", "type": "integer" }, "instance": { "description": "A reference to unique instance of the error.", "type": "string" }, "requestId": { "description": "An additional instance identifier for the error.", "type": "string" }, "title": { "description": "The summary description of the error.", "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } } } }, "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "delete": { "description": "Delete a specific policy.", "operationId": "delete-policy", "summary": "Remove a policy", "tags": [ "Policies" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Image & Video Manager API", "url": "https://techdocs.akamai.com/ivm/reference/delete-policy" }, "responses": { "200": { "description": "Policy deleted.", "content": { "application/json": { "example": { "description": "Policy thumbnail_policy deleted.", "id": "thumbnail_policy", "operationPerformed": "DELETED" }, "schema": { "additionalProperties": false, "description": "The type of operation performed on an Image & Video Manager resource.", "type": "object", "properties": { "description": { "description": "The description of the resource.", "type": "string" }, "id": { "description": "Unique identifier for a resource.", "type": "string" }, "operationPerformed": { "description": "The action performed on the resource, either `CREATED`, `UPDATED`, `DELETED`, or `CANCELLED`.", "type": "string", "enum": [ "CREATED", "UPDATED", "DELETED", "CANCELLED" ] } }, "x-akamai": { "file-path": "schemas/operation-performed.yaml" } } } } }, "400": { "description": "Could not delete policy.", "content": { "application/problem+json": { "example": { "detail": "Policy '.auto' cannot be deleted.", "instance": "/imaging/error-instances/bf39e042-9d21-4ef3-88f1-eacf487d12f8", "requestId": "5fb7efe81b819c76", "status": 400, "title": "Bad Request", "type": "/imaging/error-types/IVM_9000" }, "schema": { "additionalProperties": false, "description": "Error messaging.", "type": "object", "properties": { "detail": { "description": "A detailed description of the error.", "type": "string" }, "httpStatus": { "description": "The HTTP code for the error.", "type": "integer" }, "instance": { "description": "A reference to unique instance of the error.", "type": "string" }, "requestId": { "description": "An additional instance identifier for the error.", "type": "string" }, "title": { "description": "The summary description of the error.", "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } } } }, "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "__Enum__ Network environment to execute the API request on.", "example": "{{network}}", "in": "path", "name": "network", "required": true, "schema": { "example": "production", "type": "string", "enum": [ "staging", "production" ] }, "x-akamai": { "file-path": "parameters/network-path.yaml" } }, { "description": "Unique identifier for a policy.", "example": "{{policyId}}", "in": "path", "name": "policyId", "required": true, "schema": { "example": "thumbnail_policy", "type": "string" }, "x-akamai": { "file-path": "parameters/policyId-path.yaml" } }, { "description": "Unique identifier for the Akamai Contract containing the policy sets. Required if you have access to more than one contract with Image & Video Manager.", "example": "{{Contract}}", "in": "header", "name": "Contract", "required": false, "schema": { "example": "A-CCT7890", "type": "string" }, "x-akamai": { "file-path": "parameters/contractId-header.yaml" } }, { "description": "Unique identifier for the Image & Video Manager policy set.", "example": "{{Policy-Set}}", "in": "header", "name": "Policy-Set", "required": true, "schema": { "example": "053eef00-9f85-11ec-a51d-47eefacf795d", "type": "string" }, "x-akamai": { "file-path": "parameters/policySetId-header.yaml" } } ] }, "/policysets": { "post": { "description": "Create a new policy set for the contract on both networks.", "operationId": "post-policyset", "summary": "Create a policy set", "tags": [ "Policy sets" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Image & Video Manager API", "url": "https://techdocs.akamai.com/ivm/reference/post-policyset" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "name": "my_policy_set", "region": "US", "type": "IMAGE", "defaultPolicy": { "breakpoints": { "widths": [ 720, 1280, 1920, 5000 ] }, "output": { "perceptualQuality": "mediumHigh" } } }, "schema": { "additionalProperties": false, "description": "Specifies details of a policy set, such as the type of media its policies optimize and the region for which their delivery is best optimized.", "title": "Policy set", "type": "object", "required": [ "type", "region" ], "properties": { "defaultPolicy": { "description": "The default policy to deploy this policy set with. If unspecified the policy set will use the system default.", "example": "{{defaultPolicy}}", "writeOnly": true, "oneOf": [ { "description": "Specifies details for each policy, such as variations in image size and formats and the transformations to apply.", "title": "Image policy", "type": "object", "x-akamai": { "file-path": "schemas/policy-image.yaml" }, "allOf": [ { "additionalProperties": false, "type": "object", "properties": { "output": { "additionalProperties": false, "description": "Dictates the output quality, either `quality` or `perceptualQuality`, and the formats created for each resized image. If unspecified, you get image formats that support all browsers at the default quality level of `85`, including WEBP, JPEG2000, and JPEG-XR for specific browsers.", "title": "Output", "type": "object", "properties": { "adaptiveQuality": { "description": "Overrides the quality of the image to serve when Image & Video Manager detects a slow connection with a round-trip time (RTT) of less than 300 ms. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of images for users with standard connections.", "maximum": 100, "minimum": 1, "type": "integer" }, "allowedFormats": { "description": "The graphics file formats allowed for browser specific results, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "minItems": 1, "readOnly": true, "type": "array", "uniqueItems": true, "default": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ], "items": { "description": "The values of the allowed graphics file formats, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "type": "string", "enum": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ] } }, "forcedFormats": { "description": "The forced extra formats for the `imFormat` query parameter, which requests a specific browser type. By default, Image & Video Manager detects the browser and returns the appropriate image.", "readOnly": true, "type": "array", "uniqueItems": true, "default": [], "items": { "description": "The values of the forced extra formats, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "type": "string", "enum": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ] } }, "perceptualQuality": { "description": "Mutually exclusive with `quality`. The perceptual quality to use when comparing resulting images, which overrides the `quality` setting. Perceptual quality tunes each image format's quality dynamically based on the human-perceived quality of the output image. This can result in greater byte savings as compared to using regular `quality` because many images can be encoded at a much lower quality without compromising the perceived quality of the image. In addition, certain images may need to be encoded at a slightly higher quality in order to maintain human-perceived quality. Value tiers are `high`, `mediumHigh`, `medium`, `mediumLow`, and `low`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "perceptualQualityFloor": { "description": "Applies only when `perceptualQuality` is set. Sets a minimum image quality to respect when using perceptual quality. Perceptual quality won't reduce the quality below this value, even if it determines the compressed image to be acceptably visually similar.", "maximum": 100, "minimum": 1, "type": "integer" }, "quality": { "description": "Mutually exclusive with `perceptualQuality`, used by default if neither is specified. The chosen quality of output images from 1-100, with 1 being the lowest quality and 100 being the highest.", "oneOf": [ { "default": 85, "maximum": 100, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } } }, "postBreakpointTransformations": { "description": "Post-processing Transformations are applied to the image after image and quality settings have been applied.", "type": "array", "items": { "description": "A transformation to apply to the image/object/text.", "x-akamai": { "file-path": "schemas/transformation-post-breakpoint.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Places a transparent image on a set background color. Specify the color in CSS hexadecimal format.", "title": "BackgroundColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value for the background.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "BackgroundColor", "description": "Identifies the type of transformation, `BackgroundColor` in this case.", "type": "string", "enum": [ "BackgroundColor" ] } }, "x-akamai": { "file-path": "schemas/t-background-color.yaml" } }, { "additionalProperties": false, "description": "Applies a Gaussian blur to the image.", "title": "Blur", "type": "object", "required": [ "transformation" ], "properties": { "sigma": { "description": "The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.", "oneOf": [ { "default": 5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Blur", "description": "Identifies the type of transformation, `Blur` in this case.", "type": "string", "enum": [ "Blur" ] } }, "x-akamai": { "file-path": "schemas/t-blur.yaml" } }, { "additionalProperties": false, "description": "Changes any color in an image within the specified volume of the HSL colorspace to transparent or semi-transparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.", "title": "ChromaKey", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120\u00b0 on the color wheel.", "oneOf": [ { "default": 120, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueFeather": { "description": "How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30\u00b0 around the Hue Tolerance.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueTolerance": { "description": "How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30\u00b0 around the specified hue.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessFeather": { "description": "How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessTolerance": { "description": "How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a color must be within 75% of the full color to full white or full black for full removal.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationFeather": { "description": "How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the Saturation Tolerance.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationTolerance": { "description": "How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "ChromaKey", "description": "Identifies the type of transformation, `ChromaKey` in this case.", "type": "string", "enum": [ "ChromaKey" ] } }, "x-akamai": { "file-path": "schemas/t-chroma-key.yaml" } }, { "additionalProperties": false, "description": "An ordered combination of transformations to perform. Use to represent a sequence of transformations as a single transformation.", "title": "Compound", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Compound", "description": "Identifies the type of transformation, `Compound` in this case.", "type": "string", "enum": [ "Compound" ] }, "transformations": { "description": "A set of nested image transformations to apply to the source image.", "type": "array", "items": { "type": "object" } } }, "x-akamai": { "file-path": "schemas/t-compound.yaml" } }, { "additionalProperties": false, "description": "Adjusts both the contrast and brightness of an image.", "title": "Contrast", "type": "object", "required": [ "transformation" ], "properties": { "brightness": { "description": "Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of `1` produces a white image. A value of `-1` produces a black image. The default value is `0`, which leaves the image unchanged. The acceptable value range is `-1.0` to `1.0`. Values outside of the acceptable range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "contrast": { "description": "Adjusts the contrast of the image. Expressed as a range from `-1` to `1`, positive values increase contrast, negative values decrease it, while `0` leaves the image unchanged. Values outside of the `-1` to `1` range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Contrast", "description": "Identifies the type of transformation, `Contrast` in this case.", "type": "string", "enum": [ "Contrast" ] } }, "x-akamai": { "file-path": "schemas/t-contrast.yaml" } }, { "additionalProperties": false, "description": "Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears _goopy_. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.", "title": "Goop", "type": "object", "required": [ "transformation" ], "properties": { "chaos": { "description": "Specifies the greatest distance control points may move from their original position. A value of `1.0` shifts control points over as far as the next one in the original grid. A value of `0.0` leaves the image unchanged. Values under `0.5` work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "density": { "description": "Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium- to large-size images.", "oneOf": [ { "default": 4, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "power": { "description": "By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldn't need to vary the default value of `2.0`.", "oneOf": [ { "default": 2, "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "seed": { "description": "Specifies your own `seed` value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used, `Goop` distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Goop", "description": "Identifies the type of transformation, `Goop` in this case.", "type": "string", "enum": [ "Goop" ] } }, "x-akamai": { "file-path": "schemas/t-goop.yaml" } }, { "additionalProperties": false, "description": "Restricts image color to shades of gray only.", "title": "Grayscale", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Grayscale", "description": "Identifies the type of transformation, `Grayscale` in this case.", "type": "string", "enum": [ "Grayscale" ] }, "type": { "default": "Rec709", "description": "The algorithm used to transform colors to grays, either `Brightness`, `Lightness`, `Rec601`, or the default `Rec709`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "Rec601", "Rec709", "Brightness", "Lightness" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-grayscale.yaml" } }, { "additionalProperties": false, "description": "Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as `Grayscale` and `MaxColors`. If you're using more than one, consider the order to apply them for the desired results.", "title": "HSL", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightness": { "description": "A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green, whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than `1.0` decrease the lightness of colors in the image. Values greater than `1.0` increase the lightness of colors in the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSL", "description": "Identifies the type of transformation, `HSL` in this case.", "type": "string", "enum": [ "HSL" ] } }, "x-akamai": { "file-path": "schemas/t-hsl.yaml" } }, { "additionalProperties": false, "description": "Identical to HSL except it replaces `lightness` with `value`. For example, if you reduce the `lightness` of a light green, almost white, image, the color turns a vibrant green. Reducing the `value` turns the image a darker color, close to gray. This happens because the original image color is very close to white.", "title": "HSV", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0.0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSV", "description": "Identifies the type of transformation, `HSV` in this case.", "type": "string", "enum": [ "HSV" ] }, "value": { "description": "A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-hsv.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the dimensions of the source image. You need to select a dimension for comparison, which is either `width` and `height` or `both`.", "title": "IfDimension", "type": "object", "required": [ "transformation", "value" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "dimension": { "description": "The dimension to use to select the transformation, either `height`, `width`, or `both`. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "default": "width", "title": "String", "type": "string", "enum": [ "width", "height", "both" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "equal": { "description": "The transformation performed only if the source image's dimension is equal to the `value` listed.", "type": "object" }, "greaterThan": { "description": "The transformation performed if the source image's dimension is greater than the `value` listed.", "type": "object" }, "lessThan": { "description": "The transformation performed if the source image's dimension is less than the `value` listed.", "type": "object" }, "transformation": { "default": "IfDimension", "description": "Identifies the type of transformation, `IfDimension` in this case.", "type": "string", "enum": [ "IfDimension" ] }, "value": { "description": "The value to compare against the source image dimension. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-if-dimension.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the orientation of the source image. Defaults to the `default` transformation if no transformation is specified for the orientation.", "title": "IfOrientation", "type": "object", "required": [ "transformation" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "landscape": { "description": "The transformation performed if the source image uses landscape orientation.", "type": "object" }, "portrait": { "description": "The transformation performed if the source image uses portrait orientation.", "type": "object" }, "square": { "description": "The transformation performed if the source image uses a square orientation.", "type": "object" }, "transformation": { "default": "IfOrientation", "description": "Identifies the type of transformation, `IfOrientation` in this case.", "type": "string", "enum": [ "IfOrientation" ] } }, "x-akamai": { "file-path": "schemas/t-if-orientation.yaml" } }, { "additionalProperties": false, "description": "Set the maximum number of colors in the image palette. Reducing the number of colors in an image can help to reduce file size.", "title": "MaxColors", "type": "object", "required": [ "transformation", "colors" ], "properties": { "colors": { "description": "The value representing the maximum number of colors to use with the source image.", "oneOf": [ { "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MaxColors", "description": "Identifies the type of transformation, `MaxColors` in this case.", "type": "string", "enum": [ "MaxColors" ] } }, "x-akamai": { "file-path": "schemas/t-max-colors.yaml" } }, { "additionalProperties": false, "description": "Flips an image horizontally, vertically, or both.", "minProperties": 2, "title": "Mirror", "type": "object", "required": [ "transformation" ], "properties": { "horizontal": { "description": "Flips the image horizontally.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Mirror", "description": "Identifies the type of transformation, `Mirror` in this case.", "title": "IfDimension", "type": "string", "enum": [ "Mirror" ] }, "vertical": { "description": "Flips the image vertically.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-mirror.yaml" } }, { "additionalProperties": false, "description": "Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color's lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.", "title": "MonoHue", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MonoHue", "description": "Identifies the type of transformation, `MonoHue` in this case.", "type": "string", "enum": [ "MonoHue" ] } }, "x-akamai": { "file-path": "schemas/t-mono-hue.yaml" } }, { "additionalProperties": false, "description": "Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.", "title": "Opacity", "type": "object", "required": [ "transformation", "opacity" ], "properties": { "opacity": { "description": "Represents alpha values on a scale of `0` to `1`. Values below `1` increase transparency, and `0` is invisible. For images that have some transparency, values above `1` increase the opacity of the transparent portions.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Opacity", "description": "Identifies the type of transformation, `Opacity` in this case.", "type": "string", "enum": [ "Opacity" ] } }, "x-akamai": { "file-path": "schemas/t-opacity.yaml" } }, { "additionalProperties": false, "description": "Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.", "title": "RemoveColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value to remove.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "feather": { "description": "The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent, creating a softer edge. The first real-time request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "tolerance": { "description": "The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.", "oneOf": [ { "default": 0.2, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RemoveColor", "description": "Identifies the type of transformation, `RemoveColor` in this case.", "type": "string", "enum": [ "RemoveColor" ] } }, "x-akamai": { "file-path": "schemas/t-remove-color.yaml" } }, { "additionalProperties": false, "description": "Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as _sharpening_ an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image & Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.", "title": "UnsharpMask", "type": "object", "required": [ "transformation" ], "properties": { "gain": { "description": "Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "sigma": { "description": "The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels, `1.0` by default. High values emphasize large details and low values emphasize small details.", "oneOf": [ { "default": 1, "format": "float", "maximum": 10, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "threshold": { "description": "Set the minimum change required to include a detail in the filter. Higher values discard more changes.", "oneOf": [ { "default": 0.05, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "UnsharpMask", "description": "Identifies the type of transformation, `UnsharpMask` in this case.", "type": "string", "enum": [ "UnsharpMask" ] } }, "x-akamai": { "file-path": "schemas/t-unsharp-mask.yaml" } } ] } }, "transformations": { "description": "Set of image transformations to apply to the source image. If unspecified, no operations are performed.", "type": "array", "items": { "description": "A transformation to apply to the image/object/text.", "x-akamai": { "file-path": "schemas/transformation.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Places a specified `image` beside the source image. The API places the `image` on a major dimension, then aligns it on the minor dimension. Transparent pixels fill any area not covered by either image.", "title": "Append", "type": "object", "required": [ "transformation", "image" ], "properties": { "gravity": { "default": "Center", "description": "Specifies where to place the `image` relative to the source image. The available values represent the eight cardinal directions (`North`, `South`, `East`, `West`, `NorthEast`, `NorthWest`, `SouthEast`, `SouthWest`) and a `Center` by default.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravityPriority": { "description": "Determines the exact placement of the `image` when `gravity` is `Center` or a diagonal. The value is either `horizontal` or `vertical`. Use `horizontal` to append an `image` east or west of the source image. This aligns the `image` on the vertical gravity component, placing `Center` gravity east. Use `vertical` to append an `image` north or south of the source image. This aligns the `image` on the horizontal gravity component, placing `Center` gravity south.", "oneOf": [ { "default": "horizontal", "title": "String enum", "type": "string", "enum": [ "horizontal", "vertical" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "image": { "x-akamai": { "file-path": "schemas/image-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "A rectangular box, with a specified color and applied transformation.", "title": "Box image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the box, not the color of the edges of the box. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Box", "description": "Identifies the type of image, `Box` in this case.", "type": "string", "enum": [ "Box" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-box.yaml" } }, { "additionalProperties": false, "description": "A simple, solid, monochrome circle of a specified diameter on a transparent background.", "title": "Circle image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "diameter": { "description": "The diameter of the circle. The diameter will be the width and the height of the image in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Circle", "description": "Identifies the type of image, `Circle` in this case.", "type": "string", "enum": [ "Circle" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-circle.yaml" } }, { "additionalProperties": false, "description": "A snippet of text. Defines the font family, font size, fill color, outline stroke width, and outline color.", "title": "Text image", "type": "object", "required": [ "type", "text" ], "properties": { "fill": { "description": "The main fill color of the text.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "size": { "description": "The size in pixels to render the text.", "oneOf": [ { "default": 72, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "stroke": { "description": "The color of the outline of the text.", "oneOf": [ { "default": "#FFF", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "strokeSize": { "description": "The thickness in points of the outline of the text.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "text": { "description": "The line of text to render.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Text", "description": "Identifies the type of image, `Text` in this case.", "type": "string", "enum": [ "Text" ] }, "typeface": { "description": "The font family to apply to the text image. This may be the URL of a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.", "oneOf": [ { "default": "DejaVuSans", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-text.yaml" } }, { "additionalProperties": false, "description": "An image loaded from a URL.", "title": "URL image", "type": "object", "required": [ "url" ], "properties": { "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "URL", "description": "Identifies the type of image, `URL` in this case.", "type": "string", "enum": [ "URL" ] }, "url": { "description": "The URL of the image.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-url.yaml" } } ] }, "preserveMinorDimension": { "description": "Whether to preserve the source image's minor dimension, `false` by default. The minor dimension is the dimension opposite the dimension that the appending `image` is placed. For example, the dimensions of the source image are 100 × 100 pixels. The dimensions of the appending `image` are 50 × 150 pixels. The `gravity` is set to `East`. This makes the major dimension horizontal and the source image's minor dimension vertical. To preserve the source image's minor dimension at 100 pixels, the `preserveMinorDimension` is set to `true`. As a result of the append, the major dimension expanded with the appended image to 150 pixels. The source image's minor dimension was maintained at 100 pixels. The total combined dimension of the image is 150 × 100 pixels.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Append", "description": "Identifies the type of transformation, `Append` in this case.", "type": "string", "enum": [ "Append" ] } }, "x-akamai": { "file-path": "schemas/t-append.yaml" } }, { "additionalProperties": false, "description": "Changes the height or width of an image, either by cropping or expanding the area, to an aspect ratio of your choosing.", "title": "AspectCrop", "type": "object", "required": [ "transformation" ], "properties": { "allowExpansion": { "description": "Increases the size of the image canvas to achieve the requested aspect ratio instead of cropping the image. Use the Horizontal Offset and Vertical Offset settings to determine where to add the fully transparent pixels on the expanded image canvas.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height term of the aspect ratio to crop.", "oneOf": [ { "default": 1, "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "AspectCrop", "description": "Identifies the type of transformation, `AspectCrop` in this case.", "type": "string", "enum": [ "AspectCrop" ] }, "width": { "description": "The width term of the aspect ratio to crop.", "oneOf": [ { "default": 1, "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "xPosition": { "description": "Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.", "oneOf": [ { "default": 0.5, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "description": "Specifies the horizontal portion of the image you want to keep when cropping by aspect ratio crop. When using `allowExpansion`, this setting defines the horizontal position of the image on the new expanded image canvas.", "oneOf": [ { "default": 0.5, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-aspect-crop.yaml" } }, { "additionalProperties": false, "description": "Places a transparent image on a set background color. Specify the color in CSS hexadecimal format.", "title": "BackgroundColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value for the background.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "BackgroundColor", "description": "Identifies the type of transformation, `BackgroundColor` in this case.", "type": "string", "enum": [ "BackgroundColor" ] } }, "x-akamai": { "file-path": "schemas/t-background-color.yaml" } }, { "additionalProperties": false, "description": "Applies a Gaussian blur to the image.", "title": "Blur", "type": "object", "required": [ "transformation" ], "properties": { "sigma": { "description": "The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.", "oneOf": [ { "default": 5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Blur", "description": "Identifies the type of transformation, `Blur` in this case.", "type": "string", "enum": [ "Blur" ] } }, "x-akamai": { "file-path": "schemas/t-blur.yaml" } }, { "additionalProperties": false, "description": "Changes any color in an image within the specified volume of the HSL colorspace to transparent or semi-transparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.", "title": "ChromaKey", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120\u00b0 on the color wheel.", "oneOf": [ { "default": 120, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueFeather": { "description": "How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30\u00b0 around the Hue Tolerance.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueTolerance": { "description": "How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30\u00b0 around the specified hue.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessFeather": { "description": "How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessTolerance": { "description": "How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a color must be within 75% of the full color to full white or full black for full removal.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationFeather": { "description": "How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the Saturation Tolerance.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationTolerance": { "description": "How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "ChromaKey", "description": "Identifies the type of transformation, `ChromaKey` in this case.", "type": "string", "enum": [ "ChromaKey" ] } }, "x-akamai": { "file-path": "schemas/t-chroma-key.yaml" } }, { "additionalProperties": false, "description": "Applies another image to the source image, either as an overlay or an underlay. The image that's underneath is visible in areas that are beyond the edges of the top image or that are less than 100% opaque. A common use of an overlay composite is to add a watermark.", "title": "Composite", "type": "object", "required": [ "transformation", "image" ], "properties": { "gravity": { "default": "NorthWest", "description": "Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "image": { "x-akamai": { "file-path": "schemas/image-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "A rectangular box, with a specified color and applied transformation.", "title": "Box image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the box, not the color of the edges of the box. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Box", "description": "Identifies the type of image, `Box` in this case.", "type": "string", "enum": [ "Box" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-box.yaml" } }, { "additionalProperties": false, "description": "A simple, solid, monochrome circle of a specified diameter on a transparent background.", "title": "Circle image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "diameter": { "description": "The diameter of the circle. The diameter will be the width and the height of the image in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Circle", "description": "Identifies the type of image, `Circle` in this case.", "type": "string", "enum": [ "Circle" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-circle.yaml" } }, { "additionalProperties": false, "description": "A snippet of text. Defines the font family, font size, fill color, outline stroke width, and outline color.", "title": "Text image", "type": "object", "required": [ "type", "text" ], "properties": { "fill": { "description": "The main fill color of the text.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "size": { "description": "The size in pixels to render the text.", "oneOf": [ { "default": 72, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "stroke": { "description": "The color of the outline of the text.", "oneOf": [ { "default": "#FFF", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "strokeSize": { "description": "The thickness in points of the outline of the text.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "text": { "description": "The line of text to render.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Text", "description": "Identifies the type of image, `Text` in this case.", "type": "string", "enum": [ "Text" ] }, "typeface": { "description": "The font family to apply to the text image. This may be the URL of a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.", "oneOf": [ { "default": "DejaVuSans", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-text.yaml" } }, { "additionalProperties": false, "description": "An image loaded from a URL.", "title": "URL image", "type": "object", "required": [ "url" ], "properties": { "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "URL", "description": "Identifies the type of image, `URL` in this case.", "type": "string", "enum": [ "URL" ] }, "url": { "description": "The URL of the image.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-url.yaml" } } ] }, "placement": { "description": "Where to place the specified image, either `Over` or `Under` the existing image. Watermarks are usually applied over. Backgrounds are usually applied under.", "oneOf": [ { "default": "Over", "title": "String enum", "type": "string", "enum": [ "Over", "Under", "Mask", "Stencil" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "scale": { "description": "A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the `scaleDimension` to calculate the `scale` from the source image's width or height.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "scaleDimension": { "description": "The dimension, either `width` or `height`, of the source image to scale.", "oneOf": [ { "default": "width", "title": "String enum", "type": "string", "enum": [ "width", "height" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Composite", "description": "Identifies the type of transformation, `Composite` in this case.", "type": "string", "enum": [ "Composite" ] }, "xPosition": { "description": "The x-axis position of the image to apply.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "default": 0, "description": "The y-axis position of the image to apply.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-composite.yaml" } }, { "additionalProperties": false, "description": "An ordered combination of transformations to perform. Use to represent a sequence of transformations as a single transformation.", "title": "Compound", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Compound", "description": "Identifies the type of transformation, `Compound` in this case.", "type": "string", "enum": [ "Compound" ] }, "transformations": { "description": "A set of nested image transformations to apply to the source image.", "type": "array", "items": { "type": "object" } } }, "x-akamai": { "file-path": "schemas/t-compound.yaml" } }, { "additionalProperties": false, "description": "Adjusts both the contrast and brightness of an image.", "title": "Contrast", "type": "object", "required": [ "transformation" ], "properties": { "brightness": { "description": "Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of `1` produces a white image. A value of `-1` produces a black image. The default value is `0`, which leaves the image unchanged. The acceptable value range is `-1.0` to `1.0`. Values outside of the acceptable range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "contrast": { "description": "Adjusts the contrast of the image. Expressed as a range from `-1` to `1`, positive values increase contrast, negative values decrease it, while `0` leaves the image unchanged. Values outside of the `-1` to `1` range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Contrast", "description": "Identifies the type of transformation, `Contrast` in this case.", "type": "string", "enum": [ "Contrast" ] } }, "x-akamai": { "file-path": "schemas/t-contrast.yaml" } }, { "additionalProperties": false, "description": "Crops an image.", "title": "Crop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "allowExpansion": { "description": "If cropping an area outside of the existing canvas, expands the image canvas.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "NorthWest", "description": "Frame of reference for X and Y positions.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The number of pixels to crop along the y-axis.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Crop", "description": "Identifies the type of transformation, `Crop` in this case.", "type": "string", "enum": [ "Crop" ] }, "width": { "description": "The number of pixels to crop along the x-axis.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "xPosition": { "description": "The x-axis position of the image to crop from.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "description": "The y-axis position of the image to crop from.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-crop.yaml" } }, { "additionalProperties": false, "description": "Applies a method to detect faces in the source image and applies the rectangular crop on either the `biggest` face or `all` of the faces detected. Image & Video Manager tries to preserve faces in the image instead of using specified crop coordinates.", "title": "FaceCrop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "algorithm": { "description": "Specifies the type of algorithm used to detect faces in the image, either `cascade` for the cascade classifier algorithm or `dnn` for the deep neural network algorithm, `cascade` by default.", "oneOf": [ { "default": "cascade", "title": "String enum", "type": "string", "enum": [ "cascade", "dnn" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "confidence": { "description": "With `algorithm` set to `dnn`, specifies the minimum confidence needed to detect faces in the image. Values range from `0` to `1` for increased confidence, and possibly fewer faces detected.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "failGravity": { "default": "Center", "description": "Controls placement of the crop if Image & Video Manager does not detect any faces in the image. Directions are relative to the edges of the image being transformed.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "focus": { "description": "Distinguishes the faces detected, either `biggestFace` or `allFaces` to place the crop rectangle around the full set of faces. This is `all` by default.", "oneOf": [ { "default": "allFaces", "title": "String enum", "type": "string", "enum": [ "allFaces", "biggestFace" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "Center", "description": "Controls placement of the crop. Directions are relative to the face, plus padding.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the output image in pixels relative to the specified `style` value.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "The padding ratio based on the dimensions of the biggest face detected, `0.5` by default. Larger values increase padding.", "oneOf": [ { "default": 0.5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the faces detected in the source image, `zoom` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` places a raw crop around the faces, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and faces as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the faces, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "zoom", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FaceCrop", "description": "Identifies the type of transformation, `FaceCrop` in this case.", "type": "string", "enum": [ "FaceCrop" ] }, "width": { "description": "The width of the output image in pixels relative to the specified `style` value.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-face-crop.yaml" } }, { "additionalProperties": false, "description": "Identifies prominent features of the source image, then crops around as many of these features as possible relative to the specified `width` and `height` values.", "title": "FeatureCrop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "failGravity": { "default": "Center", "description": "Controls placement of the crop if Image & Video Manager does not detect any features in the image. Directions are relative to the edges of the image being transformed.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "featureRadius": { "description": "The size in pixels of the important features to search for. If identified, two features never appear closer together than this value, `8.0` by default.", "oneOf": [ { "default": 8, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "Center", "description": "Controls placement of the crop. Directions are relative to the region of interest plus padding.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "maxFeatures": { "description": "The maximum number of features to identify as important features, `32` by default. The strongest features are always chosen.", "oneOf": [ { "default": 32, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "minFeatureQuality": { "description": "Determines the minimum quality level of the feature identified. To consider a feature important, the feature needs to surpass this value. Image & Video Manager measures quality on a scale from `0` for the lowest quality to `1` for the highest quality, `.1` by default.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "Adds space around the region of interest. The amount of padding added is directly related to the size of the bounding box of the selected features. Specifically, the region of interest is expanded in all directions by the largest dimension of the bounding box of the selected features multiplied by this value.", "oneOf": [ { "default": 0.05, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the features identified in the source image, `fill` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` performs a raw crop around the features, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and features as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the features, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "zoom", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FeatureCrop", "description": "Identifies the type of transformation, `FeatureCrop` in this case.", "type": "string", "enum": [ "FeatureCrop" ] }, "width": { "description": "The width in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-feature-crop.yaml" } }, { "additionalProperties": false, "description": "Resizes an image to fit within a specific size box and then uses a fill of that same image to cover any transparent space at the edges. By default the fill image has a Blur transformation with a sigma value of 8 applied. Customize the transformation using the `fillTransformation` parameter.", "title": "FitAndFill", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "fillTransformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "height": { "description": "The height value of the resized image.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FitAndFill", "description": "Identifies the type of transformation, `FitAndFill` in this case.", "type": "string", "enum": [ "FitAndFill" ] }, "width": { "description": "The width value of the resized image.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-fit-and-fill.yaml" } }, { "additionalProperties": false, "description": "Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears _goopy_. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.", "title": "Goop", "type": "object", "required": [ "transformation" ], "properties": { "chaos": { "description": "Specifies the greatest distance control points may move from their original position. A value of `1.0` shifts control points over as far as the next one in the original grid. A value of `0.0` leaves the image unchanged. Values under `0.5` work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "density": { "description": "Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium- to large-size images.", "oneOf": [ { "default": 4, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "power": { "description": "By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldn't need to vary the default value of `2.0`.", "oneOf": [ { "default": 2, "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "seed": { "description": "Specifies your own `seed` value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used, `Goop` distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Goop", "description": "Identifies the type of transformation, `Goop` in this case.", "type": "string", "enum": [ "Goop" ] } }, "x-akamai": { "file-path": "schemas/t-goop.yaml" } }, { "additionalProperties": false, "description": "Restricts image color to shades of gray only.", "title": "Grayscale", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Grayscale", "description": "Identifies the type of transformation, `Grayscale` in this case.", "type": "string", "enum": [ "Grayscale" ] }, "type": { "default": "Rec709", "description": "The algorithm used to transform colors to grays, either `Brightness`, `Lightness`, `Rec601`, or the default `Rec709`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "Rec601", "Rec709", "Brightness", "Lightness" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-grayscale.yaml" } }, { "additionalProperties": false, "description": "Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as `Grayscale` and `MaxColors`. If you're using more than one, consider the order to apply them for the desired results.", "title": "HSL", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightness": { "description": "A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green, whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than `1.0` decrease the lightness of colors in the image. Values greater than `1.0` increase the lightness of colors in the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSL", "description": "Identifies the type of transformation, `HSL` in this case.", "type": "string", "enum": [ "HSL" ] } }, "x-akamai": { "file-path": "schemas/t-hsl.yaml" } }, { "additionalProperties": false, "description": "Identical to HSL except it replaces `lightness` with `value`. For example, if you reduce the `lightness` of a light green, almost white, image, the color turns a vibrant green. Reducing the `value` turns the image a darker color, close to gray. This happens because the original image color is very close to white.", "title": "HSV", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0.0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSV", "description": "Identifies the type of transformation, `HSV` in this case.", "type": "string", "enum": [ "HSV" ] }, "value": { "description": "A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-hsv.yaml" } }, { "additionalProperties": false, "description": "Apply artistic transformations to images quickly and dynamically by specifying transformations with a query string appended to the image URL.\n- transformation\n- query\n- allowedTransformations", "title": "ImQuery", "type": "object", "properties": { "allowedTransformations": { "description": "Specifies the transformations that can be applied using the query string parameter.", "type": "array", "items": { "type": "string", "enum": [ "Append", "AspectCrop", "BackgroundColor", "Blur", "Composite", "Contrast", "Crop", "ChromaKey", "FaceCrop", "FeatureCrop", "FitAndFill", "Goop", "Grayscale", "HSL", "HSV", "MaxColors", "Mirror", "MonoHue", "Opacity", "RegionOfInterestCrop", "RelativeCrop", "RemoveColor", "Resize", "Rotate", "Scale", "Shear", "Trim", "UnsharpMask", "IfDimension", "IfOrientation" ] } }, "query": { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } }, "transformation": { "default": "ImQuery", "description": "Identifies the type of transformation, `ImQuery` in this case.", "type": "string", "enum": [ "ImQuery" ] } }, "x-akamai": { "file-path": "schemas/t-im-query.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the dimensions of the source image. You need to select a dimension for comparison, which is either `width` and `height` or `both`.", "title": "IfDimension", "type": "object", "required": [ "transformation", "value" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "dimension": { "description": "The dimension to use to select the transformation, either `height`, `width`, or `both`. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "default": "width", "title": "String", "type": "string", "enum": [ "width", "height", "both" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "equal": { "description": "The transformation performed only if the source image's dimension is equal to the `value` listed.", "type": "object" }, "greaterThan": { "description": "The transformation performed if the source image's dimension is greater than the `value` listed.", "type": "object" }, "lessThan": { "description": "The transformation performed if the source image's dimension is less than the `value` listed.", "type": "object" }, "transformation": { "default": "IfDimension", "description": "Identifies the type of transformation, `IfDimension` in this case.", "type": "string", "enum": [ "IfDimension" ] }, "value": { "description": "The value to compare against the source image dimension. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-if-dimension.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the orientation of the source image. Defaults to the `default` transformation if no transformation is specified for the orientation.", "title": "IfOrientation", "type": "object", "required": [ "transformation" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "landscape": { "description": "The transformation performed if the source image uses landscape orientation.", "type": "object" }, "portrait": { "description": "The transformation performed if the source image uses portrait orientation.", "type": "object" }, "square": { "description": "The transformation performed if the source image uses a square orientation.", "type": "object" }, "transformation": { "default": "IfOrientation", "description": "Identifies the type of transformation, `IfOrientation` in this case.", "type": "string", "enum": [ "IfOrientation" ] } }, "x-akamai": { "file-path": "schemas/t-if-orientation.yaml" } }, { "additionalProperties": false, "description": "Set the maximum number of colors in the image palette. Reducing the number of colors in an image can help to reduce file size.", "title": "MaxColors", "type": "object", "required": [ "transformation", "colors" ], "properties": { "colors": { "description": "The value representing the maximum number of colors to use with the source image.", "oneOf": [ { "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MaxColors", "description": "Identifies the type of transformation, `MaxColors` in this case.", "type": "string", "enum": [ "MaxColors" ] } }, "x-akamai": { "file-path": "schemas/t-max-colors.yaml" } }, { "additionalProperties": false, "description": "Flips an image horizontally, vertically, or both.", "minProperties": 2, "title": "Mirror", "type": "object", "required": [ "transformation" ], "properties": { "horizontal": { "description": "Flips the image horizontally.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Mirror", "description": "Identifies the type of transformation, `Mirror` in this case.", "title": "IfDimension", "type": "string", "enum": [ "Mirror" ] }, "vertical": { "description": "Flips the image vertically.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-mirror.yaml" } }, { "additionalProperties": false, "description": "Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color's lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.", "title": "MonoHue", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MonoHue", "description": "Identifies the type of transformation, `MonoHue` in this case.", "type": "string", "enum": [ "MonoHue" ] } }, "x-akamai": { "file-path": "schemas/t-mono-hue.yaml" } }, { "additionalProperties": false, "description": "Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.", "title": "Opacity", "type": "object", "required": [ "transformation", "opacity" ], "properties": { "opacity": { "description": "Represents alpha values on a scale of `0` to `1`. Values below `1` increase transparency, and `0` is invisible. For images that have some transparency, values above `1` increase the opacity of the transparent portions.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Opacity", "description": "Identifies the type of transformation, `Opacity` in this case.", "type": "string", "enum": [ "Opacity" ] } }, "x-akamai": { "file-path": "schemas/t-opacity.yaml" } }, { "additionalProperties": false, "description": "Crops to a region around a specified area of interest relative to the specified `width` and `height` values.", "title": "RegionOfInterestCrop", "type": "object", "required": [ "transformation", "width", "height", "regionOfInterest" ], "properties": { "gravity": { "default": "Center", "description": "The placement of the crop area relative to the specified area of interest.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "regionOfInterest": { "x-akamai": { "file-path": "schemas/shape-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Defines a circle with a specified `radius` from its `center` point.", "title": "Circle", "type": "object", "required": [ "center", "radius" ], "properties": { "center": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, "radius": { "description": "The radius of the circle measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-circle.yaml" } }, { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, { "additionalProperties": false, "description": "Defines a polygon from a series of connected points.", "title": "Polygon", "type": "object", "required": [ "points" ], "properties": { "points": { "description": "Series of PointShapeType objects. The last and first points connect to close the shape automatically.", "type": "array", "items": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } } } }, "x-akamai": { "file-path": "schemas/shape-type-polygon.yaml" } }, { "additionalProperties": false, "description": "Defines a rectangle's `width` and `height` relative to an `anchor` point at the top left corner.", "title": "Rectangle", "type": "object", "required": [ "anchor", "width", "height" ], "properties": { "anchor": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, "height": { "description": "Extends the rectangle down from the `anchor` point.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "width": { "description": "Extends the rectangle right from the `anchor` point.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-rectangle.yaml" } }, { "additionalProperties": false, "description": "Identifies a combined shape based on a set of other shapes.", "title": "Union", "type": "object", "required": [ "shapes" ], "properties": { "shapes": { "description": "A nested shape used to describe a more complex shape.", "type": "array", "items": { "description": "A nested shape used to describe a more complex shape.", "title": "Nested shape", "type": "object", "x-akamai": { "file-path": "schemas/shape-type-nested.yaml" } } } }, "x-akamai": { "file-path": "schemas/shape-type-union.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the specified area of interest in the source image, `zoom` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` places raw crop around the point of interest, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and point of interest as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the point of interest, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "fill", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RegionOfInterestCrop", "description": "Identifies the type of transformation, `RegionOfInterestCrop` in this case.", "type": "string", "enum": [ "RegionOfInterestCrop" ] }, "width": { "description": "The width in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-region-of-interest-crop.yaml" } }, { "additionalProperties": false, "description": "Shrinks or expands an image relative to the image's specified dimensions. Image & Video Manager fills the expanded areas with transparency. Positive values shrink the side, while negative values expand it.", "title": "RelativeCrop", "type": "object", "required": [ "transformation" ], "properties": { "east": { "description": "The number of pixels to shrink or expand the right side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "north": { "description": "The number of pixels to shrink or expand the top side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "south": { "description": "The number of pixels to shrink or expand the bottom side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RelativeCrop", "description": "Identifies the type of transformation, `RelativeCrop` in this case.", "type": "string", "enum": [ "RelativeCrop" ] }, "west": { "description": "The number of pixels to shrink or expand the left side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-relative-crop.yaml" } }, { "additionalProperties": false, "description": "Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.", "title": "RemoveColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value to remove.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "feather": { "description": "The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent, creating a softer edge. The first real-time request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "tolerance": { "description": "The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.", "oneOf": [ { "default": 0.2, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RemoveColor", "description": "Identifies the type of transformation, `RemoveColor` in this case.", "type": "string", "enum": [ "RemoveColor" ] } }, "x-akamai": { "file-path": "schemas/t-remove-color.yaml" } }, { "additionalProperties": false, "description": "Resizes an image to a particular, absolute dimension. If you don't enter a `width` or a `height`, the image is resized with the `fit` aspect preservation mode, which selects a value for the missing dimension that preserves the image's aspect.", "title": "Resize", "type": "object", "required": [ "transformation" ], "properties": { "aspect": { "description": "Preserves the aspect ratio. Select `fit` to make the image fit entirely within the selected width and height. When using `fit`, the resulting image has the largest possible size for the specified dimensions. Select `fill` to size the image so it both completely fills the dimensions and has the smallest possible file size. Otherwise `ignore` changes the original aspect ratio to fit within an arbitrarily shaped rectangle.", "oneOf": [ { "default": "fit", "title": "String enum", "type": "string", "enum": [ "fit", "fill", "ignore" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height to resize the source image to. Must be set if `width` is not specified.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Resize", "description": "Identifies the type of transformation, `Resize` in this case.", "type": "string", "enum": [ "Resize" ] }, "type": { "description": "Sets constraints for the image resize. Select `normal` to resize in all cases, either increasing or decreasing the dimensions. Select `downsize` to ignore this transformation if the result would be larger than the original. Select `upsize` to ignore this transformation if the result would be smaller.", "oneOf": [ { "default": "normal", "title": "String enum", "type": "string", "enum": [ "normal", "upsize", "downsize" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "width": { "description": "The width to resize the source image to. Must be set if `height` is not specified.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-resize.yaml" } }, { "additionalProperties": false, "description": "Rotate the image around its center by indicating the degrees of rotation.", "title": "Rotate", "type": "object", "required": [ "transformation", "degrees" ], "properties": { "degrees": { "description": "The value to rotate the image by. Positive values rotate clockwise, while negative values rotate counter-clockwise.", "oneOf": [ { "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Rotate", "description": "Identifies the type of transformation, `Rotate` in this case.", "type": "string", "enum": [ "Rotate" ] } }, "x-akamai": { "file-path": "schemas/t-rotate.yaml" } }, { "additionalProperties": false, "description": "Changes the image's size to different dimensions relative to its starting size.", "title": "Scale", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "height": { "description": "Scaling factor for the input height to determine the output height of the image, where values between `0` and `1` decrease size. Image dimensions need to be non-zero positive numbers.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Scale", "description": "Identifies the type of transformation, `Scale` in this case.", "type": "string", "enum": [ "Scale" ] }, "width": { "description": "Scaling factor for the input width to determine the output width of the image, where `1` leaves the width unchanged. Values greater than `1` increase the image size. Image dimensions need to be non-zero positive numbers.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-scale.yaml" } }, { "additionalProperties": false, "description": "Slants an image into a parallelogram, as a percent of the starting dimension as represented in decimal format. You need to specify at least one axis property. Transparent pixels fill empty areas around the sheared image as needed, so it's often useful to use a `BackgroundColor` transformation for these areas.", "title": "Shear", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Shear", "description": "Identifies the type of transformation, `Shear` in this case.", "type": "string", "enum": [ "Shear" ] }, "xShear": { "description": "The amount to shear along the x-axis, measured in multiples of the image's width. Required if `yShear` is not specified.", "oneOf": [ { "default": 0, "format": "float", "maximum": 5, "minimum": -5, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yShear": { "description": "The amount to shear along the y-axis, measured in multiples of the image's height. Required if `xShear` is not specified.", "oneOf": [ { "default": 0, "format": "float", "maximum": 5, "minimum": -5, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-shear.yaml" } }, { "additionalProperties": false, "description": "Automatically crops uniform backgrounds from the edges of an image.", "title": "Trim", "type": "object", "required": [ "transformation" ], "properties": { "fuzz": { "description": "The fuzz tolerance of the trim, a value between `0` and `1` that determines the acceptable amount of background variation before trimming stops.", "oneOf": [ { "default": 0.08, "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "The amount of padding in pixels to add to the trimmed image.", "oneOf": [ { "default": 0, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Trim", "description": "Identifies the type of transformation, `Trim` in this case.", "type": "string", "enum": [ "Trim" ] } }, "x-akamai": { "file-path": "schemas/t-trim.yaml" } }, { "additionalProperties": false, "description": "Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as _sharpening_ an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image & Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.", "title": "UnsharpMask", "type": "object", "required": [ "transformation" ], "properties": { "gain": { "description": "Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "sigma": { "description": "The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels, `1.0` by default. High values emphasize large details and low values emphasize small details.", "oneOf": [ { "default": 1, "format": "float", "maximum": 10, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "threshold": { "description": "Set the minimum change required to include a detail in the filter. Higher values discard more changes.", "oneOf": [ { "default": 0.05, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "UnsharpMask", "description": "Identifies the type of transformation, `UnsharpMask` in this case.", "type": "string", "enum": [ "UnsharpMask" ] } }, "x-akamai": { "file-path": "schemas/t-unsharp-mask.yaml" } } ] } }, "video": { "default": false, "description": "Identifies this as an image policy.", "readOnly": true, "type": "boolean", "enum": [ false ] } }, "x-akamai": { "file-path": "schemas/policy-image-specific.yaml" } }, { "additionalProperties": false, "properties": { "breakpoints": { "additionalProperties": false, "description": "The breakpoint widths (in pixels) to use to create derivative images or videos.", "title": "Breakpoints", "type": "object", "properties": { "widths": { "description": "Specifies each integer breakpoint width value.", "minItems": 1, "type": "array", "items": { "maximum": 5000, "minimum": 1, "type": "integer" } } } }, "dateCreated": { "description": "Date this policy version was created in ISO 8601 extended notation format.", "readOnly": true, "type": "string" }, "hosts": { "description": "Hosts that are allowed for image or video URLs within transformations or variables.", "type": "array", "items": { "type": "string" } }, "id": { "description": "Unique identifier for a policy which can be up to 64 alphanumeric characters and can include underscores or dashes.", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "readOnly": true, "type": "string" }, "previousVersion": { "description": "The previous version number of this policy version.", "readOnly": true, "type": "integer" }, "rolloutDuration": { "default": 3600, "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. This value has no effect on the staging network.", "maximum": 604800, "minimum": 3600, "type": "integer", "writeOnly": true }, "rolloutInfo": { "additionalProperties": false, "description": "Contains information about policy rollout start and completion times.", "readOnly": true, "type": "object", "properties": { "endTime": { "description": "The estimated time that rollout for this policy will end in UNIX timestamp format.", "type": "integer" }, "rolloutDuration": { "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. Policies on the staging network deploy as quickly as possible without rollout. For staging policies this value will always be 1.", "maximum": 604800, "minimum": 3600, "type": "integer" }, "startTime": { "description": "The estimated time that rollout for this policy will begin in UNIX timestamp format.", "type": "integer" } } }, "user": { "description": "The user who created this policy version.", "readOnly": true, "type": "string" }, "variables": { "description": "Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as an Inline Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.", "type": "array", "items": { "additionalProperties": false, "title": "Variable", "type": "object", "required": [ "name", "type", "defaultValue" ], "properties": { "defaultValue": { "description": "The default value of the variable if no query parameter is provided. It needs to be one of the `enumOptions` if any are provided.", "type": "string" }, "enumOptions": { "description": "Optionally limits the set of possible values for a variable. References to an enum `id` insert a corresponding `value`.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "id", "value" ], "properties": { "id": { "description": "The unique identifier for each enum value, up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "value": { "description": "The value of the variable when the `id` is provided.", "type": "string" } } } }, "name": { "description": "The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "postfix": { "description": "A postfix added to the value provided for the variable, or to the default value.", "type": "string" }, "prefix": { "description": "A prefix added to the value provided for the variable, or to the default value.", "type": "string" }, "type": { "description": "The type of value for the variable, either `bool`, `number`, `url`, `color`, `gravity`, `placement`, `scaleDimension`, `grayscaleType`, `aspect`, `resizeType`, `dimension`, `perceptualQuality`, `string`, or `focus`.", "type": "string", "enum": [ "bool", "number", "url", "color", "gravity", "placement", "scaleDimension", "grayscaleType", "aspect", "resizeType", "dimension", "perceptualQuality", "string", "focus" ] } }, "x-akamai": { "file-path": "schemas/variable.yaml" } } }, "version": { "description": "The version number of this policy version.", "readOnly": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/policy-shared.yaml" } } ] }, { "description": "Specifies details for each policy such as video size.", "title": "Video policy", "type": "object", "x-akamai": { "file-path": "schemas/policy-video.yaml" }, "allOf": [ { "additionalProperties": false, "type": "object", "properties": { "output": { "additionalProperties": false, "description": "Dictates the output quality for each resized video.", "title": "Output", "type": "object", "properties": { "perceptualQuality": { "description": "The quality of derivative videos. High preserves video quality with reduced byte savings while low reduces video quality to increase byte savings.", "oneOf": [ { "default": "medium", "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "placeholderVideoUrl": { "description": "Allows you to add a specific placeholder video that appears when a user first requests a video, but before Image & Video Manager processes the video. If not specified the original video plays during the processing time.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "videoAdaptiveQuality": { "description": "Overrides the quality of video to serve when Image & Video Manager detects a slow connection with a round-trip time (RTT) of 300 ms. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of videos for users with faster connections.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } } }, "video": { "default": true, "description": "Identifies this as a video policy.", "readOnly": true, "type": "boolean", "enum": [ true ] } }, "x-akamai": { "file-path": "schemas/policy-video-specific.yaml" } }, { "additionalProperties": false, "properties": { "breakpoints": { "additionalProperties": false, "description": "The breakpoint widths (in pixels) to use to create derivative images or videos.", "title": "Breakpoints", "type": "object", "properties": { "widths": { "description": "Specifies each integer breakpoint width value.", "minItems": 1, "type": "array", "items": { "maximum": 5000, "minimum": 1, "type": "integer" } } } }, "dateCreated": { "description": "Date this policy version was created in ISO 8601 extended notation format.", "readOnly": true, "type": "string" }, "hosts": { "description": "Hosts that are allowed for image or video URLs within transformations or variables.", "type": "array", "items": { "type": "string" } }, "id": { "description": "Unique identifier for a policy which can be up to 64 alphanumeric characters and can include underscores or dashes.", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "readOnly": true, "type": "string" }, "previousVersion": { "description": "The previous version number of this policy version.", "readOnly": true, "type": "integer" }, "rolloutDuration": { "default": 3600, "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. This value has no effect on the staging network.", "maximum": 604800, "minimum": 3600, "type": "integer", "writeOnly": true }, "rolloutInfo": { "additionalProperties": false, "description": "Contains information about policy rollout start and completion times.", "readOnly": true, "type": "object", "properties": { "endTime": { "description": "The estimated time that rollout for this policy will end in UNIX timestamp format.", "type": "integer" }, "rolloutDuration": { "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. Policies on the staging network deploy as quickly as possible without rollout. For staging policies this value will always be 1.", "maximum": 604800, "minimum": 3600, "type": "integer" }, "startTime": { "description": "The estimated time that rollout for this policy will begin in UNIX timestamp format.", "type": "integer" } } }, "user": { "description": "The user who created this policy version.", "readOnly": true, "type": "string" }, "variables": { "description": "Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as an Inline Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.", "type": "array", "items": { "additionalProperties": false, "title": "Variable", "type": "object", "required": [ "name", "type", "defaultValue" ], "properties": { "defaultValue": { "description": "The default value of the variable if no query parameter is provided. It needs to be one of the `enumOptions` if any are provided.", "type": "string" }, "enumOptions": { "description": "Optionally limits the set of possible values for a variable. References to an enum `id` insert a corresponding `value`.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "id", "value" ], "properties": { "id": { "description": "The unique identifier for each enum value, up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "value": { "description": "The value of the variable when the `id` is provided.", "type": "string" } } } }, "name": { "description": "The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "postfix": { "description": "A postfix added to the value provided for the variable, or to the default value.", "type": "string" }, "prefix": { "description": "A prefix added to the value provided for the variable, or to the default value.", "type": "string" }, "type": { "description": "The type of value for the variable, either `bool`, `number`, `url`, `color`, `gravity`, `placement`, `scaleDimension`, `grayscaleType`, `aspect`, `resizeType`, `dimension`, `perceptualQuality`, `string`, or `focus`.", "type": "string", "enum": [ "bool", "number", "url", "color", "gravity", "placement", "scaleDimension", "grayscaleType", "aspect", "resizeType", "dimension", "perceptualQuality", "string", "focus" ] } }, "x-akamai": { "file-path": "schemas/variable.yaml" } } }, "version": { "description": "The version number of this policy version.", "readOnly": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/policy-shared.yaml" } } ] } ] }, "id": { "description": "Unique identifier of the policy set.", "example": "{{id}}", "readOnly": true, "type": "string" }, "lastModified": { "description": "Date this policy set was last modified in ISO 8601 extended notation format.", "example": "{{lastModified}}", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "A friendly name for the policy set.", "example": "{{name}}", "type": "string" }, "properties": { "description": "The names of Property Manager properties using this policy set.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "region": { "description": "The geographic region for which the media using this policy set is optimized. Altering the value on an existing policy set voids previously cached images and videos and require their transformation again. The supported geographic regions are `US`, `EMEA`, `ASIA`, `AUSTRALIA`, `JAPAN`, or `CHINA`. `EMEA` is Europe, the Middle East, and Africa.", "example": "{{region}}", "title": "Region", "type": "string", "enum": [ "US", "EMEA", "ASIA", "AUSTRALIA", "JAPAN", "CHINA" ], "x-akamai": { "file-path": "schemas/policyset-region.yaml" } }, "type": { "description": "The type of media this policy set manages, either `IMAGE` or `VIDEO`.", "example": "{{type}}", "title": "MediaType", "type": "string", "enum": [ "IMAGE", "VIDEO" ], "x-akamai": { "file-path": "schemas/policyset-type.yaml" } }, "user": { "description": "Username of the person who most recently updated the policy set.", "example": "{{user}}", "readOnly": true, "type": "string" } }, "x-akamai": { "file-path": "schemas/policyset.yaml" } } } } }, "responses": { "201": { "description": "The response shows the new policy set.", "content": { "application/json": { "example": { "id": "123ab456-cde7-89ab-1234-56c789d12e4", "lastModified": "2022-01-02 08:10:02+0000", "name": "my_policy_set", "region": "US", "type": "IMAGE", "user": "Akamai", "properties": [] }, "schema": { "additionalProperties": false, "description": "Specifies details of a policy set, such as the type of media its policies optimize and the region for which their delivery is best optimized.", "title": "Policy set", "type": "object", "required": [ "type", "region" ], "properties": { "defaultPolicy": { "description": "The default policy to deploy this policy set with. If unspecified the policy set will use the system default.", "writeOnly": true, "oneOf": [ { "description": "Specifies details for each policy, such as variations in image size and formats and the transformations to apply.", "title": "Image policy", "type": "object", "x-akamai": { "file-path": "schemas/policy-image.yaml" }, "allOf": [ { "additionalProperties": false, "type": "object", "properties": { "output": { "additionalProperties": false, "description": "Dictates the output quality, either `quality` or `perceptualQuality`, and the formats created for each resized image. If unspecified, you get image formats that support all browsers at the default quality level of `85`, including WEBP, JPEG2000, and JPEG-XR for specific browsers.", "title": "Output", "type": "object", "properties": { "adaptiveQuality": { "description": "Overrides the quality of the image to serve when Image & Video Manager detects a slow connection with a round-trip time (RTT) of less than 300 ms. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of images for users with standard connections.", "maximum": 100, "minimum": 1, "type": "integer" }, "allowedFormats": { "description": "The graphics file formats allowed for browser specific results, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "minItems": 1, "readOnly": true, "type": "array", "uniqueItems": true, "default": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ], "items": { "description": "The values of the allowed graphics file formats, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "type": "string", "enum": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ] } }, "forcedFormats": { "description": "The forced extra formats for the `imFormat` query parameter, which requests a specific browser type. By default, Image & Video Manager detects the browser and returns the appropriate image.", "readOnly": true, "type": "array", "uniqueItems": true, "default": [], "items": { "description": "The values of the forced extra formats, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "type": "string", "enum": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ] } }, "perceptualQuality": { "description": "Mutually exclusive with `quality`. The perceptual quality to use when comparing resulting images, which overrides the `quality` setting. Perceptual quality tunes each image format's quality dynamically based on the human-perceived quality of the output image. This can result in greater byte savings as compared to using regular `quality` because many images can be encoded at a much lower quality without compromising the perceived quality of the image. In addition, certain images may need to be encoded at a slightly higher quality in order to maintain human-perceived quality. Value tiers are `high`, `mediumHigh`, `medium`, `mediumLow`, and `low`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "perceptualQualityFloor": { "description": "Applies only when `perceptualQuality` is set. Sets a minimum image quality to respect when using perceptual quality. Perceptual quality won't reduce the quality below this value, even if it determines the compressed image to be acceptably visually similar.", "maximum": 100, "minimum": 1, "type": "integer" }, "quality": { "description": "Mutually exclusive with `perceptualQuality`, used by default if neither is specified. The chosen quality of output images from 1-100, with 1 being the lowest quality and 100 being the highest.", "oneOf": [ { "default": 85, "maximum": 100, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } } }, "postBreakpointTransformations": { "description": "Post-processing Transformations are applied to the image after image and quality settings have been applied.", "type": "array", "items": { "description": "A transformation to apply to the image/object/text.", "x-akamai": { "file-path": "schemas/transformation-post-breakpoint.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Places a transparent image on a set background color. Specify the color in CSS hexadecimal format.", "title": "BackgroundColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value for the background.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "BackgroundColor", "description": "Identifies the type of transformation, `BackgroundColor` in this case.", "type": "string", "enum": [ "BackgroundColor" ] } }, "x-akamai": { "file-path": "schemas/t-background-color.yaml" } }, { "additionalProperties": false, "description": "Applies a Gaussian blur to the image.", "title": "Blur", "type": "object", "required": [ "transformation" ], "properties": { "sigma": { "description": "The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.", "oneOf": [ { "default": 5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Blur", "description": "Identifies the type of transformation, `Blur` in this case.", "type": "string", "enum": [ "Blur" ] } }, "x-akamai": { "file-path": "schemas/t-blur.yaml" } }, { "additionalProperties": false, "description": "Changes any color in an image within the specified volume of the HSL colorspace to transparent or semi-transparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.", "title": "ChromaKey", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120\u00b0 on the color wheel.", "oneOf": [ { "default": 120, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueFeather": { "description": "How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30\u00b0 around the Hue Tolerance.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueTolerance": { "description": "How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30\u00b0 around the specified hue.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessFeather": { "description": "How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessTolerance": { "description": "How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a color must be within 75% of the full color to full white or full black for full removal.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationFeather": { "description": "How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the Saturation Tolerance.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationTolerance": { "description": "How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "ChromaKey", "description": "Identifies the type of transformation, `ChromaKey` in this case.", "type": "string", "enum": [ "ChromaKey" ] } }, "x-akamai": { "file-path": "schemas/t-chroma-key.yaml" } }, { "additionalProperties": false, "description": "An ordered combination of transformations to perform. Use to represent a sequence of transformations as a single transformation.", "title": "Compound", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Compound", "description": "Identifies the type of transformation, `Compound` in this case.", "type": "string", "enum": [ "Compound" ] }, "transformations": { "description": "A set of nested image transformations to apply to the source image.", "type": "array", "items": { "type": "object" } } }, "x-akamai": { "file-path": "schemas/t-compound.yaml" } }, { "additionalProperties": false, "description": "Adjusts both the contrast and brightness of an image.", "title": "Contrast", "type": "object", "required": [ "transformation" ], "properties": { "brightness": { "description": "Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of `1` produces a white image. A value of `-1` produces a black image. The default value is `0`, which leaves the image unchanged. The acceptable value range is `-1.0` to `1.0`. Values outside of the acceptable range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "contrast": { "description": "Adjusts the contrast of the image. Expressed as a range from `-1` to `1`, positive values increase contrast, negative values decrease it, while `0` leaves the image unchanged. Values outside of the `-1` to `1` range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Contrast", "description": "Identifies the type of transformation, `Contrast` in this case.", "type": "string", "enum": [ "Contrast" ] } }, "x-akamai": { "file-path": "schemas/t-contrast.yaml" } }, { "additionalProperties": false, "description": "Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears _goopy_. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.", "title": "Goop", "type": "object", "required": [ "transformation" ], "properties": { "chaos": { "description": "Specifies the greatest distance control points may move from their original position. A value of `1.0` shifts control points over as far as the next one in the original grid. A value of `0.0` leaves the image unchanged. Values under `0.5` work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "density": { "description": "Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium- to large-size images.", "oneOf": [ { "default": 4, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "power": { "description": "By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldn't need to vary the default value of `2.0`.", "oneOf": [ { "default": 2, "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "seed": { "description": "Specifies your own `seed` value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used, `Goop` distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Goop", "description": "Identifies the type of transformation, `Goop` in this case.", "type": "string", "enum": [ "Goop" ] } }, "x-akamai": { "file-path": "schemas/t-goop.yaml" } }, { "additionalProperties": false, "description": "Restricts image color to shades of gray only.", "title": "Grayscale", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Grayscale", "description": "Identifies the type of transformation, `Grayscale` in this case.", "type": "string", "enum": [ "Grayscale" ] }, "type": { "default": "Rec709", "description": "The algorithm used to transform colors to grays, either `Brightness`, `Lightness`, `Rec601`, or the default `Rec709`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "Rec601", "Rec709", "Brightness", "Lightness" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-grayscale.yaml" } }, { "additionalProperties": false, "description": "Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as `Grayscale` and `MaxColors`. If you're using more than one, consider the order to apply them for the desired results.", "title": "HSL", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightness": { "description": "A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green, whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than `1.0` decrease the lightness of colors in the image. Values greater than `1.0` increase the lightness of colors in the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSL", "description": "Identifies the type of transformation, `HSL` in this case.", "type": "string", "enum": [ "HSL" ] } }, "x-akamai": { "file-path": "schemas/t-hsl.yaml" } }, { "additionalProperties": false, "description": "Identical to HSL except it replaces `lightness` with `value`. For example, if you reduce the `lightness` of a light green, almost white, image, the color turns a vibrant green. Reducing the `value` turns the image a darker color, close to gray. This happens because the original image color is very close to white.", "title": "HSV", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0.0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSV", "description": "Identifies the type of transformation, `HSV` in this case.", "type": "string", "enum": [ "HSV" ] }, "value": { "description": "A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-hsv.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the dimensions of the source image. You need to select a dimension for comparison, which is either `width` and `height` or `both`.", "title": "IfDimension", "type": "object", "required": [ "transformation", "value" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "dimension": { "description": "The dimension to use to select the transformation, either `height`, `width`, or `both`. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "default": "width", "title": "String", "type": "string", "enum": [ "width", "height", "both" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "equal": { "description": "The transformation performed only if the source image's dimension is equal to the `value` listed.", "type": "object" }, "greaterThan": { "description": "The transformation performed if the source image's dimension is greater than the `value` listed.", "type": "object" }, "lessThan": { "description": "The transformation performed if the source image's dimension is less than the `value` listed.", "type": "object" }, "transformation": { "default": "IfDimension", "description": "Identifies the type of transformation, `IfDimension` in this case.", "type": "string", "enum": [ "IfDimension" ] }, "value": { "description": "The value to compare against the source image dimension. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-if-dimension.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the orientation of the source image. Defaults to the `default` transformation if no transformation is specified for the orientation.", "title": "IfOrientation", "type": "object", "required": [ "transformation" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "landscape": { "description": "The transformation performed if the source image uses landscape orientation.", "type": "object" }, "portrait": { "description": "The transformation performed if the source image uses portrait orientation.", "type": "object" }, "square": { "description": "The transformation performed if the source image uses a square orientation.", "type": "object" }, "transformation": { "default": "IfOrientation", "description": "Identifies the type of transformation, `IfOrientation` in this case.", "type": "string", "enum": [ "IfOrientation" ] } }, "x-akamai": { "file-path": "schemas/t-if-orientation.yaml" } }, { "additionalProperties": false, "description": "Set the maximum number of colors in the image palette. Reducing the number of colors in an image can help to reduce file size.", "title": "MaxColors", "type": "object", "required": [ "transformation", "colors" ], "properties": { "colors": { "description": "The value representing the maximum number of colors to use with the source image.", "oneOf": [ { "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MaxColors", "description": "Identifies the type of transformation, `MaxColors` in this case.", "type": "string", "enum": [ "MaxColors" ] } }, "x-akamai": { "file-path": "schemas/t-max-colors.yaml" } }, { "additionalProperties": false, "description": "Flips an image horizontally, vertically, or both.", "minProperties": 2, "title": "Mirror", "type": "object", "required": [ "transformation" ], "properties": { "horizontal": { "description": "Flips the image horizontally.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Mirror", "description": "Identifies the type of transformation, `Mirror` in this case.", "title": "IfDimension", "type": "string", "enum": [ "Mirror" ] }, "vertical": { "description": "Flips the image vertically.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-mirror.yaml" } }, { "additionalProperties": false, "description": "Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color's lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.", "title": "MonoHue", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MonoHue", "description": "Identifies the type of transformation, `MonoHue` in this case.", "type": "string", "enum": [ "MonoHue" ] } }, "x-akamai": { "file-path": "schemas/t-mono-hue.yaml" } }, { "additionalProperties": false, "description": "Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.", "title": "Opacity", "type": "object", "required": [ "transformation", "opacity" ], "properties": { "opacity": { "description": "Represents alpha values on a scale of `0` to `1`. Values below `1` increase transparency, and `0` is invisible. For images that have some transparency, values above `1` increase the opacity of the transparent portions.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Opacity", "description": "Identifies the type of transformation, `Opacity` in this case.", "type": "string", "enum": [ "Opacity" ] } }, "x-akamai": { "file-path": "schemas/t-opacity.yaml" } }, { "additionalProperties": false, "description": "Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.", "title": "RemoveColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value to remove.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "feather": { "description": "The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent, creating a softer edge. The first real-time request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "tolerance": { "description": "The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.", "oneOf": [ { "default": 0.2, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RemoveColor", "description": "Identifies the type of transformation, `RemoveColor` in this case.", "type": "string", "enum": [ "RemoveColor" ] } }, "x-akamai": { "file-path": "schemas/t-remove-color.yaml" } }, { "additionalProperties": false, "description": "Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as _sharpening_ an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image & Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.", "title": "UnsharpMask", "type": "object", "required": [ "transformation" ], "properties": { "gain": { "description": "Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "sigma": { "description": "The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels, `1.0` by default. High values emphasize large details and low values emphasize small details.", "oneOf": [ { "default": 1, "format": "float", "maximum": 10, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "threshold": { "description": "Set the minimum change required to include a detail in the filter. Higher values discard more changes.", "oneOf": [ { "default": 0.05, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "UnsharpMask", "description": "Identifies the type of transformation, `UnsharpMask` in this case.", "type": "string", "enum": [ "UnsharpMask" ] } }, "x-akamai": { "file-path": "schemas/t-unsharp-mask.yaml" } } ] } }, "transformations": { "description": "Set of image transformations to apply to the source image. If unspecified, no operations are performed.", "type": "array", "items": { "description": "A transformation to apply to the image/object/text.", "x-akamai": { "file-path": "schemas/transformation.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Places a specified `image` beside the source image. The API places the `image` on a major dimension, then aligns it on the minor dimension. Transparent pixels fill any area not covered by either image.", "title": "Append", "type": "object", "required": [ "transformation", "image" ], "properties": { "gravity": { "default": "Center", "description": "Specifies where to place the `image` relative to the source image. The available values represent the eight cardinal directions (`North`, `South`, `East`, `West`, `NorthEast`, `NorthWest`, `SouthEast`, `SouthWest`) and a `Center` by default.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravityPriority": { "description": "Determines the exact placement of the `image` when `gravity` is `Center` or a diagonal. The value is either `horizontal` or `vertical`. Use `horizontal` to append an `image` east or west of the source image. This aligns the `image` on the vertical gravity component, placing `Center` gravity east. Use `vertical` to append an `image` north or south of the source image. This aligns the `image` on the horizontal gravity component, placing `Center` gravity south.", "oneOf": [ { "default": "horizontal", "title": "String enum", "type": "string", "enum": [ "horizontal", "vertical" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "image": { "x-akamai": { "file-path": "schemas/image-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "A rectangular box, with a specified color and applied transformation.", "title": "Box image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the box, not the color of the edges of the box. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Box", "description": "Identifies the type of image, `Box` in this case.", "type": "string", "enum": [ "Box" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-box.yaml" } }, { "additionalProperties": false, "description": "A simple, solid, monochrome circle of a specified diameter on a transparent background.", "title": "Circle image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "diameter": { "description": "The diameter of the circle. The diameter will be the width and the height of the image in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Circle", "description": "Identifies the type of image, `Circle` in this case.", "type": "string", "enum": [ "Circle" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-circle.yaml" } }, { "additionalProperties": false, "description": "A snippet of text. Defines the font family, font size, fill color, outline stroke width, and outline color.", "title": "Text image", "type": "object", "required": [ "type", "text" ], "properties": { "fill": { "description": "The main fill color of the text.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "size": { "description": "The size in pixels to render the text.", "oneOf": [ { "default": 72, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "stroke": { "description": "The color of the outline of the text.", "oneOf": [ { "default": "#FFF", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "strokeSize": { "description": "The thickness in points of the outline of the text.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "text": { "description": "The line of text to render.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Text", "description": "Identifies the type of image, `Text` in this case.", "type": "string", "enum": [ "Text" ] }, "typeface": { "description": "The font family to apply to the text image. This may be the URL of a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.", "oneOf": [ { "default": "DejaVuSans", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-text.yaml" } }, { "additionalProperties": false, "description": "An image loaded from a URL.", "title": "URL image", "type": "object", "required": [ "url" ], "properties": { "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "URL", "description": "Identifies the type of image, `URL` in this case.", "type": "string", "enum": [ "URL" ] }, "url": { "description": "The URL of the image.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-url.yaml" } } ] }, "preserveMinorDimension": { "description": "Whether to preserve the source image's minor dimension, `false` by default. The minor dimension is the dimension opposite the dimension that the appending `image` is placed. For example, the dimensions of the source image are 100 × 100 pixels. The dimensions of the appending `image` are 50 × 150 pixels. The `gravity` is set to `East`. This makes the major dimension horizontal and the source image's minor dimension vertical. To preserve the source image's minor dimension at 100 pixels, the `preserveMinorDimension` is set to `true`. As a result of the append, the major dimension expanded with the appended image to 150 pixels. The source image's minor dimension was maintained at 100 pixels. The total combined dimension of the image is 150 × 100 pixels.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Append", "description": "Identifies the type of transformation, `Append` in this case.", "type": "string", "enum": [ "Append" ] } }, "x-akamai": { "file-path": "schemas/t-append.yaml" } }, { "additionalProperties": false, "description": "Changes the height or width of an image, either by cropping or expanding the area, to an aspect ratio of your choosing.", "title": "AspectCrop", "type": "object", "required": [ "transformation" ], "properties": { "allowExpansion": { "description": "Increases the size of the image canvas to achieve the requested aspect ratio instead of cropping the image. Use the Horizontal Offset and Vertical Offset settings to determine where to add the fully transparent pixels on the expanded image canvas.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height term of the aspect ratio to crop.", "oneOf": [ { "default": 1, "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "AspectCrop", "description": "Identifies the type of transformation, `AspectCrop` in this case.", "type": "string", "enum": [ "AspectCrop" ] }, "width": { "description": "The width term of the aspect ratio to crop.", "oneOf": [ { "default": 1, "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "xPosition": { "description": "Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.", "oneOf": [ { "default": 0.5, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "description": "Specifies the horizontal portion of the image you want to keep when cropping by aspect ratio crop. When using `allowExpansion`, this setting defines the horizontal position of the image on the new expanded image canvas.", "oneOf": [ { "default": 0.5, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-aspect-crop.yaml" } }, { "additionalProperties": false, "description": "Places a transparent image on a set background color. Specify the color in CSS hexadecimal format.", "title": "BackgroundColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value for the background.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "BackgroundColor", "description": "Identifies the type of transformation, `BackgroundColor` in this case.", "type": "string", "enum": [ "BackgroundColor" ] } }, "x-akamai": { "file-path": "schemas/t-background-color.yaml" } }, { "additionalProperties": false, "description": "Applies a Gaussian blur to the image.", "title": "Blur", "type": "object", "required": [ "transformation" ], "properties": { "sigma": { "description": "The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.", "oneOf": [ { "default": 5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Blur", "description": "Identifies the type of transformation, `Blur` in this case.", "type": "string", "enum": [ "Blur" ] } }, "x-akamai": { "file-path": "schemas/t-blur.yaml" } }, { "additionalProperties": false, "description": "Changes any color in an image within the specified volume of the HSL colorspace to transparent or semi-transparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.", "title": "ChromaKey", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120\u00b0 on the color wheel.", "oneOf": [ { "default": 120, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueFeather": { "description": "How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30\u00b0 around the Hue Tolerance.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueTolerance": { "description": "How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30\u00b0 around the specified hue.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessFeather": { "description": "How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessTolerance": { "description": "How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a color must be within 75% of the full color to full white or full black for full removal.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationFeather": { "description": "How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the Saturation Tolerance.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationTolerance": { "description": "How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "ChromaKey", "description": "Identifies the type of transformation, `ChromaKey` in this case.", "type": "string", "enum": [ "ChromaKey" ] } }, "x-akamai": { "file-path": "schemas/t-chroma-key.yaml" } }, { "additionalProperties": false, "description": "Applies another image to the source image, either as an overlay or an underlay. The image that's underneath is visible in areas that are beyond the edges of the top image or that are less than 100% opaque. A common use of an overlay composite is to add a watermark.", "title": "Composite", "type": "object", "required": [ "transformation", "image" ], "properties": { "gravity": { "default": "NorthWest", "description": "Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "image": { "x-akamai": { "file-path": "schemas/image-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "A rectangular box, with a specified color and applied transformation.", "title": "Box image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the box, not the color of the edges of the box. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Box", "description": "Identifies the type of image, `Box` in this case.", "type": "string", "enum": [ "Box" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-box.yaml" } }, { "additionalProperties": false, "description": "A simple, solid, monochrome circle of a specified diameter on a transparent background.", "title": "Circle image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "diameter": { "description": "The diameter of the circle. The diameter will be the width and the height of the image in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Circle", "description": "Identifies the type of image, `Circle` in this case.", "type": "string", "enum": [ "Circle" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-circle.yaml" } }, { "additionalProperties": false, "description": "A snippet of text. Defines the font family, font size, fill color, outline stroke width, and outline color.", "title": "Text image", "type": "object", "required": [ "type", "text" ], "properties": { "fill": { "description": "The main fill color of the text.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "size": { "description": "The size in pixels to render the text.", "oneOf": [ { "default": 72, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "stroke": { "description": "The color of the outline of the text.", "oneOf": [ { "default": "#FFF", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "strokeSize": { "description": "The thickness in points of the outline of the text.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "text": { "description": "The line of text to render.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Text", "description": "Identifies the type of image, `Text` in this case.", "type": "string", "enum": [ "Text" ] }, "typeface": { "description": "The font family to apply to the text image. This may be the URL of a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.", "oneOf": [ { "default": "DejaVuSans", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-text.yaml" } }, { "additionalProperties": false, "description": "An image loaded from a URL.", "title": "URL image", "type": "object", "required": [ "url" ], "properties": { "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "URL", "description": "Identifies the type of image, `URL` in this case.", "type": "string", "enum": [ "URL" ] }, "url": { "description": "The URL of the image.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-url.yaml" } } ] }, "placement": { "description": "Where to place the specified image, either `Over` or `Under` the existing image. Watermarks are usually applied over. Backgrounds are usually applied under.", "oneOf": [ { "default": "Over", "title": "String enum", "type": "string", "enum": [ "Over", "Under", "Mask", "Stencil" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "scale": { "description": "A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the `scaleDimension` to calculate the `scale` from the source image's width or height.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "scaleDimension": { "description": "The dimension, either `width` or `height`, of the source image to scale.", "oneOf": [ { "default": "width", "title": "String enum", "type": "string", "enum": [ "width", "height" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Composite", "description": "Identifies the type of transformation, `Composite` in this case.", "type": "string", "enum": [ "Composite" ] }, "xPosition": { "description": "The x-axis position of the image to apply.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "default": 0, "description": "The y-axis position of the image to apply.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-composite.yaml" } }, { "additionalProperties": false, "description": "An ordered combination of transformations to perform. Use to represent a sequence of transformations as a single transformation.", "title": "Compound", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Compound", "description": "Identifies the type of transformation, `Compound` in this case.", "type": "string", "enum": [ "Compound" ] }, "transformations": { "description": "A set of nested image transformations to apply to the source image.", "type": "array", "items": { "type": "object" } } }, "x-akamai": { "file-path": "schemas/t-compound.yaml" } }, { "additionalProperties": false, "description": "Adjusts both the contrast and brightness of an image.", "title": "Contrast", "type": "object", "required": [ "transformation" ], "properties": { "brightness": { "description": "Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of `1` produces a white image. A value of `-1` produces a black image. The default value is `0`, which leaves the image unchanged. The acceptable value range is `-1.0` to `1.0`. Values outside of the acceptable range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "contrast": { "description": "Adjusts the contrast of the image. Expressed as a range from `-1` to `1`, positive values increase contrast, negative values decrease it, while `0` leaves the image unchanged. Values outside of the `-1` to `1` range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Contrast", "description": "Identifies the type of transformation, `Contrast` in this case.", "type": "string", "enum": [ "Contrast" ] } }, "x-akamai": { "file-path": "schemas/t-contrast.yaml" } }, { "additionalProperties": false, "description": "Crops an image.", "title": "Crop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "allowExpansion": { "description": "If cropping an area outside of the existing canvas, expands the image canvas.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "NorthWest", "description": "Frame of reference for X and Y positions.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The number of pixels to crop along the y-axis.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Crop", "description": "Identifies the type of transformation, `Crop` in this case.", "type": "string", "enum": [ "Crop" ] }, "width": { "description": "The number of pixels to crop along the x-axis.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "xPosition": { "description": "The x-axis position of the image to crop from.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "description": "The y-axis position of the image to crop from.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-crop.yaml" } }, { "additionalProperties": false, "description": "Applies a method to detect faces in the source image and applies the rectangular crop on either the `biggest` face or `all` of the faces detected. Image & Video Manager tries to preserve faces in the image instead of using specified crop coordinates.", "title": "FaceCrop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "algorithm": { "description": "Specifies the type of algorithm used to detect faces in the image, either `cascade` for the cascade classifier algorithm or `dnn` for the deep neural network algorithm, `cascade` by default.", "oneOf": [ { "default": "cascade", "title": "String enum", "type": "string", "enum": [ "cascade", "dnn" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "confidence": { "description": "With `algorithm` set to `dnn`, specifies the minimum confidence needed to detect faces in the image. Values range from `0` to `1` for increased confidence, and possibly fewer faces detected.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "failGravity": { "default": "Center", "description": "Controls placement of the crop if Image & Video Manager does not detect any faces in the image. Directions are relative to the edges of the image being transformed.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "focus": { "description": "Distinguishes the faces detected, either `biggestFace` or `allFaces` to place the crop rectangle around the full set of faces. This is `all` by default.", "oneOf": [ { "default": "allFaces", "title": "String enum", "type": "string", "enum": [ "allFaces", "biggestFace" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "Center", "description": "Controls placement of the crop. Directions are relative to the face, plus padding.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the output image in pixels relative to the specified `style` value.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "The padding ratio based on the dimensions of the biggest face detected, `0.5` by default. Larger values increase padding.", "oneOf": [ { "default": 0.5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the faces detected in the source image, `zoom` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` places a raw crop around the faces, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and faces as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the faces, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "zoom", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FaceCrop", "description": "Identifies the type of transformation, `FaceCrop` in this case.", "type": "string", "enum": [ "FaceCrop" ] }, "width": { "description": "The width of the output image in pixels relative to the specified `style` value.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-face-crop.yaml" } }, { "additionalProperties": false, "description": "Identifies prominent features of the source image, then crops around as many of these features as possible relative to the specified `width` and `height` values.", "title": "FeatureCrop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "failGravity": { "default": "Center", "description": "Controls placement of the crop if Image & Video Manager does not detect any features in the image. Directions are relative to the edges of the image being transformed.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "featureRadius": { "description": "The size in pixels of the important features to search for. If identified, two features never appear closer together than this value, `8.0` by default.", "oneOf": [ { "default": 8, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "Center", "description": "Controls placement of the crop. Directions are relative to the region of interest plus padding.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "maxFeatures": { "description": "The maximum number of features to identify as important features, `32` by default. The strongest features are always chosen.", "oneOf": [ { "default": 32, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "minFeatureQuality": { "description": "Determines the minimum quality level of the feature identified. To consider a feature important, the feature needs to surpass this value. Image & Video Manager measures quality on a scale from `0` for the lowest quality to `1` for the highest quality, `.1` by default.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "Adds space around the region of interest. The amount of padding added is directly related to the size of the bounding box of the selected features. Specifically, the region of interest is expanded in all directions by the largest dimension of the bounding box of the selected features multiplied by this value.", "oneOf": [ { "default": 0.05, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the features identified in the source image, `fill` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` performs a raw crop around the features, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and features as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the features, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "zoom", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FeatureCrop", "description": "Identifies the type of transformation, `FeatureCrop` in this case.", "type": "string", "enum": [ "FeatureCrop" ] }, "width": { "description": "The width in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-feature-crop.yaml" } }, { "additionalProperties": false, "description": "Resizes an image to fit within a specific size box and then uses a fill of that same image to cover any transparent space at the edges. By default the fill image has a Blur transformation with a sigma value of 8 applied. Customize the transformation using the `fillTransformation` parameter.", "title": "FitAndFill", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "fillTransformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "height": { "description": "The height value of the resized image.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FitAndFill", "description": "Identifies the type of transformation, `FitAndFill` in this case.", "type": "string", "enum": [ "FitAndFill" ] }, "width": { "description": "The width value of the resized image.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-fit-and-fill.yaml" } }, { "additionalProperties": false, "description": "Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears _goopy_. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.", "title": "Goop", "type": "object", "required": [ "transformation" ], "properties": { "chaos": { "description": "Specifies the greatest distance control points may move from their original position. A value of `1.0` shifts control points over as far as the next one in the original grid. A value of `0.0` leaves the image unchanged. Values under `0.5` work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "density": { "description": "Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium- to large-size images.", "oneOf": [ { "default": 4, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "power": { "description": "By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldn't need to vary the default value of `2.0`.", "oneOf": [ { "default": 2, "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "seed": { "description": "Specifies your own `seed` value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used, `Goop` distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Goop", "description": "Identifies the type of transformation, `Goop` in this case.", "type": "string", "enum": [ "Goop" ] } }, "x-akamai": { "file-path": "schemas/t-goop.yaml" } }, { "additionalProperties": false, "description": "Restricts image color to shades of gray only.", "title": "Grayscale", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Grayscale", "description": "Identifies the type of transformation, `Grayscale` in this case.", "type": "string", "enum": [ "Grayscale" ] }, "type": { "default": "Rec709", "description": "The algorithm used to transform colors to grays, either `Brightness`, `Lightness`, `Rec601`, or the default `Rec709`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "Rec601", "Rec709", "Brightness", "Lightness" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-grayscale.yaml" } }, { "additionalProperties": false, "description": "Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as `Grayscale` and `MaxColors`. If you're using more than one, consider the order to apply them for the desired results.", "title": "HSL", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightness": { "description": "A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green, whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than `1.0` decrease the lightness of colors in the image. Values greater than `1.0` increase the lightness of colors in the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSL", "description": "Identifies the type of transformation, `HSL` in this case.", "type": "string", "enum": [ "HSL" ] } }, "x-akamai": { "file-path": "schemas/t-hsl.yaml" } }, { "additionalProperties": false, "description": "Identical to HSL except it replaces `lightness` with `value`. For example, if you reduce the `lightness` of a light green, almost white, image, the color turns a vibrant green. Reducing the `value` turns the image a darker color, close to gray. This happens because the original image color is very close to white.", "title": "HSV", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0.0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSV", "description": "Identifies the type of transformation, `HSV` in this case.", "type": "string", "enum": [ "HSV" ] }, "value": { "description": "A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-hsv.yaml" } }, { "additionalProperties": false, "description": "Apply artistic transformations to images quickly and dynamically by specifying transformations with a query string appended to the image URL.\n- transformation\n- query\n- allowedTransformations", "title": "ImQuery", "type": "object", "properties": { "allowedTransformations": { "description": "Specifies the transformations that can be applied using the query string parameter.", "type": "array", "items": { "type": "string", "enum": [ "Append", "AspectCrop", "BackgroundColor", "Blur", "Composite", "Contrast", "Crop", "ChromaKey", "FaceCrop", "FeatureCrop", "FitAndFill", "Goop", "Grayscale", "HSL", "HSV", "MaxColors", "Mirror", "MonoHue", "Opacity", "RegionOfInterestCrop", "RelativeCrop", "RemoveColor", "Resize", "Rotate", "Scale", "Shear", "Trim", "UnsharpMask", "IfDimension", "IfOrientation" ] } }, "query": { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } }, "transformation": { "default": "ImQuery", "description": "Identifies the type of transformation, `ImQuery` in this case.", "type": "string", "enum": [ "ImQuery" ] } }, "x-akamai": { "file-path": "schemas/t-im-query.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the dimensions of the source image. You need to select a dimension for comparison, which is either `width` and `height` or `both`.", "title": "IfDimension", "type": "object", "required": [ "transformation", "value" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "dimension": { "description": "The dimension to use to select the transformation, either `height`, `width`, or `both`. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "default": "width", "title": "String", "type": "string", "enum": [ "width", "height", "both" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "equal": { "description": "The transformation performed only if the source image's dimension is equal to the `value` listed.", "type": "object" }, "greaterThan": { "description": "The transformation performed if the source image's dimension is greater than the `value` listed.", "type": "object" }, "lessThan": { "description": "The transformation performed if the source image's dimension is less than the `value` listed.", "type": "object" }, "transformation": { "default": "IfDimension", "description": "Identifies the type of transformation, `IfDimension` in this case.", "type": "string", "enum": [ "IfDimension" ] }, "value": { "description": "The value to compare against the source image dimension. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-if-dimension.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the orientation of the source image. Defaults to the `default` transformation if no transformation is specified for the orientation.", "title": "IfOrientation", "type": "object", "required": [ "transformation" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "landscape": { "description": "The transformation performed if the source image uses landscape orientation.", "type": "object" }, "portrait": { "description": "The transformation performed if the source image uses portrait orientation.", "type": "object" }, "square": { "description": "The transformation performed if the source image uses a square orientation.", "type": "object" }, "transformation": { "default": "IfOrientation", "description": "Identifies the type of transformation, `IfOrientation` in this case.", "type": "string", "enum": [ "IfOrientation" ] } }, "x-akamai": { "file-path": "schemas/t-if-orientation.yaml" } }, { "additionalProperties": false, "description": "Set the maximum number of colors in the image palette. Reducing the number of colors in an image can help to reduce file size.", "title": "MaxColors", "type": "object", "required": [ "transformation", "colors" ], "properties": { "colors": { "description": "The value representing the maximum number of colors to use with the source image.", "oneOf": [ { "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MaxColors", "description": "Identifies the type of transformation, `MaxColors` in this case.", "type": "string", "enum": [ "MaxColors" ] } }, "x-akamai": { "file-path": "schemas/t-max-colors.yaml" } }, { "additionalProperties": false, "description": "Flips an image horizontally, vertically, or both.", "minProperties": 2, "title": "Mirror", "type": "object", "required": [ "transformation" ], "properties": { "horizontal": { "description": "Flips the image horizontally.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Mirror", "description": "Identifies the type of transformation, `Mirror` in this case.", "title": "IfDimension", "type": "string", "enum": [ "Mirror" ] }, "vertical": { "description": "Flips the image vertically.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-mirror.yaml" } }, { "additionalProperties": false, "description": "Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color's lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.", "title": "MonoHue", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MonoHue", "description": "Identifies the type of transformation, `MonoHue` in this case.", "type": "string", "enum": [ "MonoHue" ] } }, "x-akamai": { "file-path": "schemas/t-mono-hue.yaml" } }, { "additionalProperties": false, "description": "Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.", "title": "Opacity", "type": "object", "required": [ "transformation", "opacity" ], "properties": { "opacity": { "description": "Represents alpha values on a scale of `0` to `1`. Values below `1` increase transparency, and `0` is invisible. For images that have some transparency, values above `1` increase the opacity of the transparent portions.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Opacity", "description": "Identifies the type of transformation, `Opacity` in this case.", "type": "string", "enum": [ "Opacity" ] } }, "x-akamai": { "file-path": "schemas/t-opacity.yaml" } }, { "additionalProperties": false, "description": "Crops to a region around a specified area of interest relative to the specified `width` and `height` values.", "title": "RegionOfInterestCrop", "type": "object", "required": [ "transformation", "width", "height", "regionOfInterest" ], "properties": { "gravity": { "default": "Center", "description": "The placement of the crop area relative to the specified area of interest.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "regionOfInterest": { "x-akamai": { "file-path": "schemas/shape-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Defines a circle with a specified `radius` from its `center` point.", "title": "Circle", "type": "object", "required": [ "center", "radius" ], "properties": { "center": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, "radius": { "description": "The radius of the circle measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-circle.yaml" } }, { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, { "additionalProperties": false, "description": "Defines a polygon from a series of connected points.", "title": "Polygon", "type": "object", "required": [ "points" ], "properties": { "points": { "description": "Series of PointShapeType objects. The last and first points connect to close the shape automatically.", "type": "array", "items": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } } } }, "x-akamai": { "file-path": "schemas/shape-type-polygon.yaml" } }, { "additionalProperties": false, "description": "Defines a rectangle's `width` and `height` relative to an `anchor` point at the top left corner.", "title": "Rectangle", "type": "object", "required": [ "anchor", "width", "height" ], "properties": { "anchor": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, "height": { "description": "Extends the rectangle down from the `anchor` point.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "width": { "description": "Extends the rectangle right from the `anchor` point.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-rectangle.yaml" } }, { "additionalProperties": false, "description": "Identifies a combined shape based on a set of other shapes.", "title": "Union", "type": "object", "required": [ "shapes" ], "properties": { "shapes": { "description": "A nested shape used to describe a more complex shape.", "type": "array", "items": { "description": "A nested shape used to describe a more complex shape.", "title": "Nested shape", "type": "object", "x-akamai": { "file-path": "schemas/shape-type-nested.yaml" } } } }, "x-akamai": { "file-path": "schemas/shape-type-union.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the specified area of interest in the source image, `zoom` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` places raw crop around the point of interest, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and point of interest as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the point of interest, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "fill", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RegionOfInterestCrop", "description": "Identifies the type of transformation, `RegionOfInterestCrop` in this case.", "type": "string", "enum": [ "RegionOfInterestCrop" ] }, "width": { "description": "The width in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-region-of-interest-crop.yaml" } }, { "additionalProperties": false, "description": "Shrinks or expands an image relative to the image's specified dimensions. Image & Video Manager fills the expanded areas with transparency. Positive values shrink the side, while negative values expand it.", "title": "RelativeCrop", "type": "object", "required": [ "transformation" ], "properties": { "east": { "description": "The number of pixels to shrink or expand the right side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "north": { "description": "The number of pixels to shrink or expand the top side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "south": { "description": "The number of pixels to shrink or expand the bottom side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RelativeCrop", "description": "Identifies the type of transformation, `RelativeCrop` in this case.", "type": "string", "enum": [ "RelativeCrop" ] }, "west": { "description": "The number of pixels to shrink or expand the left side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-relative-crop.yaml" } }, { "additionalProperties": false, "description": "Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.", "title": "RemoveColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value to remove.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "feather": { "description": "The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent, creating a softer edge. The first real-time request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "tolerance": { "description": "The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.", "oneOf": [ { "default": 0.2, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RemoveColor", "description": "Identifies the type of transformation, `RemoveColor` in this case.", "type": "string", "enum": [ "RemoveColor" ] } }, "x-akamai": { "file-path": "schemas/t-remove-color.yaml" } }, { "additionalProperties": false, "description": "Resizes an image to a particular, absolute dimension. If you don't enter a `width` or a `height`, the image is resized with the `fit` aspect preservation mode, which selects a value for the missing dimension that preserves the image's aspect.", "title": "Resize", "type": "object", "required": [ "transformation" ], "properties": { "aspect": { "description": "Preserves the aspect ratio. Select `fit` to make the image fit entirely within the selected width and height. When using `fit`, the resulting image has the largest possible size for the specified dimensions. Select `fill` to size the image so it both completely fills the dimensions and has the smallest possible file size. Otherwise `ignore` changes the original aspect ratio to fit within an arbitrarily shaped rectangle.", "oneOf": [ { "default": "fit", "title": "String enum", "type": "string", "enum": [ "fit", "fill", "ignore" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height to resize the source image to. Must be set if `width` is not specified.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Resize", "description": "Identifies the type of transformation, `Resize` in this case.", "type": "string", "enum": [ "Resize" ] }, "type": { "description": "Sets constraints for the image resize. Select `normal` to resize in all cases, either increasing or decreasing the dimensions. Select `downsize` to ignore this transformation if the result would be larger than the original. Select `upsize` to ignore this transformation if the result would be smaller.", "oneOf": [ { "default": "normal", "title": "String enum", "type": "string", "enum": [ "normal", "upsize", "downsize" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "width": { "description": "The width to resize the source image to. Must be set if `height` is not specified.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-resize.yaml" } }, { "additionalProperties": false, "description": "Rotate the image around its center by indicating the degrees of rotation.", "title": "Rotate", "type": "object", "required": [ "transformation", "degrees" ], "properties": { "degrees": { "description": "The value to rotate the image by. Positive values rotate clockwise, while negative values rotate counter-clockwise.", "oneOf": [ { "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Rotate", "description": "Identifies the type of transformation, `Rotate` in this case.", "type": "string", "enum": [ "Rotate" ] } }, "x-akamai": { "file-path": "schemas/t-rotate.yaml" } }, { "additionalProperties": false, "description": "Changes the image's size to different dimensions relative to its starting size.", "title": "Scale", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "height": { "description": "Scaling factor for the input height to determine the output height of the image, where values between `0` and `1` decrease size. Image dimensions need to be non-zero positive numbers.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Scale", "description": "Identifies the type of transformation, `Scale` in this case.", "type": "string", "enum": [ "Scale" ] }, "width": { "description": "Scaling factor for the input width to determine the output width of the image, where `1` leaves the width unchanged. Values greater than `1` increase the image size. Image dimensions need to be non-zero positive numbers.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-scale.yaml" } }, { "additionalProperties": false, "description": "Slants an image into a parallelogram, as a percent of the starting dimension as represented in decimal format. You need to specify at least one axis property. Transparent pixels fill empty areas around the sheared image as needed, so it's often useful to use a `BackgroundColor` transformation for these areas.", "title": "Shear", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Shear", "description": "Identifies the type of transformation, `Shear` in this case.", "type": "string", "enum": [ "Shear" ] }, "xShear": { "description": "The amount to shear along the x-axis, measured in multiples of the image's width. Required if `yShear` is not specified.", "oneOf": [ { "default": 0, "format": "float", "maximum": 5, "minimum": -5, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yShear": { "description": "The amount to shear along the y-axis, measured in multiples of the image's height. Required if `xShear` is not specified.", "oneOf": [ { "default": 0, "format": "float", "maximum": 5, "minimum": -5, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-shear.yaml" } }, { "additionalProperties": false, "description": "Automatically crops uniform backgrounds from the edges of an image.", "title": "Trim", "type": "object", "required": [ "transformation" ], "properties": { "fuzz": { "description": "The fuzz tolerance of the trim, a value between `0` and `1` that determines the acceptable amount of background variation before trimming stops.", "oneOf": [ { "default": 0.08, "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "The amount of padding in pixels to add to the trimmed image.", "oneOf": [ { "default": 0, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Trim", "description": "Identifies the type of transformation, `Trim` in this case.", "type": "string", "enum": [ "Trim" ] } }, "x-akamai": { "file-path": "schemas/t-trim.yaml" } }, { "additionalProperties": false, "description": "Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as _sharpening_ an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image & Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.", "title": "UnsharpMask", "type": "object", "required": [ "transformation" ], "properties": { "gain": { "description": "Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "sigma": { "description": "The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels, `1.0` by default. High values emphasize large details and low values emphasize small details.", "oneOf": [ { "default": 1, "format": "float", "maximum": 10, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "threshold": { "description": "Set the minimum change required to include a detail in the filter. Higher values discard more changes.", "oneOf": [ { "default": 0.05, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "UnsharpMask", "description": "Identifies the type of transformation, `UnsharpMask` in this case.", "type": "string", "enum": [ "UnsharpMask" ] } }, "x-akamai": { "file-path": "schemas/t-unsharp-mask.yaml" } } ] } }, "video": { "default": false, "description": "Identifies this as an image policy.", "readOnly": true, "type": "boolean", "enum": [ false ] } }, "x-akamai": { "file-path": "schemas/policy-image-specific.yaml" } }, { "additionalProperties": false, "properties": { "breakpoints": { "additionalProperties": false, "description": "The breakpoint widths (in pixels) to use to create derivative images or videos.", "title": "Breakpoints", "type": "object", "properties": { "widths": { "description": "Specifies each integer breakpoint width value.", "minItems": 1, "type": "array", "items": { "maximum": 5000, "minimum": 1, "type": "integer" } } } }, "dateCreated": { "description": "Date this policy version was created in ISO 8601 extended notation format.", "readOnly": true, "type": "string" }, "hosts": { "description": "Hosts that are allowed for image or video URLs within transformations or variables.", "type": "array", "items": { "type": "string" } }, "id": { "description": "Unique identifier for a policy which can be up to 64 alphanumeric characters and can include underscores or dashes.", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "readOnly": true, "type": "string" }, "previousVersion": { "description": "The previous version number of this policy version.", "readOnly": true, "type": "integer" }, "rolloutDuration": { "default": 3600, "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. This value has no effect on the staging network.", "maximum": 604800, "minimum": 3600, "type": "integer", "writeOnly": true }, "rolloutInfo": { "additionalProperties": false, "description": "Contains information about policy rollout start and completion times.", "readOnly": true, "type": "object", "properties": { "endTime": { "description": "The estimated time that rollout for this policy will end in UNIX timestamp format.", "type": "integer" }, "rolloutDuration": { "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. Policies on the staging network deploy as quickly as possible without rollout. For staging policies this value will always be 1.", "maximum": 604800, "minimum": 3600, "type": "integer" }, "startTime": { "description": "The estimated time that rollout for this policy will begin in UNIX timestamp format.", "type": "integer" } } }, "user": { "description": "The user who created this policy version.", "readOnly": true, "type": "string" }, "variables": { "description": "Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as an Inline Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.", "type": "array", "items": { "additionalProperties": false, "title": "Variable", "type": "object", "required": [ "name", "type", "defaultValue" ], "properties": { "defaultValue": { "description": "The default value of the variable if no query parameter is provided. It needs to be one of the `enumOptions` if any are provided.", "type": "string" }, "enumOptions": { "description": "Optionally limits the set of possible values for a variable. References to an enum `id` insert a corresponding `value`.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "id", "value" ], "properties": { "id": { "description": "The unique identifier for each enum value, up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "value": { "description": "The value of the variable when the `id` is provided.", "type": "string" } } } }, "name": { "description": "The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "postfix": { "description": "A postfix added to the value provided for the variable, or to the default value.", "type": "string" }, "prefix": { "description": "A prefix added to the value provided for the variable, or to the default value.", "type": "string" }, "type": { "description": "The type of value for the variable, either `bool`, `number`, `url`, `color`, `gravity`, `placement`, `scaleDimension`, `grayscaleType`, `aspect`, `resizeType`, `dimension`, `perceptualQuality`, `string`, or `focus`.", "type": "string", "enum": [ "bool", "number", "url", "color", "gravity", "placement", "scaleDimension", "grayscaleType", "aspect", "resizeType", "dimension", "perceptualQuality", "string", "focus" ] } }, "x-akamai": { "file-path": "schemas/variable.yaml" } } }, "version": { "description": "The version number of this policy version.", "readOnly": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/policy-shared.yaml" } } ] }, { "description": "Specifies details for each policy such as video size.", "title": "Video policy", "type": "object", "x-akamai": { "file-path": "schemas/policy-video.yaml" }, "allOf": [ { "additionalProperties": false, "type": "object", "properties": { "output": { "additionalProperties": false, "description": "Dictates the output quality for each resized video.", "title": "Output", "type": "object", "properties": { "perceptualQuality": { "description": "The quality of derivative videos. High preserves video quality with reduced byte savings while low reduces video quality to increase byte savings.", "oneOf": [ { "default": "medium", "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "placeholderVideoUrl": { "description": "Allows you to add a specific placeholder video that appears when a user first requests a video, but before Image & Video Manager processes the video. If not specified the original video plays during the processing time.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "videoAdaptiveQuality": { "description": "Overrides the quality of video to serve when Image & Video Manager detects a slow connection with a round-trip time (RTT) of 300 ms. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of videos for users with faster connections.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } } }, "video": { "default": true, "description": "Identifies this as a video policy.", "readOnly": true, "type": "boolean", "enum": [ true ] } }, "x-akamai": { "file-path": "schemas/policy-video-specific.yaml" } }, { "additionalProperties": false, "properties": { "breakpoints": { "additionalProperties": false, "description": "The breakpoint widths (in pixels) to use to create derivative images or videos.", "title": "Breakpoints", "type": "object", "properties": { "widths": { "description": "Specifies each integer breakpoint width value.", "minItems": 1, "type": "array", "items": { "maximum": 5000, "minimum": 1, "type": "integer" } } } }, "dateCreated": { "description": "Date this policy version was created in ISO 8601 extended notation format.", "readOnly": true, "type": "string" }, "hosts": { "description": "Hosts that are allowed for image or video URLs within transformations or variables.", "type": "array", "items": { "type": "string" } }, "id": { "description": "Unique identifier for a policy which can be up to 64 alphanumeric characters and can include underscores or dashes.", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "readOnly": true, "type": "string" }, "previousVersion": { "description": "The previous version number of this policy version.", "readOnly": true, "type": "integer" }, "rolloutDuration": { "default": 3600, "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. This value has no effect on the staging network.", "maximum": 604800, "minimum": 3600, "type": "integer", "writeOnly": true }, "rolloutInfo": { "additionalProperties": false, "description": "Contains information about policy rollout start and completion times.", "readOnly": true, "type": "object", "properties": { "endTime": { "description": "The estimated time that rollout for this policy will end in UNIX timestamp format.", "type": "integer" }, "rolloutDuration": { "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. Policies on the staging network deploy as quickly as possible without rollout. For staging policies this value will always be 1.", "maximum": 604800, "minimum": 3600, "type": "integer" }, "startTime": { "description": "The estimated time that rollout for this policy will begin in UNIX timestamp format.", "type": "integer" } } }, "user": { "description": "The user who created this policy version.", "readOnly": true, "type": "string" }, "variables": { "description": "Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as an Inline Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.", "type": "array", "items": { "additionalProperties": false, "title": "Variable", "type": "object", "required": [ "name", "type", "defaultValue" ], "properties": { "defaultValue": { "description": "The default value of the variable if no query parameter is provided. It needs to be one of the `enumOptions` if any are provided.", "type": "string" }, "enumOptions": { "description": "Optionally limits the set of possible values for a variable. References to an enum `id` insert a corresponding `value`.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "id", "value" ], "properties": { "id": { "description": "The unique identifier for each enum value, up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "value": { "description": "The value of the variable when the `id` is provided.", "type": "string" } } } }, "name": { "description": "The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "postfix": { "description": "A postfix added to the value provided for the variable, or to the default value.", "type": "string" }, "prefix": { "description": "A prefix added to the value provided for the variable, or to the default value.", "type": "string" }, "type": { "description": "The type of value for the variable, either `bool`, `number`, `url`, `color`, `gravity`, `placement`, `scaleDimension`, `grayscaleType`, `aspect`, `resizeType`, `dimension`, `perceptualQuality`, `string`, or `focus`.", "type": "string", "enum": [ "bool", "number", "url", "color", "gravity", "placement", "scaleDimension", "grayscaleType", "aspect", "resizeType", "dimension", "perceptualQuality", "string", "focus" ] } }, "x-akamai": { "file-path": "schemas/variable.yaml" } } }, "version": { "description": "The version number of this policy version.", "readOnly": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/policy-shared.yaml" } } ] } ] }, "id": { "description": "Unique identifier of the policy set.", "readOnly": true, "type": "string" }, "lastModified": { "description": "Date this policy set was last modified in ISO 8601 extended notation format.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "A friendly name for the policy set.", "type": "string" }, "properties": { "description": "The names of Property Manager properties using this policy set.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "region": { "description": "The geographic region for which the media using this policy set is optimized. Altering the value on an existing policy set voids previously cached images and videos and require their transformation again. The supported geographic regions are `US`, `EMEA`, `ASIA`, `AUSTRALIA`, `JAPAN`, or `CHINA`. `EMEA` is Europe, the Middle East, and Africa.", "title": "Region", "type": "string", "enum": [ "US", "EMEA", "ASIA", "AUSTRALIA", "JAPAN", "CHINA" ], "x-akamai": { "file-path": "schemas/policyset-region.yaml" } }, "type": { "description": "The type of media this policy set manages, either `IMAGE` or `VIDEO`.", "title": "MediaType", "type": "string", "enum": [ "IMAGE", "VIDEO" ], "x-akamai": { "file-path": "schemas/policyset-type.yaml" } }, "user": { "description": "Username of the person who most recently updated the policy set.", "readOnly": true, "type": "string" } }, "x-akamai": { "file-path": "schemas/policyset.yaml" } } } } }, "400": { "description": "Unable to create policy set.", "content": { "application/problem+json": { "examples": { "Missing China Addon": { "value": { "detail": "Contract A-CCT7890 cannot create policy sets for the China region.", "instance": "/imaging/error-instances/0b66238c-44f3-4e9f-917b-e3847570529d", "status": 400, "title": "Bad Request", "type": "/imaging/error-types/IVM_1003" } }, "Missing Product": { "value": { "detail": "Contract A-CCT7890 cannot create video policy sets.", "instance": "/imaging/error-instances/0b66238c-44f3-4e9f-917b-e3847570529d", "status": 400, "title": "Bad Request", "type": "/imaging/error-types/IVM_1003" } } }, "schema": { "additionalProperties": false, "description": "Error messaging.", "type": "object", "properties": { "detail": { "description": "A detailed description of the error.", "type": "string" }, "httpStatus": { "description": "The HTTP code for the error.", "type": "integer" }, "instance": { "description": "A reference to unique instance of the error.", "type": "string" }, "requestId": { "description": "An additional instance identifier for the error.", "type": "string" }, "title": { "description": "The summary description of the error.", "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } } } }, "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "get": { "description": "Returns a list of all policy sets for a contract in production.", "operationId": "get-policysets", "summary": "List policy sets", "tags": [ "Policy sets" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Image & Video Manager API", "url": "https://techdocs.akamai.com/ivm/reference/get-policysets" }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "description": "Lists the policy sets for a contract.", "type": "array", "items": { "additionalProperties": false, "description": "Specifies details of a policy set, such as the type of media its policies optimize and the region for which their delivery is best optimized.", "title": "Policy set", "type": "object", "required": [ "type", "region" ], "properties": { "defaultPolicy": { "description": "The default policy to deploy this policy set with. If unspecified the policy set will use the system default.", "writeOnly": true, "oneOf": [ { "description": "Specifies details for each policy, such as variations in image size and formats and the transformations to apply.", "title": "Image policy", "type": "object", "x-akamai": { "file-path": "schemas/policy-image.yaml" }, "allOf": [ { "additionalProperties": false, "type": "object", "properties": { "output": { "additionalProperties": false, "description": "Dictates the output quality, either `quality` or `perceptualQuality`, and the formats created for each resized image. If unspecified, you get image formats that support all browsers at the default quality level of `85`, including WEBP, JPEG2000, and JPEG-XR for specific browsers.", "title": "Output", "type": "object", "properties": { "adaptiveQuality": { "description": "Overrides the quality of the image to serve when Image & Video Manager detects a slow connection with a round-trip time (RTT) of less than 300 ms. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of images for users with standard connections.", "maximum": 100, "minimum": 1, "type": "integer" }, "allowedFormats": { "description": "The graphics file formats allowed for browser specific results, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "minItems": 1, "readOnly": true, "type": "array", "uniqueItems": true, "default": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ], "items": { "description": "The values of the allowed graphics file formats, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "type": "string", "enum": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ] } }, "forcedFormats": { "description": "The forced extra formats for the `imFormat` query parameter, which requests a specific browser type. By default, Image & Video Manager detects the browser and returns the appropriate image.", "readOnly": true, "type": "array", "uniqueItems": true, "default": [], "items": { "description": "The values of the forced extra formats, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "type": "string", "enum": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ] } }, "perceptualQuality": { "description": "Mutually exclusive with `quality`. The perceptual quality to use when comparing resulting images, which overrides the `quality` setting. Perceptual quality tunes each image format's quality dynamically based on the human-perceived quality of the output image. This can result in greater byte savings as compared to using regular `quality` because many images can be encoded at a much lower quality without compromising the perceived quality of the image. In addition, certain images may need to be encoded at a slightly higher quality in order to maintain human-perceived quality. Value tiers are `high`, `mediumHigh`, `medium`, `mediumLow`, and `low`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "perceptualQualityFloor": { "description": "Applies only when `perceptualQuality` is set. Sets a minimum image quality to respect when using perceptual quality. Perceptual quality won't reduce the quality below this value, even if it determines the compressed image to be acceptably visually similar.", "maximum": 100, "minimum": 1, "type": "integer" }, "quality": { "description": "Mutually exclusive with `perceptualQuality`, used by default if neither is specified. The chosen quality of output images from 1-100, with 1 being the lowest quality and 100 being the highest.", "oneOf": [ { "default": 85, "maximum": 100, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } } }, "postBreakpointTransformations": { "description": "Post-processing Transformations are applied to the image after image and quality settings have been applied.", "type": "array", "items": { "description": "A transformation to apply to the image/object/text.", "x-akamai": { "file-path": "schemas/transformation-post-breakpoint.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Places a transparent image on a set background color. Specify the color in CSS hexadecimal format.", "title": "BackgroundColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value for the background.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "BackgroundColor", "description": "Identifies the type of transformation, `BackgroundColor` in this case.", "type": "string", "enum": [ "BackgroundColor" ] } }, "x-akamai": { "file-path": "schemas/t-background-color.yaml" } }, { "additionalProperties": false, "description": "Applies a Gaussian blur to the image.", "title": "Blur", "type": "object", "required": [ "transformation" ], "properties": { "sigma": { "description": "The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.", "oneOf": [ { "default": 5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Blur", "description": "Identifies the type of transformation, `Blur` in this case.", "type": "string", "enum": [ "Blur" ] } }, "x-akamai": { "file-path": "schemas/t-blur.yaml" } }, { "additionalProperties": false, "description": "Changes any color in an image within the specified volume of the HSL colorspace to transparent or semi-transparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.", "title": "ChromaKey", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120\u00b0 on the color wheel.", "oneOf": [ { "default": 120, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueFeather": { "description": "How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30\u00b0 around the Hue Tolerance.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueTolerance": { "description": "How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30\u00b0 around the specified hue.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessFeather": { "description": "How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessTolerance": { "description": "How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a color must be within 75% of the full color to full white or full black for full removal.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationFeather": { "description": "How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the Saturation Tolerance.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationTolerance": { "description": "How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "ChromaKey", "description": "Identifies the type of transformation, `ChromaKey` in this case.", "type": "string", "enum": [ "ChromaKey" ] } }, "x-akamai": { "file-path": "schemas/t-chroma-key.yaml" } }, { "additionalProperties": false, "description": "An ordered combination of transformations to perform. Use to represent a sequence of transformations as a single transformation.", "title": "Compound", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Compound", "description": "Identifies the type of transformation, `Compound` in this case.", "type": "string", "enum": [ "Compound" ] }, "transformations": { "description": "A set of nested image transformations to apply to the source image.", "type": "array", "items": { "type": "object" } } }, "x-akamai": { "file-path": "schemas/t-compound.yaml" } }, { "additionalProperties": false, "description": "Adjusts both the contrast and brightness of an image.", "title": "Contrast", "type": "object", "required": [ "transformation" ], "properties": { "brightness": { "description": "Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of `1` produces a white image. A value of `-1` produces a black image. The default value is `0`, which leaves the image unchanged. The acceptable value range is `-1.0` to `1.0`. Values outside of the acceptable range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "contrast": { "description": "Adjusts the contrast of the image. Expressed as a range from `-1` to `1`, positive values increase contrast, negative values decrease it, while `0` leaves the image unchanged. Values outside of the `-1` to `1` range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Contrast", "description": "Identifies the type of transformation, `Contrast` in this case.", "type": "string", "enum": [ "Contrast" ] } }, "x-akamai": { "file-path": "schemas/t-contrast.yaml" } }, { "additionalProperties": false, "description": "Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears _goopy_. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.", "title": "Goop", "type": "object", "required": [ "transformation" ], "properties": { "chaos": { "description": "Specifies the greatest distance control points may move from their original position. A value of `1.0` shifts control points over as far as the next one in the original grid. A value of `0.0` leaves the image unchanged. Values under `0.5` work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "density": { "description": "Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium- to large-size images.", "oneOf": [ { "default": 4, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "power": { "description": "By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldn't need to vary the default value of `2.0`.", "oneOf": [ { "default": 2, "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "seed": { "description": "Specifies your own `seed` value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used, `Goop` distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Goop", "description": "Identifies the type of transformation, `Goop` in this case.", "type": "string", "enum": [ "Goop" ] } }, "x-akamai": { "file-path": "schemas/t-goop.yaml" } }, { "additionalProperties": false, "description": "Restricts image color to shades of gray only.", "title": "Grayscale", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Grayscale", "description": "Identifies the type of transformation, `Grayscale` in this case.", "type": "string", "enum": [ "Grayscale" ] }, "type": { "default": "Rec709", "description": "The algorithm used to transform colors to grays, either `Brightness`, `Lightness`, `Rec601`, or the default `Rec709`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "Rec601", "Rec709", "Brightness", "Lightness" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-grayscale.yaml" } }, { "additionalProperties": false, "description": "Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as `Grayscale` and `MaxColors`. If you're using more than one, consider the order to apply them for the desired results.", "title": "HSL", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightness": { "description": "A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green, whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than `1.0` decrease the lightness of colors in the image. Values greater than `1.0` increase the lightness of colors in the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSL", "description": "Identifies the type of transformation, `HSL` in this case.", "type": "string", "enum": [ "HSL" ] } }, "x-akamai": { "file-path": "schemas/t-hsl.yaml" } }, { "additionalProperties": false, "description": "Identical to HSL except it replaces `lightness` with `value`. For example, if you reduce the `lightness` of a light green, almost white, image, the color turns a vibrant green. Reducing the `value` turns the image a darker color, close to gray. This happens because the original image color is very close to white.", "title": "HSV", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0.0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSV", "description": "Identifies the type of transformation, `HSV` in this case.", "type": "string", "enum": [ "HSV" ] }, "value": { "description": "A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-hsv.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the dimensions of the source image. You need to select a dimension for comparison, which is either `width` and `height` or `both`.", "title": "IfDimension", "type": "object", "required": [ "transformation", "value" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "dimension": { "description": "The dimension to use to select the transformation, either `height`, `width`, or `both`. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "default": "width", "title": "String", "type": "string", "enum": [ "width", "height", "both" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "equal": { "description": "The transformation performed only if the source image's dimension is equal to the `value` listed.", "type": "object" }, "greaterThan": { "description": "The transformation performed if the source image's dimension is greater than the `value` listed.", "type": "object" }, "lessThan": { "description": "The transformation performed if the source image's dimension is less than the `value` listed.", "type": "object" }, "transformation": { "default": "IfDimension", "description": "Identifies the type of transformation, `IfDimension` in this case.", "type": "string", "enum": [ "IfDimension" ] }, "value": { "description": "The value to compare against the source image dimension. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-if-dimension.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the orientation of the source image. Defaults to the `default` transformation if no transformation is specified for the orientation.", "title": "IfOrientation", "type": "object", "required": [ "transformation" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "landscape": { "description": "The transformation performed if the source image uses landscape orientation.", "type": "object" }, "portrait": { "description": "The transformation performed if the source image uses portrait orientation.", "type": "object" }, "square": { "description": "The transformation performed if the source image uses a square orientation.", "type": "object" }, "transformation": { "default": "IfOrientation", "description": "Identifies the type of transformation, `IfOrientation` in this case.", "type": "string", "enum": [ "IfOrientation" ] } }, "x-akamai": { "file-path": "schemas/t-if-orientation.yaml" } }, { "additionalProperties": false, "description": "Set the maximum number of colors in the image palette. Reducing the number of colors in an image can help to reduce file size.", "title": "MaxColors", "type": "object", "required": [ "transformation", "colors" ], "properties": { "colors": { "description": "The value representing the maximum number of colors to use with the source image.", "oneOf": [ { "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MaxColors", "description": "Identifies the type of transformation, `MaxColors` in this case.", "type": "string", "enum": [ "MaxColors" ] } }, "x-akamai": { "file-path": "schemas/t-max-colors.yaml" } }, { "additionalProperties": false, "description": "Flips an image horizontally, vertically, or both.", "minProperties": 2, "title": "Mirror", "type": "object", "required": [ "transformation" ], "properties": { "horizontal": { "description": "Flips the image horizontally.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Mirror", "description": "Identifies the type of transformation, `Mirror` in this case.", "title": "IfDimension", "type": "string", "enum": [ "Mirror" ] }, "vertical": { "description": "Flips the image vertically.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-mirror.yaml" } }, { "additionalProperties": false, "description": "Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color's lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.", "title": "MonoHue", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MonoHue", "description": "Identifies the type of transformation, `MonoHue` in this case.", "type": "string", "enum": [ "MonoHue" ] } }, "x-akamai": { "file-path": "schemas/t-mono-hue.yaml" } }, { "additionalProperties": false, "description": "Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.", "title": "Opacity", "type": "object", "required": [ "transformation", "opacity" ], "properties": { "opacity": { "description": "Represents alpha values on a scale of `0` to `1`. Values below `1` increase transparency, and `0` is invisible. For images that have some transparency, values above `1` increase the opacity of the transparent portions.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Opacity", "description": "Identifies the type of transformation, `Opacity` in this case.", "type": "string", "enum": [ "Opacity" ] } }, "x-akamai": { "file-path": "schemas/t-opacity.yaml" } }, { "additionalProperties": false, "description": "Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.", "title": "RemoveColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value to remove.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "feather": { "description": "The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent, creating a softer edge. The first real-time request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "tolerance": { "description": "The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.", "oneOf": [ { "default": 0.2, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RemoveColor", "description": "Identifies the type of transformation, `RemoveColor` in this case.", "type": "string", "enum": [ "RemoveColor" ] } }, "x-akamai": { "file-path": "schemas/t-remove-color.yaml" } }, { "additionalProperties": false, "description": "Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as _sharpening_ an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image & Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.", "title": "UnsharpMask", "type": "object", "required": [ "transformation" ], "properties": { "gain": { "description": "Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "sigma": { "description": "The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels, `1.0` by default. High values emphasize large details and low values emphasize small details.", "oneOf": [ { "default": 1, "format": "float", "maximum": 10, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "threshold": { "description": "Set the minimum change required to include a detail in the filter. Higher values discard more changes.", "oneOf": [ { "default": 0.05, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "UnsharpMask", "description": "Identifies the type of transformation, `UnsharpMask` in this case.", "type": "string", "enum": [ "UnsharpMask" ] } }, "x-akamai": { "file-path": "schemas/t-unsharp-mask.yaml" } } ] } }, "transformations": { "description": "Set of image transformations to apply to the source image. If unspecified, no operations are performed.", "type": "array", "items": { "description": "A transformation to apply to the image/object/text.", "x-akamai": { "file-path": "schemas/transformation.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Places a specified `image` beside the source image. The API places the `image` on a major dimension, then aligns it on the minor dimension. Transparent pixels fill any area not covered by either image.", "title": "Append", "type": "object", "required": [ "transformation", "image" ], "properties": { "gravity": { "default": "Center", "description": "Specifies where to place the `image` relative to the source image. The available values represent the eight cardinal directions (`North`, `South`, `East`, `West`, `NorthEast`, `NorthWest`, `SouthEast`, `SouthWest`) and a `Center` by default.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravityPriority": { "description": "Determines the exact placement of the `image` when `gravity` is `Center` or a diagonal. The value is either `horizontal` or `vertical`. Use `horizontal` to append an `image` east or west of the source image. This aligns the `image` on the vertical gravity component, placing `Center` gravity east. Use `vertical` to append an `image` north or south of the source image. This aligns the `image` on the horizontal gravity component, placing `Center` gravity south.", "oneOf": [ { "default": "horizontal", "title": "String enum", "type": "string", "enum": [ "horizontal", "vertical" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "image": { "x-akamai": { "file-path": "schemas/image-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "A rectangular box, with a specified color and applied transformation.", "title": "Box image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the box, not the color of the edges of the box. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Box", "description": "Identifies the type of image, `Box` in this case.", "type": "string", "enum": [ "Box" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-box.yaml" } }, { "additionalProperties": false, "description": "A simple, solid, monochrome circle of a specified diameter on a transparent background.", "title": "Circle image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "diameter": { "description": "The diameter of the circle. The diameter will be the width and the height of the image in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Circle", "description": "Identifies the type of image, `Circle` in this case.", "type": "string", "enum": [ "Circle" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-circle.yaml" } }, { "additionalProperties": false, "description": "A snippet of text. Defines the font family, font size, fill color, outline stroke width, and outline color.", "title": "Text image", "type": "object", "required": [ "type", "text" ], "properties": { "fill": { "description": "The main fill color of the text.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "size": { "description": "The size in pixels to render the text.", "oneOf": [ { "default": 72, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "stroke": { "description": "The color of the outline of the text.", "oneOf": [ { "default": "#FFF", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "strokeSize": { "description": "The thickness in points of the outline of the text.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "text": { "description": "The line of text to render.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Text", "description": "Identifies the type of image, `Text` in this case.", "type": "string", "enum": [ "Text" ] }, "typeface": { "description": "The font family to apply to the text image. This may be the URL of a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.", "oneOf": [ { "default": "DejaVuSans", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-text.yaml" } }, { "additionalProperties": false, "description": "An image loaded from a URL.", "title": "URL image", "type": "object", "required": [ "url" ], "properties": { "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "URL", "description": "Identifies the type of image, `URL` in this case.", "type": "string", "enum": [ "URL" ] }, "url": { "description": "The URL of the image.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-url.yaml" } } ] }, "preserveMinorDimension": { "description": "Whether to preserve the source image's minor dimension, `false` by default. The minor dimension is the dimension opposite the dimension that the appending `image` is placed. For example, the dimensions of the source image are 100 × 100 pixels. The dimensions of the appending `image` are 50 × 150 pixels. The `gravity` is set to `East`. This makes the major dimension horizontal and the source image's minor dimension vertical. To preserve the source image's minor dimension at 100 pixels, the `preserveMinorDimension` is set to `true`. As a result of the append, the major dimension expanded with the appended image to 150 pixels. The source image's minor dimension was maintained at 100 pixels. The total combined dimension of the image is 150 × 100 pixels.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Append", "description": "Identifies the type of transformation, `Append` in this case.", "type": "string", "enum": [ "Append" ] } }, "x-akamai": { "file-path": "schemas/t-append.yaml" } }, { "additionalProperties": false, "description": "Changes the height or width of an image, either by cropping or expanding the area, to an aspect ratio of your choosing.", "title": "AspectCrop", "type": "object", "required": [ "transformation" ], "properties": { "allowExpansion": { "description": "Increases the size of the image canvas to achieve the requested aspect ratio instead of cropping the image. Use the Horizontal Offset and Vertical Offset settings to determine where to add the fully transparent pixels on the expanded image canvas.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height term of the aspect ratio to crop.", "oneOf": [ { "default": 1, "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "AspectCrop", "description": "Identifies the type of transformation, `AspectCrop` in this case.", "type": "string", "enum": [ "AspectCrop" ] }, "width": { "description": "The width term of the aspect ratio to crop.", "oneOf": [ { "default": 1, "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "xPosition": { "description": "Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.", "oneOf": [ { "default": 0.5, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "description": "Specifies the horizontal portion of the image you want to keep when cropping by aspect ratio crop. When using `allowExpansion`, this setting defines the horizontal position of the image on the new expanded image canvas.", "oneOf": [ { "default": 0.5, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-aspect-crop.yaml" } }, { "additionalProperties": false, "description": "Places a transparent image on a set background color. Specify the color in CSS hexadecimal format.", "title": "BackgroundColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value for the background.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "BackgroundColor", "description": "Identifies the type of transformation, `BackgroundColor` in this case.", "type": "string", "enum": [ "BackgroundColor" ] } }, "x-akamai": { "file-path": "schemas/t-background-color.yaml" } }, { "additionalProperties": false, "description": "Applies a Gaussian blur to the image.", "title": "Blur", "type": "object", "required": [ "transformation" ], "properties": { "sigma": { "description": "The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.", "oneOf": [ { "default": 5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Blur", "description": "Identifies the type of transformation, `Blur` in this case.", "type": "string", "enum": [ "Blur" ] } }, "x-akamai": { "file-path": "schemas/t-blur.yaml" } }, { "additionalProperties": false, "description": "Changes any color in an image within the specified volume of the HSL colorspace to transparent or semi-transparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.", "title": "ChromaKey", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120\u00b0 on the color wheel.", "oneOf": [ { "default": 120, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueFeather": { "description": "How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30\u00b0 around the Hue Tolerance.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueTolerance": { "description": "How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30\u00b0 around the specified hue.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessFeather": { "description": "How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessTolerance": { "description": "How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a color must be within 75% of the full color to full white or full black for full removal.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationFeather": { "description": "How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the Saturation Tolerance.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationTolerance": { "description": "How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "ChromaKey", "description": "Identifies the type of transformation, `ChromaKey` in this case.", "type": "string", "enum": [ "ChromaKey" ] } }, "x-akamai": { "file-path": "schemas/t-chroma-key.yaml" } }, { "additionalProperties": false, "description": "Applies another image to the source image, either as an overlay or an underlay. The image that's underneath is visible in areas that are beyond the edges of the top image or that are less than 100% opaque. A common use of an overlay composite is to add a watermark.", "title": "Composite", "type": "object", "required": [ "transformation", "image" ], "properties": { "gravity": { "default": "NorthWest", "description": "Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "image": { "x-akamai": { "file-path": "schemas/image-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "A rectangular box, with a specified color and applied transformation.", "title": "Box image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the box, not the color of the edges of the box. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Box", "description": "Identifies the type of image, `Box` in this case.", "type": "string", "enum": [ "Box" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-box.yaml" } }, { "additionalProperties": false, "description": "A simple, solid, monochrome circle of a specified diameter on a transparent background.", "title": "Circle image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "diameter": { "description": "The diameter of the circle. The diameter will be the width and the height of the image in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Circle", "description": "Identifies the type of image, `Circle` in this case.", "type": "string", "enum": [ "Circle" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-circle.yaml" } }, { "additionalProperties": false, "description": "A snippet of text. Defines the font family, font size, fill color, outline stroke width, and outline color.", "title": "Text image", "type": "object", "required": [ "type", "text" ], "properties": { "fill": { "description": "The main fill color of the text.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "size": { "description": "The size in pixels to render the text.", "oneOf": [ { "default": 72, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "stroke": { "description": "The color of the outline of the text.", "oneOf": [ { "default": "#FFF", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "strokeSize": { "description": "The thickness in points of the outline of the text.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "text": { "description": "The line of text to render.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Text", "description": "Identifies the type of image, `Text` in this case.", "type": "string", "enum": [ "Text" ] }, "typeface": { "description": "The font family to apply to the text image. This may be the URL of a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.", "oneOf": [ { "default": "DejaVuSans", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-text.yaml" } }, { "additionalProperties": false, "description": "An image loaded from a URL.", "title": "URL image", "type": "object", "required": [ "url" ], "properties": { "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "URL", "description": "Identifies the type of image, `URL` in this case.", "type": "string", "enum": [ "URL" ] }, "url": { "description": "The URL of the image.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-url.yaml" } } ] }, "placement": { "description": "Where to place the specified image, either `Over` or `Under` the existing image. Watermarks are usually applied over. Backgrounds are usually applied under.", "oneOf": [ { "default": "Over", "title": "String enum", "type": "string", "enum": [ "Over", "Under", "Mask", "Stencil" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "scale": { "description": "A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the `scaleDimension` to calculate the `scale` from the source image's width or height.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "scaleDimension": { "description": "The dimension, either `width` or `height`, of the source image to scale.", "oneOf": [ { "default": "width", "title": "String enum", "type": "string", "enum": [ "width", "height" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Composite", "description": "Identifies the type of transformation, `Composite` in this case.", "type": "string", "enum": [ "Composite" ] }, "xPosition": { "description": "The x-axis position of the image to apply.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "default": 0, "description": "The y-axis position of the image to apply.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-composite.yaml" } }, { "additionalProperties": false, "description": "An ordered combination of transformations to perform. Use to represent a sequence of transformations as a single transformation.", "title": "Compound", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Compound", "description": "Identifies the type of transformation, `Compound` in this case.", "type": "string", "enum": [ "Compound" ] }, "transformations": { "description": "A set of nested image transformations to apply to the source image.", "type": "array", "items": { "type": "object" } } }, "x-akamai": { "file-path": "schemas/t-compound.yaml" } }, { "additionalProperties": false, "description": "Adjusts both the contrast and brightness of an image.", "title": "Contrast", "type": "object", "required": [ "transformation" ], "properties": { "brightness": { "description": "Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of `1` produces a white image. A value of `-1` produces a black image. The default value is `0`, which leaves the image unchanged. The acceptable value range is `-1.0` to `1.0`. Values outside of the acceptable range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "contrast": { "description": "Adjusts the contrast of the image. Expressed as a range from `-1` to `1`, positive values increase contrast, negative values decrease it, while `0` leaves the image unchanged. Values outside of the `-1` to `1` range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Contrast", "description": "Identifies the type of transformation, `Contrast` in this case.", "type": "string", "enum": [ "Contrast" ] } }, "x-akamai": { "file-path": "schemas/t-contrast.yaml" } }, { "additionalProperties": false, "description": "Crops an image.", "title": "Crop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "allowExpansion": { "description": "If cropping an area outside of the existing canvas, expands the image canvas.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "NorthWest", "description": "Frame of reference for X and Y positions.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The number of pixels to crop along the y-axis.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Crop", "description": "Identifies the type of transformation, `Crop` in this case.", "type": "string", "enum": [ "Crop" ] }, "width": { "description": "The number of pixels to crop along the x-axis.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "xPosition": { "description": "The x-axis position of the image to crop from.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "description": "The y-axis position of the image to crop from.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-crop.yaml" } }, { "additionalProperties": false, "description": "Applies a method to detect faces in the source image and applies the rectangular crop on either the `biggest` face or `all` of the faces detected. Image & Video Manager tries to preserve faces in the image instead of using specified crop coordinates.", "title": "FaceCrop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "algorithm": { "description": "Specifies the type of algorithm used to detect faces in the image, either `cascade` for the cascade classifier algorithm or `dnn` for the deep neural network algorithm, `cascade` by default.", "oneOf": [ { "default": "cascade", "title": "String enum", "type": "string", "enum": [ "cascade", "dnn" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "confidence": { "description": "With `algorithm` set to `dnn`, specifies the minimum confidence needed to detect faces in the image. Values range from `0` to `1` for increased confidence, and possibly fewer faces detected.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "failGravity": { "default": "Center", "description": "Controls placement of the crop if Image & Video Manager does not detect any faces in the image. Directions are relative to the edges of the image being transformed.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "focus": { "description": "Distinguishes the faces detected, either `biggestFace` or `allFaces` to place the crop rectangle around the full set of faces. This is `all` by default.", "oneOf": [ { "default": "allFaces", "title": "String enum", "type": "string", "enum": [ "allFaces", "biggestFace" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "Center", "description": "Controls placement of the crop. Directions are relative to the face, plus padding.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the output image in pixels relative to the specified `style` value.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "The padding ratio based on the dimensions of the biggest face detected, `0.5` by default. Larger values increase padding.", "oneOf": [ { "default": 0.5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the faces detected in the source image, `zoom` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` places a raw crop around the faces, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and faces as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the faces, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "zoom", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FaceCrop", "description": "Identifies the type of transformation, `FaceCrop` in this case.", "type": "string", "enum": [ "FaceCrop" ] }, "width": { "description": "The width of the output image in pixels relative to the specified `style` value.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-face-crop.yaml" } }, { "additionalProperties": false, "description": "Identifies prominent features of the source image, then crops around as many of these features as possible relative to the specified `width` and `height` values.", "title": "FeatureCrop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "failGravity": { "default": "Center", "description": "Controls placement of the crop if Image & Video Manager does not detect any features in the image. Directions are relative to the edges of the image being transformed.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "featureRadius": { "description": "The size in pixels of the important features to search for. If identified, two features never appear closer together than this value, `8.0` by default.", "oneOf": [ { "default": 8, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "Center", "description": "Controls placement of the crop. Directions are relative to the region of interest plus padding.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "maxFeatures": { "description": "The maximum number of features to identify as important features, `32` by default. The strongest features are always chosen.", "oneOf": [ { "default": 32, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "minFeatureQuality": { "description": "Determines the minimum quality level of the feature identified. To consider a feature important, the feature needs to surpass this value. Image & Video Manager measures quality on a scale from `0` for the lowest quality to `1` for the highest quality, `.1` by default.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "Adds space around the region of interest. The amount of padding added is directly related to the size of the bounding box of the selected features. Specifically, the region of interest is expanded in all directions by the largest dimension of the bounding box of the selected features multiplied by this value.", "oneOf": [ { "default": 0.05, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the features identified in the source image, `fill` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` performs a raw crop around the features, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and features as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the features, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "zoom", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FeatureCrop", "description": "Identifies the type of transformation, `FeatureCrop` in this case.", "type": "string", "enum": [ "FeatureCrop" ] }, "width": { "description": "The width in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-feature-crop.yaml" } }, { "additionalProperties": false, "description": "Resizes an image to fit within a specific size box and then uses a fill of that same image to cover any transparent space at the edges. By default the fill image has a Blur transformation with a sigma value of 8 applied. Customize the transformation using the `fillTransformation` parameter.", "title": "FitAndFill", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "fillTransformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "height": { "description": "The height value of the resized image.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FitAndFill", "description": "Identifies the type of transformation, `FitAndFill` in this case.", "type": "string", "enum": [ "FitAndFill" ] }, "width": { "description": "The width value of the resized image.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-fit-and-fill.yaml" } }, { "additionalProperties": false, "description": "Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears _goopy_. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.", "title": "Goop", "type": "object", "required": [ "transformation" ], "properties": { "chaos": { "description": "Specifies the greatest distance control points may move from their original position. A value of `1.0` shifts control points over as far as the next one in the original grid. A value of `0.0` leaves the image unchanged. Values under `0.5` work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "density": { "description": "Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium- to large-size images.", "oneOf": [ { "default": 4, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "power": { "description": "By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldn't need to vary the default value of `2.0`.", "oneOf": [ { "default": 2, "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "seed": { "description": "Specifies your own `seed` value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used, `Goop` distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Goop", "description": "Identifies the type of transformation, `Goop` in this case.", "type": "string", "enum": [ "Goop" ] } }, "x-akamai": { "file-path": "schemas/t-goop.yaml" } }, { "additionalProperties": false, "description": "Restricts image color to shades of gray only.", "title": "Grayscale", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Grayscale", "description": "Identifies the type of transformation, `Grayscale` in this case.", "type": "string", "enum": [ "Grayscale" ] }, "type": { "default": "Rec709", "description": "The algorithm used to transform colors to grays, either `Brightness`, `Lightness`, `Rec601`, or the default `Rec709`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "Rec601", "Rec709", "Brightness", "Lightness" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-grayscale.yaml" } }, { "additionalProperties": false, "description": "Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as `Grayscale` and `MaxColors`. If you're using more than one, consider the order to apply them for the desired results.", "title": "HSL", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightness": { "description": "A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green, whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than `1.0` decrease the lightness of colors in the image. Values greater than `1.0` increase the lightness of colors in the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSL", "description": "Identifies the type of transformation, `HSL` in this case.", "type": "string", "enum": [ "HSL" ] } }, "x-akamai": { "file-path": "schemas/t-hsl.yaml" } }, { "additionalProperties": false, "description": "Identical to HSL except it replaces `lightness` with `value`. For example, if you reduce the `lightness` of a light green, almost white, image, the color turns a vibrant green. Reducing the `value` turns the image a darker color, close to gray. This happens because the original image color is very close to white.", "title": "HSV", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0.0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSV", "description": "Identifies the type of transformation, `HSV` in this case.", "type": "string", "enum": [ "HSV" ] }, "value": { "description": "A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-hsv.yaml" } }, { "additionalProperties": false, "description": "Apply artistic transformations to images quickly and dynamically by specifying transformations with a query string appended to the image URL.\n- transformation\n- query\n- allowedTransformations", "title": "ImQuery", "type": "object", "properties": { "allowedTransformations": { "description": "Specifies the transformations that can be applied using the query string parameter.", "type": "array", "items": { "type": "string", "enum": [ "Append", "AspectCrop", "BackgroundColor", "Blur", "Composite", "Contrast", "Crop", "ChromaKey", "FaceCrop", "FeatureCrop", "FitAndFill", "Goop", "Grayscale", "HSL", "HSV", "MaxColors", "Mirror", "MonoHue", "Opacity", "RegionOfInterestCrop", "RelativeCrop", "RemoveColor", "Resize", "Rotate", "Scale", "Shear", "Trim", "UnsharpMask", "IfDimension", "IfOrientation" ] } }, "query": { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } }, "transformation": { "default": "ImQuery", "description": "Identifies the type of transformation, `ImQuery` in this case.", "type": "string", "enum": [ "ImQuery" ] } }, "x-akamai": { "file-path": "schemas/t-im-query.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the dimensions of the source image. You need to select a dimension for comparison, which is either `width` and `height` or `both`.", "title": "IfDimension", "type": "object", "required": [ "transformation", "value" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "dimension": { "description": "The dimension to use to select the transformation, either `height`, `width`, or `both`. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "default": "width", "title": "String", "type": "string", "enum": [ "width", "height", "both" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "equal": { "description": "The transformation performed only if the source image's dimension is equal to the `value` listed.", "type": "object" }, "greaterThan": { "description": "The transformation performed if the source image's dimension is greater than the `value` listed.", "type": "object" }, "lessThan": { "description": "The transformation performed if the source image's dimension is less than the `value` listed.", "type": "object" }, "transformation": { "default": "IfDimension", "description": "Identifies the type of transformation, `IfDimension` in this case.", "type": "string", "enum": [ "IfDimension" ] }, "value": { "description": "The value to compare against the source image dimension. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-if-dimension.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the orientation of the source image. Defaults to the `default` transformation if no transformation is specified for the orientation.", "title": "IfOrientation", "type": "object", "required": [ "transformation" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "landscape": { "description": "The transformation performed if the source image uses landscape orientation.", "type": "object" }, "portrait": { "description": "The transformation performed if the source image uses portrait orientation.", "type": "object" }, "square": { "description": "The transformation performed if the source image uses a square orientation.", "type": "object" }, "transformation": { "default": "IfOrientation", "description": "Identifies the type of transformation, `IfOrientation` in this case.", "type": "string", "enum": [ "IfOrientation" ] } }, "x-akamai": { "file-path": "schemas/t-if-orientation.yaml" } }, { "additionalProperties": false, "description": "Set the maximum number of colors in the image palette. Reducing the number of colors in an image can help to reduce file size.", "title": "MaxColors", "type": "object", "required": [ "transformation", "colors" ], "properties": { "colors": { "description": "The value representing the maximum number of colors to use with the source image.", "oneOf": [ { "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MaxColors", "description": "Identifies the type of transformation, `MaxColors` in this case.", "type": "string", "enum": [ "MaxColors" ] } }, "x-akamai": { "file-path": "schemas/t-max-colors.yaml" } }, { "additionalProperties": false, "description": "Flips an image horizontally, vertically, or both.", "minProperties": 2, "title": "Mirror", "type": "object", "required": [ "transformation" ], "properties": { "horizontal": { "description": "Flips the image horizontally.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Mirror", "description": "Identifies the type of transformation, `Mirror` in this case.", "title": "IfDimension", "type": "string", "enum": [ "Mirror" ] }, "vertical": { "description": "Flips the image vertically.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-mirror.yaml" } }, { "additionalProperties": false, "description": "Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color's lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.", "title": "MonoHue", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MonoHue", "description": "Identifies the type of transformation, `MonoHue` in this case.", "type": "string", "enum": [ "MonoHue" ] } }, "x-akamai": { "file-path": "schemas/t-mono-hue.yaml" } }, { "additionalProperties": false, "description": "Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.", "title": "Opacity", "type": "object", "required": [ "transformation", "opacity" ], "properties": { "opacity": { "description": "Represents alpha values on a scale of `0` to `1`. Values below `1` increase transparency, and `0` is invisible. For images that have some transparency, values above `1` increase the opacity of the transparent portions.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Opacity", "description": "Identifies the type of transformation, `Opacity` in this case.", "type": "string", "enum": [ "Opacity" ] } }, "x-akamai": { "file-path": "schemas/t-opacity.yaml" } }, { "additionalProperties": false, "description": "Crops to a region around a specified area of interest relative to the specified `width` and `height` values.", "title": "RegionOfInterestCrop", "type": "object", "required": [ "transformation", "width", "height", "regionOfInterest" ], "properties": { "gravity": { "default": "Center", "description": "The placement of the crop area relative to the specified area of interest.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "regionOfInterest": { "x-akamai": { "file-path": "schemas/shape-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Defines a circle with a specified `radius` from its `center` point.", "title": "Circle", "type": "object", "required": [ "center", "radius" ], "properties": { "center": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, "radius": { "description": "The radius of the circle measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-circle.yaml" } }, { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, { "additionalProperties": false, "description": "Defines a polygon from a series of connected points.", "title": "Polygon", "type": "object", "required": [ "points" ], "properties": { "points": { "description": "Series of PointShapeType objects. The last and first points connect to close the shape automatically.", "type": "array", "items": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } } } }, "x-akamai": { "file-path": "schemas/shape-type-polygon.yaml" } }, { "additionalProperties": false, "description": "Defines a rectangle's `width` and `height` relative to an `anchor` point at the top left corner.", "title": "Rectangle", "type": "object", "required": [ "anchor", "width", "height" ], "properties": { "anchor": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, "height": { "description": "Extends the rectangle down from the `anchor` point.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "width": { "description": "Extends the rectangle right from the `anchor` point.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-rectangle.yaml" } }, { "additionalProperties": false, "description": "Identifies a combined shape based on a set of other shapes.", "title": "Union", "type": "object", "required": [ "shapes" ], "properties": { "shapes": { "description": "A nested shape used to describe a more complex shape.", "type": "array", "items": { "description": "A nested shape used to describe a more complex shape.", "title": "Nested shape", "type": "object", "x-akamai": { "file-path": "schemas/shape-type-nested.yaml" } } } }, "x-akamai": { "file-path": "schemas/shape-type-union.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the specified area of interest in the source image, `zoom` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` places raw crop around the point of interest, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and point of interest as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the point of interest, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "fill", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RegionOfInterestCrop", "description": "Identifies the type of transformation, `RegionOfInterestCrop` in this case.", "type": "string", "enum": [ "RegionOfInterestCrop" ] }, "width": { "description": "The width in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-region-of-interest-crop.yaml" } }, { "additionalProperties": false, "description": "Shrinks or expands an image relative to the image's specified dimensions. Image & Video Manager fills the expanded areas with transparency. Positive values shrink the side, while negative values expand it.", "title": "RelativeCrop", "type": "object", "required": [ "transformation" ], "properties": { "east": { "description": "The number of pixels to shrink or expand the right side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "north": { "description": "The number of pixels to shrink or expand the top side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "south": { "description": "The number of pixels to shrink or expand the bottom side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RelativeCrop", "description": "Identifies the type of transformation, `RelativeCrop` in this case.", "type": "string", "enum": [ "RelativeCrop" ] }, "west": { "description": "The number of pixels to shrink or expand the left side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-relative-crop.yaml" } }, { "additionalProperties": false, "description": "Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.", "title": "RemoveColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value to remove.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "feather": { "description": "The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent, creating a softer edge. The first real-time request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "tolerance": { "description": "The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.", "oneOf": [ { "default": 0.2, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RemoveColor", "description": "Identifies the type of transformation, `RemoveColor` in this case.", "type": "string", "enum": [ "RemoveColor" ] } }, "x-akamai": { "file-path": "schemas/t-remove-color.yaml" } }, { "additionalProperties": false, "description": "Resizes an image to a particular, absolute dimension. If you don't enter a `width` or a `height`, the image is resized with the `fit` aspect preservation mode, which selects a value for the missing dimension that preserves the image's aspect.", "title": "Resize", "type": "object", "required": [ "transformation" ], "properties": { "aspect": { "description": "Preserves the aspect ratio. Select `fit` to make the image fit entirely within the selected width and height. When using `fit`, the resulting image has the largest possible size for the specified dimensions. Select `fill` to size the image so it both completely fills the dimensions and has the smallest possible file size. Otherwise `ignore` changes the original aspect ratio to fit within an arbitrarily shaped rectangle.", "oneOf": [ { "default": "fit", "title": "String enum", "type": "string", "enum": [ "fit", "fill", "ignore" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height to resize the source image to. Must be set if `width` is not specified.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Resize", "description": "Identifies the type of transformation, `Resize` in this case.", "type": "string", "enum": [ "Resize" ] }, "type": { "description": "Sets constraints for the image resize. Select `normal` to resize in all cases, either increasing or decreasing the dimensions. Select `downsize` to ignore this transformation if the result would be larger than the original. Select `upsize` to ignore this transformation if the result would be smaller.", "oneOf": [ { "default": "normal", "title": "String enum", "type": "string", "enum": [ "normal", "upsize", "downsize" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "width": { "description": "The width to resize the source image to. Must be set if `height` is not specified.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-resize.yaml" } }, { "additionalProperties": false, "description": "Rotate the image around its center by indicating the degrees of rotation.", "title": "Rotate", "type": "object", "required": [ "transformation", "degrees" ], "properties": { "degrees": { "description": "The value to rotate the image by. Positive values rotate clockwise, while negative values rotate counter-clockwise.", "oneOf": [ { "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Rotate", "description": "Identifies the type of transformation, `Rotate` in this case.", "type": "string", "enum": [ "Rotate" ] } }, "x-akamai": { "file-path": "schemas/t-rotate.yaml" } }, { "additionalProperties": false, "description": "Changes the image's size to different dimensions relative to its starting size.", "title": "Scale", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "height": { "description": "Scaling factor for the input height to determine the output height of the image, where values between `0` and `1` decrease size. Image dimensions need to be non-zero positive numbers.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Scale", "description": "Identifies the type of transformation, `Scale` in this case.", "type": "string", "enum": [ "Scale" ] }, "width": { "description": "Scaling factor for the input width to determine the output width of the image, where `1` leaves the width unchanged. Values greater than `1` increase the image size. Image dimensions need to be non-zero positive numbers.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-scale.yaml" } }, { "additionalProperties": false, "description": "Slants an image into a parallelogram, as a percent of the starting dimension as represented in decimal format. You need to specify at least one axis property. Transparent pixels fill empty areas around the sheared image as needed, so it's often useful to use a `BackgroundColor` transformation for these areas.", "title": "Shear", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Shear", "description": "Identifies the type of transformation, `Shear` in this case.", "type": "string", "enum": [ "Shear" ] }, "xShear": { "description": "The amount to shear along the x-axis, measured in multiples of the image's width. Required if `yShear` is not specified.", "oneOf": [ { "default": 0, "format": "float", "maximum": 5, "minimum": -5, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yShear": { "description": "The amount to shear along the y-axis, measured in multiples of the image's height. Required if `xShear` is not specified.", "oneOf": [ { "default": 0, "format": "float", "maximum": 5, "minimum": -5, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-shear.yaml" } }, { "additionalProperties": false, "description": "Automatically crops uniform backgrounds from the edges of an image.", "title": "Trim", "type": "object", "required": [ "transformation" ], "properties": { "fuzz": { "description": "The fuzz tolerance of the trim, a value between `0` and `1` that determines the acceptable amount of background variation before trimming stops.", "oneOf": [ { "default": 0.08, "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "The amount of padding in pixels to add to the trimmed image.", "oneOf": [ { "default": 0, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Trim", "description": "Identifies the type of transformation, `Trim` in this case.", "type": "string", "enum": [ "Trim" ] } }, "x-akamai": { "file-path": "schemas/t-trim.yaml" } }, { "additionalProperties": false, "description": "Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as _sharpening_ an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image & Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.", "title": "UnsharpMask", "type": "object", "required": [ "transformation" ], "properties": { "gain": { "description": "Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "sigma": { "description": "The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels, `1.0` by default. High values emphasize large details and low values emphasize small details.", "oneOf": [ { "default": 1, "format": "float", "maximum": 10, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "threshold": { "description": "Set the minimum change required to include a detail in the filter. Higher values discard more changes.", "oneOf": [ { "default": 0.05, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "UnsharpMask", "description": "Identifies the type of transformation, `UnsharpMask` in this case.", "type": "string", "enum": [ "UnsharpMask" ] } }, "x-akamai": { "file-path": "schemas/t-unsharp-mask.yaml" } } ] } }, "video": { "default": false, "description": "Identifies this as an image policy.", "readOnly": true, "type": "boolean", "enum": [ false ] } }, "x-akamai": { "file-path": "schemas/policy-image-specific.yaml" } }, { "additionalProperties": false, "properties": { "breakpoints": { "additionalProperties": false, "description": "The breakpoint widths (in pixels) to use to create derivative images or videos.", "title": "Breakpoints", "type": "object", "properties": { "widths": { "description": "Specifies each integer breakpoint width value.", "minItems": 1, "type": "array", "items": { "maximum": 5000, "minimum": 1, "type": "integer" } } } }, "dateCreated": { "description": "Date this policy version was created in ISO 8601 extended notation format.", "readOnly": true, "type": "string" }, "hosts": { "description": "Hosts that are allowed for image or video URLs within transformations or variables.", "type": "array", "items": { "type": "string" } }, "id": { "description": "Unique identifier for a policy which can be up to 64 alphanumeric characters and can include underscores or dashes.", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "readOnly": true, "type": "string" }, "previousVersion": { "description": "The previous version number of this policy version.", "readOnly": true, "type": "integer" }, "rolloutDuration": { "default": 3600, "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. This value has no effect on the staging network.", "maximum": 604800, "minimum": 3600, "type": "integer", "writeOnly": true }, "rolloutInfo": { "additionalProperties": false, "description": "Contains information about policy rollout start and completion times.", "readOnly": true, "type": "object", "properties": { "endTime": { "description": "The estimated time that rollout for this policy will end in UNIX timestamp format.", "type": "integer" }, "rolloutDuration": { "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. Policies on the staging network deploy as quickly as possible without rollout. For staging policies this value will always be 1.", "maximum": 604800, "minimum": 3600, "type": "integer" }, "startTime": { "description": "The estimated time that rollout for this policy will begin in UNIX timestamp format.", "type": "integer" } } }, "user": { "description": "The user who created this policy version.", "readOnly": true, "type": "string" }, "variables": { "description": "Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as an Inline Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.", "type": "array", "items": { "additionalProperties": false, "title": "Variable", "type": "object", "required": [ "name", "type", "defaultValue" ], "properties": { "defaultValue": { "description": "The default value of the variable if no query parameter is provided. It needs to be one of the `enumOptions` if any are provided.", "type": "string" }, "enumOptions": { "description": "Optionally limits the set of possible values for a variable. References to an enum `id` insert a corresponding `value`.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "id", "value" ], "properties": { "id": { "description": "The unique identifier for each enum value, up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "value": { "description": "The value of the variable when the `id` is provided.", "type": "string" } } } }, "name": { "description": "The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "postfix": { "description": "A postfix added to the value provided for the variable, or to the default value.", "type": "string" }, "prefix": { "description": "A prefix added to the value provided for the variable, or to the default value.", "type": "string" }, "type": { "description": "The type of value for the variable, either `bool`, `number`, `url`, `color`, `gravity`, `placement`, `scaleDimension`, `grayscaleType`, `aspect`, `resizeType`, `dimension`, `perceptualQuality`, `string`, or `focus`.", "type": "string", "enum": [ "bool", "number", "url", "color", "gravity", "placement", "scaleDimension", "grayscaleType", "aspect", "resizeType", "dimension", "perceptualQuality", "string", "focus" ] } }, "x-akamai": { "file-path": "schemas/variable.yaml" } } }, "version": { "description": "The version number of this policy version.", "readOnly": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/policy-shared.yaml" } } ] }, { "description": "Specifies details for each policy such as video size.", "title": "Video policy", "type": "object", "x-akamai": { "file-path": "schemas/policy-video.yaml" }, "allOf": [ { "additionalProperties": false, "type": "object", "properties": { "output": { "additionalProperties": false, "description": "Dictates the output quality for each resized video.", "title": "Output", "type": "object", "properties": { "perceptualQuality": { "description": "The quality of derivative videos. High preserves video quality with reduced byte savings while low reduces video quality to increase byte savings.", "oneOf": [ { "default": "medium", "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "placeholderVideoUrl": { "description": "Allows you to add a specific placeholder video that appears when a user first requests a video, but before Image & Video Manager processes the video. If not specified the original video plays during the processing time.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "videoAdaptiveQuality": { "description": "Overrides the quality of video to serve when Image & Video Manager detects a slow connection with a round-trip time (RTT) of 300 ms. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of videos for users with faster connections.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } } }, "video": { "default": true, "description": "Identifies this as a video policy.", "readOnly": true, "type": "boolean", "enum": [ true ] } }, "x-akamai": { "file-path": "schemas/policy-video-specific.yaml" } }, { "additionalProperties": false, "properties": { "breakpoints": { "additionalProperties": false, "description": "The breakpoint widths (in pixels) to use to create derivative images or videos.", "title": "Breakpoints", "type": "object", "properties": { "widths": { "description": "Specifies each integer breakpoint width value.", "minItems": 1, "type": "array", "items": { "maximum": 5000, "minimum": 1, "type": "integer" } } } }, "dateCreated": { "description": "Date this policy version was created in ISO 8601 extended notation format.", "readOnly": true, "type": "string" }, "hosts": { "description": "Hosts that are allowed for image or video URLs within transformations or variables.", "type": "array", "items": { "type": "string" } }, "id": { "description": "Unique identifier for a policy which can be up to 64 alphanumeric characters and can include underscores or dashes.", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "readOnly": true, "type": "string" }, "previousVersion": { "description": "The previous version number of this policy version.", "readOnly": true, "type": "integer" }, "rolloutDuration": { "default": 3600, "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. This value has no effect on the staging network.", "maximum": 604800, "minimum": 3600, "type": "integer", "writeOnly": true }, "rolloutInfo": { "additionalProperties": false, "description": "Contains information about policy rollout start and completion times.", "readOnly": true, "type": "object", "properties": { "endTime": { "description": "The estimated time that rollout for this policy will end in UNIX timestamp format.", "type": "integer" }, "rolloutDuration": { "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. Policies on the staging network deploy as quickly as possible without rollout. For staging policies this value will always be 1.", "maximum": 604800, "minimum": 3600, "type": "integer" }, "startTime": { "description": "The estimated time that rollout for this policy will begin in UNIX timestamp format.", "type": "integer" } } }, "user": { "description": "The user who created this policy version.", "readOnly": true, "type": "string" }, "variables": { "description": "Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as an Inline Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.", "type": "array", "items": { "additionalProperties": false, "title": "Variable", "type": "object", "required": [ "name", "type", "defaultValue" ], "properties": { "defaultValue": { "description": "The default value of the variable if no query parameter is provided. It needs to be one of the `enumOptions` if any are provided.", "type": "string" }, "enumOptions": { "description": "Optionally limits the set of possible values for a variable. References to an enum `id` insert a corresponding `value`.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "id", "value" ], "properties": { "id": { "description": "The unique identifier for each enum value, up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "value": { "description": "The value of the variable when the `id` is provided.", "type": "string" } } } }, "name": { "description": "The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "postfix": { "description": "A postfix added to the value provided for the variable, or to the default value.", "type": "string" }, "prefix": { "description": "A prefix added to the value provided for the variable, or to the default value.", "type": "string" }, "type": { "description": "The type of value for the variable, either `bool`, `number`, `url`, `color`, `gravity`, `placement`, `scaleDimension`, `grayscaleType`, `aspect`, `resizeType`, `dimension`, `perceptualQuality`, `string`, or `focus`.", "type": "string", "enum": [ "bool", "number", "url", "color", "gravity", "placement", "scaleDimension", "grayscaleType", "aspect", "resizeType", "dimension", "perceptualQuality", "string", "focus" ] } }, "x-akamai": { "file-path": "schemas/variable.yaml" } } }, "version": { "description": "The version number of this policy version.", "readOnly": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/policy-shared.yaml" } } ] } ] }, "id": { "description": "Unique identifier of the policy set.", "readOnly": true, "type": "string" }, "lastModified": { "description": "Date this policy set was last modified in ISO 8601 extended notation format.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "A friendly name for the policy set.", "type": "string" }, "properties": { "description": "The names of Property Manager properties using this policy set.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "region": { "description": "The geographic region for which the media using this policy set is optimized. Altering the value on an existing policy set voids previously cached images and videos and require their transformation again. The supported geographic regions are `US`, `EMEA`, `ASIA`, `AUSTRALIA`, `JAPAN`, or `CHINA`. `EMEA` is Europe, the Middle East, and Africa.", "title": "Region", "type": "string", "enum": [ "US", "EMEA", "ASIA", "AUSTRALIA", "JAPAN", "CHINA" ], "x-akamai": { "file-path": "schemas/policyset-region.yaml" } }, "type": { "description": "The type of media this policy set manages, either `IMAGE` or `VIDEO`.", "title": "MediaType", "type": "string", "enum": [ "IMAGE", "VIDEO" ], "x-akamai": { "file-path": "schemas/policyset-type.yaml" } }, "user": { "description": "Username of the person who most recently updated the policy set.", "readOnly": true, "type": "string" } }, "x-akamai": { "file-path": "schemas/policyset.yaml" } }, "x-akamai": { "file-path": "schemas/policyset-array.yaml" } }, "example": [ { "id": "123ab456-cde7-89ab-1234-56c789d12e4", "lastModified": "2022-01-02 08:10:02+0000", "name": "my_policy_set", "region": "US", "type": "IMAGE", "user": "Akamai", "properties": [] }, { "id": "4a56adc0-9f16-14ce-d61d-56befacf783b-v", "lastModified": "2022-01-10 14:25:43+0000", "name": "my_renamed_policy_set", "region": "US", "type": "VIDEO", "user": "Akamai", "properties": [ "example.com" ] } ] } } } }, "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for the Akamai Contract containing the policy sets. Required if you have access to more than one contract with Image & Video Manager.", "example": "{{Contract}}", "in": "header", "name": "Contract", "required": false, "schema": { "example": "A-CCT7890", "type": "string" }, "x-akamai": { "file-path": "parameters/contractId-header.yaml" } } ] }, "/policysets/{policySetId}": { "get": { "description": "View details for a specific policy set in production.", "operationId": "get-policyset", "summary": "Get a policy set", "tags": [ "Policy sets" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Image & Video Manager API", "url": "https://techdocs.akamai.com/ivm/reference/get-policyset" }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "example": { "id": "123ab456-cde7-89ab-1234-56c789d12e4", "lastModified": "2022-01-02 08:10:02+0000", "name": "my_policy_set", "region": "US", "type": "IMAGE", "user": "Akamai", "properties": [] }, "schema": { "additionalProperties": false, "description": "Specifies details of a policy set, such as the type of media its policies optimize and the region for which their delivery is best optimized.", "title": "Policy set", "type": "object", "required": [ "type", "region" ], "properties": { "defaultPolicy": { "description": "The default policy to deploy this policy set with. If unspecified the policy set will use the system default.", "writeOnly": true, "oneOf": [ { "description": "Specifies details for each policy, such as variations in image size and formats and the transformations to apply.", "title": "Image policy", "type": "object", "x-akamai": { "file-path": "schemas/policy-image.yaml" }, "allOf": [ { "additionalProperties": false, "type": "object", "properties": { "output": { "additionalProperties": false, "description": "Dictates the output quality, either `quality` or `perceptualQuality`, and the formats created for each resized image. If unspecified, you get image formats that support all browsers at the default quality level of `85`, including WEBP, JPEG2000, and JPEG-XR for specific browsers.", "title": "Output", "type": "object", "properties": { "adaptiveQuality": { "description": "Overrides the quality of the image to serve when Image & Video Manager detects a slow connection with a round-trip time (RTT) of less than 300 ms. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of images for users with standard connections.", "maximum": 100, "minimum": 1, "type": "integer" }, "allowedFormats": { "description": "The graphics file formats allowed for browser specific results, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "minItems": 1, "readOnly": true, "type": "array", "uniqueItems": true, "default": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ], "items": { "description": "The values of the allowed graphics file formats, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "type": "string", "enum": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ] } }, "forcedFormats": { "description": "The forced extra formats for the `imFormat` query parameter, which requests a specific browser type. By default, Image & Video Manager detects the browser and returns the appropriate image.", "readOnly": true, "type": "array", "uniqueItems": true, "default": [], "items": { "description": "The values of the forced extra formats, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "type": "string", "enum": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ] } }, "perceptualQuality": { "description": "Mutually exclusive with `quality`. The perceptual quality to use when comparing resulting images, which overrides the `quality` setting. Perceptual quality tunes each image format's quality dynamically based on the human-perceived quality of the output image. This can result in greater byte savings as compared to using regular `quality` because many images can be encoded at a much lower quality without compromising the perceived quality of the image. In addition, certain images may need to be encoded at a slightly higher quality in order to maintain human-perceived quality. Value tiers are `high`, `mediumHigh`, `medium`, `mediumLow`, and `low`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "perceptualQualityFloor": { "description": "Applies only when `perceptualQuality` is set. Sets a minimum image quality to respect when using perceptual quality. Perceptual quality won't reduce the quality below this value, even if it determines the compressed image to be acceptably visually similar.", "maximum": 100, "minimum": 1, "type": "integer" }, "quality": { "description": "Mutually exclusive with `perceptualQuality`, used by default if neither is specified. The chosen quality of output images from 1-100, with 1 being the lowest quality and 100 being the highest.", "oneOf": [ { "default": 85, "maximum": 100, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } } }, "postBreakpointTransformations": { "description": "Post-processing Transformations are applied to the image after image and quality settings have been applied.", "type": "array", "items": { "description": "A transformation to apply to the image/object/text.", "x-akamai": { "file-path": "schemas/transformation-post-breakpoint.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Places a transparent image on a set background color. Specify the color in CSS hexadecimal format.", "title": "BackgroundColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value for the background.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "BackgroundColor", "description": "Identifies the type of transformation, `BackgroundColor` in this case.", "type": "string", "enum": [ "BackgroundColor" ] } }, "x-akamai": { "file-path": "schemas/t-background-color.yaml" } }, { "additionalProperties": false, "description": "Applies a Gaussian blur to the image.", "title": "Blur", "type": "object", "required": [ "transformation" ], "properties": { "sigma": { "description": "The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.", "oneOf": [ { "default": 5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Blur", "description": "Identifies the type of transformation, `Blur` in this case.", "type": "string", "enum": [ "Blur" ] } }, "x-akamai": { "file-path": "schemas/t-blur.yaml" } }, { "additionalProperties": false, "description": "Changes any color in an image within the specified volume of the HSL colorspace to transparent or semi-transparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.", "title": "ChromaKey", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120\u00b0 on the color wheel.", "oneOf": [ { "default": 120, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueFeather": { "description": "How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30\u00b0 around the Hue Tolerance.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueTolerance": { "description": "How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30\u00b0 around the specified hue.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessFeather": { "description": "How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessTolerance": { "description": "How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a color must be within 75% of the full color to full white or full black for full removal.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationFeather": { "description": "How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the Saturation Tolerance.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationTolerance": { "description": "How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "ChromaKey", "description": "Identifies the type of transformation, `ChromaKey` in this case.", "type": "string", "enum": [ "ChromaKey" ] } }, "x-akamai": { "file-path": "schemas/t-chroma-key.yaml" } }, { "additionalProperties": false, "description": "An ordered combination of transformations to perform. Use to represent a sequence of transformations as a single transformation.", "title": "Compound", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Compound", "description": "Identifies the type of transformation, `Compound` in this case.", "type": "string", "enum": [ "Compound" ] }, "transformations": { "description": "A set of nested image transformations to apply to the source image.", "type": "array", "items": { "type": "object" } } }, "x-akamai": { "file-path": "schemas/t-compound.yaml" } }, { "additionalProperties": false, "description": "Adjusts both the contrast and brightness of an image.", "title": "Contrast", "type": "object", "required": [ "transformation" ], "properties": { "brightness": { "description": "Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of `1` produces a white image. A value of `-1` produces a black image. The default value is `0`, which leaves the image unchanged. The acceptable value range is `-1.0` to `1.0`. Values outside of the acceptable range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "contrast": { "description": "Adjusts the contrast of the image. Expressed as a range from `-1` to `1`, positive values increase contrast, negative values decrease it, while `0` leaves the image unchanged. Values outside of the `-1` to `1` range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Contrast", "description": "Identifies the type of transformation, `Contrast` in this case.", "type": "string", "enum": [ "Contrast" ] } }, "x-akamai": { "file-path": "schemas/t-contrast.yaml" } }, { "additionalProperties": false, "description": "Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears _goopy_. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.", "title": "Goop", "type": "object", "required": [ "transformation" ], "properties": { "chaos": { "description": "Specifies the greatest distance control points may move from their original position. A value of `1.0` shifts control points over as far as the next one in the original grid. A value of `0.0` leaves the image unchanged. Values under `0.5` work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "density": { "description": "Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium- to large-size images.", "oneOf": [ { "default": 4, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "power": { "description": "By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldn't need to vary the default value of `2.0`.", "oneOf": [ { "default": 2, "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "seed": { "description": "Specifies your own `seed` value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used, `Goop` distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Goop", "description": "Identifies the type of transformation, `Goop` in this case.", "type": "string", "enum": [ "Goop" ] } }, "x-akamai": { "file-path": "schemas/t-goop.yaml" } }, { "additionalProperties": false, "description": "Restricts image color to shades of gray only.", "title": "Grayscale", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Grayscale", "description": "Identifies the type of transformation, `Grayscale` in this case.", "type": "string", "enum": [ "Grayscale" ] }, "type": { "default": "Rec709", "description": "The algorithm used to transform colors to grays, either `Brightness`, `Lightness`, `Rec601`, or the default `Rec709`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "Rec601", "Rec709", "Brightness", "Lightness" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-grayscale.yaml" } }, { "additionalProperties": false, "description": "Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as `Grayscale` and `MaxColors`. If you're using more than one, consider the order to apply them for the desired results.", "title": "HSL", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightness": { "description": "A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green, whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than `1.0` decrease the lightness of colors in the image. Values greater than `1.0` increase the lightness of colors in the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSL", "description": "Identifies the type of transformation, `HSL` in this case.", "type": "string", "enum": [ "HSL" ] } }, "x-akamai": { "file-path": "schemas/t-hsl.yaml" } }, { "additionalProperties": false, "description": "Identical to HSL except it replaces `lightness` with `value`. For example, if you reduce the `lightness` of a light green, almost white, image, the color turns a vibrant green. Reducing the `value` turns the image a darker color, close to gray. This happens because the original image color is very close to white.", "title": "HSV", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0.0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSV", "description": "Identifies the type of transformation, `HSV` in this case.", "type": "string", "enum": [ "HSV" ] }, "value": { "description": "A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-hsv.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the dimensions of the source image. You need to select a dimension for comparison, which is either `width` and `height` or `both`.", "title": "IfDimension", "type": "object", "required": [ "transformation", "value" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "dimension": { "description": "The dimension to use to select the transformation, either `height`, `width`, or `both`. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "default": "width", "title": "String", "type": "string", "enum": [ "width", "height", "both" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "equal": { "description": "The transformation performed only if the source image's dimension is equal to the `value` listed.", "type": "object" }, "greaterThan": { "description": "The transformation performed if the source image's dimension is greater than the `value` listed.", "type": "object" }, "lessThan": { "description": "The transformation performed if the source image's dimension is less than the `value` listed.", "type": "object" }, "transformation": { "default": "IfDimension", "description": "Identifies the type of transformation, `IfDimension` in this case.", "type": "string", "enum": [ "IfDimension" ] }, "value": { "description": "The value to compare against the source image dimension. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-if-dimension.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the orientation of the source image. Defaults to the `default` transformation if no transformation is specified for the orientation.", "title": "IfOrientation", "type": "object", "required": [ "transformation" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "landscape": { "description": "The transformation performed if the source image uses landscape orientation.", "type": "object" }, "portrait": { "description": "The transformation performed if the source image uses portrait orientation.", "type": "object" }, "square": { "description": "The transformation performed if the source image uses a square orientation.", "type": "object" }, "transformation": { "default": "IfOrientation", "description": "Identifies the type of transformation, `IfOrientation` in this case.", "type": "string", "enum": [ "IfOrientation" ] } }, "x-akamai": { "file-path": "schemas/t-if-orientation.yaml" } }, { "additionalProperties": false, "description": "Set the maximum number of colors in the image palette. Reducing the number of colors in an image can help to reduce file size.", "title": "MaxColors", "type": "object", "required": [ "transformation", "colors" ], "properties": { "colors": { "description": "The value representing the maximum number of colors to use with the source image.", "oneOf": [ { "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MaxColors", "description": "Identifies the type of transformation, `MaxColors` in this case.", "type": "string", "enum": [ "MaxColors" ] } }, "x-akamai": { "file-path": "schemas/t-max-colors.yaml" } }, { "additionalProperties": false, "description": "Flips an image horizontally, vertically, or both.", "minProperties": 2, "title": "Mirror", "type": "object", "required": [ "transformation" ], "properties": { "horizontal": { "description": "Flips the image horizontally.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Mirror", "description": "Identifies the type of transformation, `Mirror` in this case.", "title": "IfDimension", "type": "string", "enum": [ "Mirror" ] }, "vertical": { "description": "Flips the image vertically.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-mirror.yaml" } }, { "additionalProperties": false, "description": "Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color's lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.", "title": "MonoHue", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MonoHue", "description": "Identifies the type of transformation, `MonoHue` in this case.", "type": "string", "enum": [ "MonoHue" ] } }, "x-akamai": { "file-path": "schemas/t-mono-hue.yaml" } }, { "additionalProperties": false, "description": "Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.", "title": "Opacity", "type": "object", "required": [ "transformation", "opacity" ], "properties": { "opacity": { "description": "Represents alpha values on a scale of `0` to `1`. Values below `1` increase transparency, and `0` is invisible. For images that have some transparency, values above `1` increase the opacity of the transparent portions.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Opacity", "description": "Identifies the type of transformation, `Opacity` in this case.", "type": "string", "enum": [ "Opacity" ] } }, "x-akamai": { "file-path": "schemas/t-opacity.yaml" } }, { "additionalProperties": false, "description": "Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.", "title": "RemoveColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value to remove.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "feather": { "description": "The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent, creating a softer edge. The first real-time request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "tolerance": { "description": "The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.", "oneOf": [ { "default": 0.2, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RemoveColor", "description": "Identifies the type of transformation, `RemoveColor` in this case.", "type": "string", "enum": [ "RemoveColor" ] } }, "x-akamai": { "file-path": "schemas/t-remove-color.yaml" } }, { "additionalProperties": false, "description": "Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as _sharpening_ an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image & Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.", "title": "UnsharpMask", "type": "object", "required": [ "transformation" ], "properties": { "gain": { "description": "Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "sigma": { "description": "The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels, `1.0` by default. High values emphasize large details and low values emphasize small details.", "oneOf": [ { "default": 1, "format": "float", "maximum": 10, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "threshold": { "description": "Set the minimum change required to include a detail in the filter. Higher values discard more changes.", "oneOf": [ { "default": 0.05, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "UnsharpMask", "description": "Identifies the type of transformation, `UnsharpMask` in this case.", "type": "string", "enum": [ "UnsharpMask" ] } }, "x-akamai": { "file-path": "schemas/t-unsharp-mask.yaml" } } ] } }, "transformations": { "description": "Set of image transformations to apply to the source image. If unspecified, no operations are performed.", "type": "array", "items": { "description": "A transformation to apply to the image/object/text.", "x-akamai": { "file-path": "schemas/transformation.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Places a specified `image` beside the source image. The API places the `image` on a major dimension, then aligns it on the minor dimension. Transparent pixels fill any area not covered by either image.", "title": "Append", "type": "object", "required": [ "transformation", "image" ], "properties": { "gravity": { "default": "Center", "description": "Specifies where to place the `image` relative to the source image. The available values represent the eight cardinal directions (`North`, `South`, `East`, `West`, `NorthEast`, `NorthWest`, `SouthEast`, `SouthWest`) and a `Center` by default.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravityPriority": { "description": "Determines the exact placement of the `image` when `gravity` is `Center` or a diagonal. The value is either `horizontal` or `vertical`. Use `horizontal` to append an `image` east or west of the source image. This aligns the `image` on the vertical gravity component, placing `Center` gravity east. Use `vertical` to append an `image` north or south of the source image. This aligns the `image` on the horizontal gravity component, placing `Center` gravity south.", "oneOf": [ { "default": "horizontal", "title": "String enum", "type": "string", "enum": [ "horizontal", "vertical" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "image": { "x-akamai": { "file-path": "schemas/image-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "A rectangular box, with a specified color and applied transformation.", "title": "Box image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the box, not the color of the edges of the box. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Box", "description": "Identifies the type of image, `Box` in this case.", "type": "string", "enum": [ "Box" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-box.yaml" } }, { "additionalProperties": false, "description": "A simple, solid, monochrome circle of a specified diameter on a transparent background.", "title": "Circle image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "diameter": { "description": "The diameter of the circle. The diameter will be the width and the height of the image in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Circle", "description": "Identifies the type of image, `Circle` in this case.", "type": "string", "enum": [ "Circle" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-circle.yaml" } }, { "additionalProperties": false, "description": "A snippet of text. Defines the font family, font size, fill color, outline stroke width, and outline color.", "title": "Text image", "type": "object", "required": [ "type", "text" ], "properties": { "fill": { "description": "The main fill color of the text.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "size": { "description": "The size in pixels to render the text.", "oneOf": [ { "default": 72, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "stroke": { "description": "The color of the outline of the text.", "oneOf": [ { "default": "#FFF", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "strokeSize": { "description": "The thickness in points of the outline of the text.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "text": { "description": "The line of text to render.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Text", "description": "Identifies the type of image, `Text` in this case.", "type": "string", "enum": [ "Text" ] }, "typeface": { "description": "The font family to apply to the text image. This may be the URL of a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.", "oneOf": [ { "default": "DejaVuSans", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-text.yaml" } }, { "additionalProperties": false, "description": "An image loaded from a URL.", "title": "URL image", "type": "object", "required": [ "url" ], "properties": { "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "URL", "description": "Identifies the type of image, `URL` in this case.", "type": "string", "enum": [ "URL" ] }, "url": { "description": "The URL of the image.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-url.yaml" } } ] }, "preserveMinorDimension": { "description": "Whether to preserve the source image's minor dimension, `false` by default. The minor dimension is the dimension opposite the dimension that the appending `image` is placed. For example, the dimensions of the source image are 100 × 100 pixels. The dimensions of the appending `image` are 50 × 150 pixels. The `gravity` is set to `East`. This makes the major dimension horizontal and the source image's minor dimension vertical. To preserve the source image's minor dimension at 100 pixels, the `preserveMinorDimension` is set to `true`. As a result of the append, the major dimension expanded with the appended image to 150 pixels. The source image's minor dimension was maintained at 100 pixels. The total combined dimension of the image is 150 × 100 pixels.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Append", "description": "Identifies the type of transformation, `Append` in this case.", "type": "string", "enum": [ "Append" ] } }, "x-akamai": { "file-path": "schemas/t-append.yaml" } }, { "additionalProperties": false, "description": "Changes the height or width of an image, either by cropping or expanding the area, to an aspect ratio of your choosing.", "title": "AspectCrop", "type": "object", "required": [ "transformation" ], "properties": { "allowExpansion": { "description": "Increases the size of the image canvas to achieve the requested aspect ratio instead of cropping the image. Use the Horizontal Offset and Vertical Offset settings to determine where to add the fully transparent pixels on the expanded image canvas.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height term of the aspect ratio to crop.", "oneOf": [ { "default": 1, "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "AspectCrop", "description": "Identifies the type of transformation, `AspectCrop` in this case.", "type": "string", "enum": [ "AspectCrop" ] }, "width": { "description": "The width term of the aspect ratio to crop.", "oneOf": [ { "default": 1, "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "xPosition": { "description": "Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.", "oneOf": [ { "default": 0.5, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "description": "Specifies the horizontal portion of the image you want to keep when cropping by aspect ratio crop. When using `allowExpansion`, this setting defines the horizontal position of the image on the new expanded image canvas.", "oneOf": [ { "default": 0.5, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-aspect-crop.yaml" } }, { "additionalProperties": false, "description": "Places a transparent image on a set background color. Specify the color in CSS hexadecimal format.", "title": "BackgroundColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value for the background.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "BackgroundColor", "description": "Identifies the type of transformation, `BackgroundColor` in this case.", "type": "string", "enum": [ "BackgroundColor" ] } }, "x-akamai": { "file-path": "schemas/t-background-color.yaml" } }, { "additionalProperties": false, "description": "Applies a Gaussian blur to the image.", "title": "Blur", "type": "object", "required": [ "transformation" ], "properties": { "sigma": { "description": "The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.", "oneOf": [ { "default": 5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Blur", "description": "Identifies the type of transformation, `Blur` in this case.", "type": "string", "enum": [ "Blur" ] } }, "x-akamai": { "file-path": "schemas/t-blur.yaml" } }, { "additionalProperties": false, "description": "Changes any color in an image within the specified volume of the HSL colorspace to transparent or semi-transparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.", "title": "ChromaKey", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120\u00b0 on the color wheel.", "oneOf": [ { "default": 120, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueFeather": { "description": "How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30\u00b0 around the Hue Tolerance.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueTolerance": { "description": "How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30\u00b0 around the specified hue.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessFeather": { "description": "How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessTolerance": { "description": "How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a color must be within 75% of the full color to full white or full black for full removal.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationFeather": { "description": "How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the Saturation Tolerance.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationTolerance": { "description": "How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "ChromaKey", "description": "Identifies the type of transformation, `ChromaKey` in this case.", "type": "string", "enum": [ "ChromaKey" ] } }, "x-akamai": { "file-path": "schemas/t-chroma-key.yaml" } }, { "additionalProperties": false, "description": "Applies another image to the source image, either as an overlay or an underlay. The image that's underneath is visible in areas that are beyond the edges of the top image or that are less than 100% opaque. A common use of an overlay composite is to add a watermark.", "title": "Composite", "type": "object", "required": [ "transformation", "image" ], "properties": { "gravity": { "default": "NorthWest", "description": "Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "image": { "x-akamai": { "file-path": "schemas/image-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "A rectangular box, with a specified color and applied transformation.", "title": "Box image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the box, not the color of the edges of the box. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Box", "description": "Identifies the type of image, `Box` in this case.", "type": "string", "enum": [ "Box" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-box.yaml" } }, { "additionalProperties": false, "description": "A simple, solid, monochrome circle of a specified diameter on a transparent background.", "title": "Circle image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "diameter": { "description": "The diameter of the circle. The diameter will be the width and the height of the image in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Circle", "description": "Identifies the type of image, `Circle` in this case.", "type": "string", "enum": [ "Circle" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-circle.yaml" } }, { "additionalProperties": false, "description": "A snippet of text. Defines the font family, font size, fill color, outline stroke width, and outline color.", "title": "Text image", "type": "object", "required": [ "type", "text" ], "properties": { "fill": { "description": "The main fill color of the text.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "size": { "description": "The size in pixels to render the text.", "oneOf": [ { "default": 72, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "stroke": { "description": "The color of the outline of the text.", "oneOf": [ { "default": "#FFF", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "strokeSize": { "description": "The thickness in points of the outline of the text.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "text": { "description": "The line of text to render.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Text", "description": "Identifies the type of image, `Text` in this case.", "type": "string", "enum": [ "Text" ] }, "typeface": { "description": "The font family to apply to the text image. This may be the URL of a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.", "oneOf": [ { "default": "DejaVuSans", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-text.yaml" } }, { "additionalProperties": false, "description": "An image loaded from a URL.", "title": "URL image", "type": "object", "required": [ "url" ], "properties": { "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "URL", "description": "Identifies the type of image, `URL` in this case.", "type": "string", "enum": [ "URL" ] }, "url": { "description": "The URL of the image.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-url.yaml" } } ] }, "placement": { "description": "Where to place the specified image, either `Over` or `Under` the existing image. Watermarks are usually applied over. Backgrounds are usually applied under.", "oneOf": [ { "default": "Over", "title": "String enum", "type": "string", "enum": [ "Over", "Under", "Mask", "Stencil" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "scale": { "description": "A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the `scaleDimension` to calculate the `scale` from the source image's width or height.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "scaleDimension": { "description": "The dimension, either `width` or `height`, of the source image to scale.", "oneOf": [ { "default": "width", "title": "String enum", "type": "string", "enum": [ "width", "height" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Composite", "description": "Identifies the type of transformation, `Composite` in this case.", "type": "string", "enum": [ "Composite" ] }, "xPosition": { "description": "The x-axis position of the image to apply.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "default": 0, "description": "The y-axis position of the image to apply.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-composite.yaml" } }, { "additionalProperties": false, "description": "An ordered combination of transformations to perform. Use to represent a sequence of transformations as a single transformation.", "title": "Compound", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Compound", "description": "Identifies the type of transformation, `Compound` in this case.", "type": "string", "enum": [ "Compound" ] }, "transformations": { "description": "A set of nested image transformations to apply to the source image.", "type": "array", "items": { "type": "object" } } }, "x-akamai": { "file-path": "schemas/t-compound.yaml" } }, { "additionalProperties": false, "description": "Adjusts both the contrast and brightness of an image.", "title": "Contrast", "type": "object", "required": [ "transformation" ], "properties": { "brightness": { "description": "Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of `1` produces a white image. A value of `-1` produces a black image. The default value is `0`, which leaves the image unchanged. The acceptable value range is `-1.0` to `1.0`. Values outside of the acceptable range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "contrast": { "description": "Adjusts the contrast of the image. Expressed as a range from `-1` to `1`, positive values increase contrast, negative values decrease it, while `0` leaves the image unchanged. Values outside of the `-1` to `1` range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Contrast", "description": "Identifies the type of transformation, `Contrast` in this case.", "type": "string", "enum": [ "Contrast" ] } }, "x-akamai": { "file-path": "schemas/t-contrast.yaml" } }, { "additionalProperties": false, "description": "Crops an image.", "title": "Crop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "allowExpansion": { "description": "If cropping an area outside of the existing canvas, expands the image canvas.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "NorthWest", "description": "Frame of reference for X and Y positions.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The number of pixels to crop along the y-axis.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Crop", "description": "Identifies the type of transformation, `Crop` in this case.", "type": "string", "enum": [ "Crop" ] }, "width": { "description": "The number of pixels to crop along the x-axis.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "xPosition": { "description": "The x-axis position of the image to crop from.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "description": "The y-axis position of the image to crop from.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-crop.yaml" } }, { "additionalProperties": false, "description": "Applies a method to detect faces in the source image and applies the rectangular crop on either the `biggest` face or `all` of the faces detected. Image & Video Manager tries to preserve faces in the image instead of using specified crop coordinates.", "title": "FaceCrop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "algorithm": { "description": "Specifies the type of algorithm used to detect faces in the image, either `cascade` for the cascade classifier algorithm or `dnn` for the deep neural network algorithm, `cascade` by default.", "oneOf": [ { "default": "cascade", "title": "String enum", "type": "string", "enum": [ "cascade", "dnn" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "confidence": { "description": "With `algorithm` set to `dnn`, specifies the minimum confidence needed to detect faces in the image. Values range from `0` to `1` for increased confidence, and possibly fewer faces detected.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "failGravity": { "default": "Center", "description": "Controls placement of the crop if Image & Video Manager does not detect any faces in the image. Directions are relative to the edges of the image being transformed.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "focus": { "description": "Distinguishes the faces detected, either `biggestFace` or `allFaces` to place the crop rectangle around the full set of faces. This is `all` by default.", "oneOf": [ { "default": "allFaces", "title": "String enum", "type": "string", "enum": [ "allFaces", "biggestFace" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "Center", "description": "Controls placement of the crop. Directions are relative to the face, plus padding.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the output image in pixels relative to the specified `style` value.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "The padding ratio based on the dimensions of the biggest face detected, `0.5` by default. Larger values increase padding.", "oneOf": [ { "default": 0.5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the faces detected in the source image, `zoom` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` places a raw crop around the faces, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and faces as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the faces, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "zoom", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FaceCrop", "description": "Identifies the type of transformation, `FaceCrop` in this case.", "type": "string", "enum": [ "FaceCrop" ] }, "width": { "description": "The width of the output image in pixels relative to the specified `style` value.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-face-crop.yaml" } }, { "additionalProperties": false, "description": "Identifies prominent features of the source image, then crops around as many of these features as possible relative to the specified `width` and `height` values.", "title": "FeatureCrop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "failGravity": { "default": "Center", "description": "Controls placement of the crop if Image & Video Manager does not detect any features in the image. Directions are relative to the edges of the image being transformed.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "featureRadius": { "description": "The size in pixels of the important features to search for. If identified, two features never appear closer together than this value, `8.0` by default.", "oneOf": [ { "default": 8, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "Center", "description": "Controls placement of the crop. Directions are relative to the region of interest plus padding.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "maxFeatures": { "description": "The maximum number of features to identify as important features, `32` by default. The strongest features are always chosen.", "oneOf": [ { "default": 32, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "minFeatureQuality": { "description": "Determines the minimum quality level of the feature identified. To consider a feature important, the feature needs to surpass this value. Image & Video Manager measures quality on a scale from `0` for the lowest quality to `1` for the highest quality, `.1` by default.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "Adds space around the region of interest. The amount of padding added is directly related to the size of the bounding box of the selected features. Specifically, the region of interest is expanded in all directions by the largest dimension of the bounding box of the selected features multiplied by this value.", "oneOf": [ { "default": 0.05, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the features identified in the source image, `fill` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` performs a raw crop around the features, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and features as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the features, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "zoom", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FeatureCrop", "description": "Identifies the type of transformation, `FeatureCrop` in this case.", "type": "string", "enum": [ "FeatureCrop" ] }, "width": { "description": "The width in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-feature-crop.yaml" } }, { "additionalProperties": false, "description": "Resizes an image to fit within a specific size box and then uses a fill of that same image to cover any transparent space at the edges. By default the fill image has a Blur transformation with a sigma value of 8 applied. Customize the transformation using the `fillTransformation` parameter.", "title": "FitAndFill", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "fillTransformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "height": { "description": "The height value of the resized image.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FitAndFill", "description": "Identifies the type of transformation, `FitAndFill` in this case.", "type": "string", "enum": [ "FitAndFill" ] }, "width": { "description": "The width value of the resized image.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-fit-and-fill.yaml" } }, { "additionalProperties": false, "description": "Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears _goopy_. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.", "title": "Goop", "type": "object", "required": [ "transformation" ], "properties": { "chaos": { "description": "Specifies the greatest distance control points may move from their original position. A value of `1.0` shifts control points over as far as the next one in the original grid. A value of `0.0` leaves the image unchanged. Values under `0.5` work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "density": { "description": "Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium- to large-size images.", "oneOf": [ { "default": 4, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "power": { "description": "By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldn't need to vary the default value of `2.0`.", "oneOf": [ { "default": 2, "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "seed": { "description": "Specifies your own `seed` value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used, `Goop` distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Goop", "description": "Identifies the type of transformation, `Goop` in this case.", "type": "string", "enum": [ "Goop" ] } }, "x-akamai": { "file-path": "schemas/t-goop.yaml" } }, { "additionalProperties": false, "description": "Restricts image color to shades of gray only.", "title": "Grayscale", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Grayscale", "description": "Identifies the type of transformation, `Grayscale` in this case.", "type": "string", "enum": [ "Grayscale" ] }, "type": { "default": "Rec709", "description": "The algorithm used to transform colors to grays, either `Brightness`, `Lightness`, `Rec601`, or the default `Rec709`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "Rec601", "Rec709", "Brightness", "Lightness" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-grayscale.yaml" } }, { "additionalProperties": false, "description": "Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as `Grayscale` and `MaxColors`. If you're using more than one, consider the order to apply them for the desired results.", "title": "HSL", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightness": { "description": "A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green, whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than `1.0` decrease the lightness of colors in the image. Values greater than `1.0` increase the lightness of colors in the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSL", "description": "Identifies the type of transformation, `HSL` in this case.", "type": "string", "enum": [ "HSL" ] } }, "x-akamai": { "file-path": "schemas/t-hsl.yaml" } }, { "additionalProperties": false, "description": "Identical to HSL except it replaces `lightness` with `value`. For example, if you reduce the `lightness` of a light green, almost white, image, the color turns a vibrant green. Reducing the `value` turns the image a darker color, close to gray. This happens because the original image color is very close to white.", "title": "HSV", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0.0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSV", "description": "Identifies the type of transformation, `HSV` in this case.", "type": "string", "enum": [ "HSV" ] }, "value": { "description": "A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-hsv.yaml" } }, { "additionalProperties": false, "description": "Apply artistic transformations to images quickly and dynamically by specifying transformations with a query string appended to the image URL.\n- transformation\n- query\n- allowedTransformations", "title": "ImQuery", "type": "object", "properties": { "allowedTransformations": { "description": "Specifies the transformations that can be applied using the query string parameter.", "type": "array", "items": { "type": "string", "enum": [ "Append", "AspectCrop", "BackgroundColor", "Blur", "Composite", "Contrast", "Crop", "ChromaKey", "FaceCrop", "FeatureCrop", "FitAndFill", "Goop", "Grayscale", "HSL", "HSV", "MaxColors", "Mirror", "MonoHue", "Opacity", "RegionOfInterestCrop", "RelativeCrop", "RemoveColor", "Resize", "Rotate", "Scale", "Shear", "Trim", "UnsharpMask", "IfDimension", "IfOrientation" ] } }, "query": { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } }, "transformation": { "default": "ImQuery", "description": "Identifies the type of transformation, `ImQuery` in this case.", "type": "string", "enum": [ "ImQuery" ] } }, "x-akamai": { "file-path": "schemas/t-im-query.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the dimensions of the source image. You need to select a dimension for comparison, which is either `width` and `height` or `both`.", "title": "IfDimension", "type": "object", "required": [ "transformation", "value" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "dimension": { "description": "The dimension to use to select the transformation, either `height`, `width`, or `both`. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "default": "width", "title": "String", "type": "string", "enum": [ "width", "height", "both" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "equal": { "description": "The transformation performed only if the source image's dimension is equal to the `value` listed.", "type": "object" }, "greaterThan": { "description": "The transformation performed if the source image's dimension is greater than the `value` listed.", "type": "object" }, "lessThan": { "description": "The transformation performed if the source image's dimension is less than the `value` listed.", "type": "object" }, "transformation": { "default": "IfDimension", "description": "Identifies the type of transformation, `IfDimension` in this case.", "type": "string", "enum": [ "IfDimension" ] }, "value": { "description": "The value to compare against the source image dimension. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-if-dimension.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the orientation of the source image. Defaults to the `default` transformation if no transformation is specified for the orientation.", "title": "IfOrientation", "type": "object", "required": [ "transformation" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "landscape": { "description": "The transformation performed if the source image uses landscape orientation.", "type": "object" }, "portrait": { "description": "The transformation performed if the source image uses portrait orientation.", "type": "object" }, "square": { "description": "The transformation performed if the source image uses a square orientation.", "type": "object" }, "transformation": { "default": "IfOrientation", "description": "Identifies the type of transformation, `IfOrientation` in this case.", "type": "string", "enum": [ "IfOrientation" ] } }, "x-akamai": { "file-path": "schemas/t-if-orientation.yaml" } }, { "additionalProperties": false, "description": "Set the maximum number of colors in the image palette. Reducing the number of colors in an image can help to reduce file size.", "title": "MaxColors", "type": "object", "required": [ "transformation", "colors" ], "properties": { "colors": { "description": "The value representing the maximum number of colors to use with the source image.", "oneOf": [ { "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MaxColors", "description": "Identifies the type of transformation, `MaxColors` in this case.", "type": "string", "enum": [ "MaxColors" ] } }, "x-akamai": { "file-path": "schemas/t-max-colors.yaml" } }, { "additionalProperties": false, "description": "Flips an image horizontally, vertically, or both.", "minProperties": 2, "title": "Mirror", "type": "object", "required": [ "transformation" ], "properties": { "horizontal": { "description": "Flips the image horizontally.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Mirror", "description": "Identifies the type of transformation, `Mirror` in this case.", "title": "IfDimension", "type": "string", "enum": [ "Mirror" ] }, "vertical": { "description": "Flips the image vertically.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-mirror.yaml" } }, { "additionalProperties": false, "description": "Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color's lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.", "title": "MonoHue", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MonoHue", "description": "Identifies the type of transformation, `MonoHue` in this case.", "type": "string", "enum": [ "MonoHue" ] } }, "x-akamai": { "file-path": "schemas/t-mono-hue.yaml" } }, { "additionalProperties": false, "description": "Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.", "title": "Opacity", "type": "object", "required": [ "transformation", "opacity" ], "properties": { "opacity": { "description": "Represents alpha values on a scale of `0` to `1`. Values below `1` increase transparency, and `0` is invisible. For images that have some transparency, values above `1` increase the opacity of the transparent portions.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Opacity", "description": "Identifies the type of transformation, `Opacity` in this case.", "type": "string", "enum": [ "Opacity" ] } }, "x-akamai": { "file-path": "schemas/t-opacity.yaml" } }, { "additionalProperties": false, "description": "Crops to a region around a specified area of interest relative to the specified `width` and `height` values.", "title": "RegionOfInterestCrop", "type": "object", "required": [ "transformation", "width", "height", "regionOfInterest" ], "properties": { "gravity": { "default": "Center", "description": "The placement of the crop area relative to the specified area of interest.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "regionOfInterest": { "x-akamai": { "file-path": "schemas/shape-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Defines a circle with a specified `radius` from its `center` point.", "title": "Circle", "type": "object", "required": [ "center", "radius" ], "properties": { "center": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, "radius": { "description": "The radius of the circle measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-circle.yaml" } }, { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, { "additionalProperties": false, "description": "Defines a polygon from a series of connected points.", "title": "Polygon", "type": "object", "required": [ "points" ], "properties": { "points": { "description": "Series of PointShapeType objects. The last and first points connect to close the shape automatically.", "type": "array", "items": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } } } }, "x-akamai": { "file-path": "schemas/shape-type-polygon.yaml" } }, { "additionalProperties": false, "description": "Defines a rectangle's `width` and `height` relative to an `anchor` point at the top left corner.", "title": "Rectangle", "type": "object", "required": [ "anchor", "width", "height" ], "properties": { "anchor": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, "height": { "description": "Extends the rectangle down from the `anchor` point.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "width": { "description": "Extends the rectangle right from the `anchor` point.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-rectangle.yaml" } }, { "additionalProperties": false, "description": "Identifies a combined shape based on a set of other shapes.", "title": "Union", "type": "object", "required": [ "shapes" ], "properties": { "shapes": { "description": "A nested shape used to describe a more complex shape.", "type": "array", "items": { "description": "A nested shape used to describe a more complex shape.", "title": "Nested shape", "type": "object", "x-akamai": { "file-path": "schemas/shape-type-nested.yaml" } } } }, "x-akamai": { "file-path": "schemas/shape-type-union.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the specified area of interest in the source image, `zoom` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` places raw crop around the point of interest, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and point of interest as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the point of interest, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "fill", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RegionOfInterestCrop", "description": "Identifies the type of transformation, `RegionOfInterestCrop` in this case.", "type": "string", "enum": [ "RegionOfInterestCrop" ] }, "width": { "description": "The width in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-region-of-interest-crop.yaml" } }, { "additionalProperties": false, "description": "Shrinks or expands an image relative to the image's specified dimensions. Image & Video Manager fills the expanded areas with transparency. Positive values shrink the side, while negative values expand it.", "title": "RelativeCrop", "type": "object", "required": [ "transformation" ], "properties": { "east": { "description": "The number of pixels to shrink or expand the right side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "north": { "description": "The number of pixels to shrink or expand the top side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "south": { "description": "The number of pixels to shrink or expand the bottom side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RelativeCrop", "description": "Identifies the type of transformation, `RelativeCrop` in this case.", "type": "string", "enum": [ "RelativeCrop" ] }, "west": { "description": "The number of pixels to shrink or expand the left side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-relative-crop.yaml" } }, { "additionalProperties": false, "description": "Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.", "title": "RemoveColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value to remove.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "feather": { "description": "The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent, creating a softer edge. The first real-time request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "tolerance": { "description": "The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.", "oneOf": [ { "default": 0.2, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RemoveColor", "description": "Identifies the type of transformation, `RemoveColor` in this case.", "type": "string", "enum": [ "RemoveColor" ] } }, "x-akamai": { "file-path": "schemas/t-remove-color.yaml" } }, { "additionalProperties": false, "description": "Resizes an image to a particular, absolute dimension. If you don't enter a `width` or a `height`, the image is resized with the `fit` aspect preservation mode, which selects a value for the missing dimension that preserves the image's aspect.", "title": "Resize", "type": "object", "required": [ "transformation" ], "properties": { "aspect": { "description": "Preserves the aspect ratio. Select `fit` to make the image fit entirely within the selected width and height. When using `fit`, the resulting image has the largest possible size for the specified dimensions. Select `fill` to size the image so it both completely fills the dimensions and has the smallest possible file size. Otherwise `ignore` changes the original aspect ratio to fit within an arbitrarily shaped rectangle.", "oneOf": [ { "default": "fit", "title": "String enum", "type": "string", "enum": [ "fit", "fill", "ignore" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height to resize the source image to. Must be set if `width` is not specified.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Resize", "description": "Identifies the type of transformation, `Resize` in this case.", "type": "string", "enum": [ "Resize" ] }, "type": { "description": "Sets constraints for the image resize. Select `normal` to resize in all cases, either increasing or decreasing the dimensions. Select `downsize` to ignore this transformation if the result would be larger than the original. Select `upsize` to ignore this transformation if the result would be smaller.", "oneOf": [ { "default": "normal", "title": "String enum", "type": "string", "enum": [ "normal", "upsize", "downsize" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "width": { "description": "The width to resize the source image to. Must be set if `height` is not specified.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-resize.yaml" } }, { "additionalProperties": false, "description": "Rotate the image around its center by indicating the degrees of rotation.", "title": "Rotate", "type": "object", "required": [ "transformation", "degrees" ], "properties": { "degrees": { "description": "The value to rotate the image by. Positive values rotate clockwise, while negative values rotate counter-clockwise.", "oneOf": [ { "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Rotate", "description": "Identifies the type of transformation, `Rotate` in this case.", "type": "string", "enum": [ "Rotate" ] } }, "x-akamai": { "file-path": "schemas/t-rotate.yaml" } }, { "additionalProperties": false, "description": "Changes the image's size to different dimensions relative to its starting size.", "title": "Scale", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "height": { "description": "Scaling factor for the input height to determine the output height of the image, where values between `0` and `1` decrease size. Image dimensions need to be non-zero positive numbers.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Scale", "description": "Identifies the type of transformation, `Scale` in this case.", "type": "string", "enum": [ "Scale" ] }, "width": { "description": "Scaling factor for the input width to determine the output width of the image, where `1` leaves the width unchanged. Values greater than `1` increase the image size. Image dimensions need to be non-zero positive numbers.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-scale.yaml" } }, { "additionalProperties": false, "description": "Slants an image into a parallelogram, as a percent of the starting dimension as represented in decimal format. You need to specify at least one axis property. Transparent pixels fill empty areas around the sheared image as needed, so it's often useful to use a `BackgroundColor` transformation for these areas.", "title": "Shear", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Shear", "description": "Identifies the type of transformation, `Shear` in this case.", "type": "string", "enum": [ "Shear" ] }, "xShear": { "description": "The amount to shear along the x-axis, measured in multiples of the image's width. Required if `yShear` is not specified.", "oneOf": [ { "default": 0, "format": "float", "maximum": 5, "minimum": -5, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yShear": { "description": "The amount to shear along the y-axis, measured in multiples of the image's height. Required if `xShear` is not specified.", "oneOf": [ { "default": 0, "format": "float", "maximum": 5, "minimum": -5, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-shear.yaml" } }, { "additionalProperties": false, "description": "Automatically crops uniform backgrounds from the edges of an image.", "title": "Trim", "type": "object", "required": [ "transformation" ], "properties": { "fuzz": { "description": "The fuzz tolerance of the trim, a value between `0` and `1` that determines the acceptable amount of background variation before trimming stops.", "oneOf": [ { "default": 0.08, "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "The amount of padding in pixels to add to the trimmed image.", "oneOf": [ { "default": 0, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Trim", "description": "Identifies the type of transformation, `Trim` in this case.", "type": "string", "enum": [ "Trim" ] } }, "x-akamai": { "file-path": "schemas/t-trim.yaml" } }, { "additionalProperties": false, "description": "Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as _sharpening_ an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image & Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.", "title": "UnsharpMask", "type": "object", "required": [ "transformation" ], "properties": { "gain": { "description": "Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "sigma": { "description": "The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels, `1.0` by default. High values emphasize large details and low values emphasize small details.", "oneOf": [ { "default": 1, "format": "float", "maximum": 10, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "threshold": { "description": "Set the minimum change required to include a detail in the filter. Higher values discard more changes.", "oneOf": [ { "default": 0.05, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "UnsharpMask", "description": "Identifies the type of transformation, `UnsharpMask` in this case.", "type": "string", "enum": [ "UnsharpMask" ] } }, "x-akamai": { "file-path": "schemas/t-unsharp-mask.yaml" } } ] } }, "video": { "default": false, "description": "Identifies this as an image policy.", "readOnly": true, "type": "boolean", "enum": [ false ] } }, "x-akamai": { "file-path": "schemas/policy-image-specific.yaml" } }, { "additionalProperties": false, "properties": { "breakpoints": { "additionalProperties": false, "description": "The breakpoint widths (in pixels) to use to create derivative images or videos.", "title": "Breakpoints", "type": "object", "properties": { "widths": { "description": "Specifies each integer breakpoint width value.", "minItems": 1, "type": "array", "items": { "maximum": 5000, "minimum": 1, "type": "integer" } } } }, "dateCreated": { "description": "Date this policy version was created in ISO 8601 extended notation format.", "readOnly": true, "type": "string" }, "hosts": { "description": "Hosts that are allowed for image or video URLs within transformations or variables.", "type": "array", "items": { "type": "string" } }, "id": { "description": "Unique identifier for a policy which can be up to 64 alphanumeric characters and can include underscores or dashes.", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "readOnly": true, "type": "string" }, "previousVersion": { "description": "The previous version number of this policy version.", "readOnly": true, "type": "integer" }, "rolloutDuration": { "default": 3600, "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. This value has no effect on the staging network.", "maximum": 604800, "minimum": 3600, "type": "integer", "writeOnly": true }, "rolloutInfo": { "additionalProperties": false, "description": "Contains information about policy rollout start and completion times.", "readOnly": true, "type": "object", "properties": { "endTime": { "description": "The estimated time that rollout for this policy will end in UNIX timestamp format.", "type": "integer" }, "rolloutDuration": { "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. Policies on the staging network deploy as quickly as possible without rollout. For staging policies this value will always be 1.", "maximum": 604800, "minimum": 3600, "type": "integer" }, "startTime": { "description": "The estimated time that rollout for this policy will begin in UNIX timestamp format.", "type": "integer" } } }, "user": { "description": "The user who created this policy version.", "readOnly": true, "type": "string" }, "variables": { "description": "Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as an Inline Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.", "type": "array", "items": { "additionalProperties": false, "title": "Variable", "type": "object", "required": [ "name", "type", "defaultValue" ], "properties": { "defaultValue": { "description": "The default value of the variable if no query parameter is provided. It needs to be one of the `enumOptions` if any are provided.", "type": "string" }, "enumOptions": { "description": "Optionally limits the set of possible values for a variable. References to an enum `id` insert a corresponding `value`.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "id", "value" ], "properties": { "id": { "description": "The unique identifier for each enum value, up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "value": { "description": "The value of the variable when the `id` is provided.", "type": "string" } } } }, "name": { "description": "The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "postfix": { "description": "A postfix added to the value provided for the variable, or to the default value.", "type": "string" }, "prefix": { "description": "A prefix added to the value provided for the variable, or to the default value.", "type": "string" }, "type": { "description": "The type of value for the variable, either `bool`, `number`, `url`, `color`, `gravity`, `placement`, `scaleDimension`, `grayscaleType`, `aspect`, `resizeType`, `dimension`, `perceptualQuality`, `string`, or `focus`.", "type": "string", "enum": [ "bool", "number", "url", "color", "gravity", "placement", "scaleDimension", "grayscaleType", "aspect", "resizeType", "dimension", "perceptualQuality", "string", "focus" ] } }, "x-akamai": { "file-path": "schemas/variable.yaml" } } }, "version": { "description": "The version number of this policy version.", "readOnly": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/policy-shared.yaml" } } ] }, { "description": "Specifies details for each policy such as video size.", "title": "Video policy", "type": "object", "x-akamai": { "file-path": "schemas/policy-video.yaml" }, "allOf": [ { "additionalProperties": false, "type": "object", "properties": { "output": { "additionalProperties": false, "description": "Dictates the output quality for each resized video.", "title": "Output", "type": "object", "properties": { "perceptualQuality": { "description": "The quality of derivative videos. High preserves video quality with reduced byte savings while low reduces video quality to increase byte savings.", "oneOf": [ { "default": "medium", "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "placeholderVideoUrl": { "description": "Allows you to add a specific placeholder video that appears when a user first requests a video, but before Image & Video Manager processes the video. If not specified the original video plays during the processing time.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "videoAdaptiveQuality": { "description": "Overrides the quality of video to serve when Image & Video Manager detects a slow connection with a round-trip time (RTT) of 300 ms. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of videos for users with faster connections.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } } }, "video": { "default": true, "description": "Identifies this as a video policy.", "readOnly": true, "type": "boolean", "enum": [ true ] } }, "x-akamai": { "file-path": "schemas/policy-video-specific.yaml" } }, { "additionalProperties": false, "properties": { "breakpoints": { "additionalProperties": false, "description": "The breakpoint widths (in pixels) to use to create derivative images or videos.", "title": "Breakpoints", "type": "object", "properties": { "widths": { "description": "Specifies each integer breakpoint width value.", "minItems": 1, "type": "array", "items": { "maximum": 5000, "minimum": 1, "type": "integer" } } } }, "dateCreated": { "description": "Date this policy version was created in ISO 8601 extended notation format.", "readOnly": true, "type": "string" }, "hosts": { "description": "Hosts that are allowed for image or video URLs within transformations or variables.", "type": "array", "items": { "type": "string" } }, "id": { "description": "Unique identifier for a policy which can be up to 64 alphanumeric characters and can include underscores or dashes.", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "readOnly": true, "type": "string" }, "previousVersion": { "description": "The previous version number of this policy version.", "readOnly": true, "type": "integer" }, "rolloutDuration": { "default": 3600, "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. This value has no effect on the staging network.", "maximum": 604800, "minimum": 3600, "type": "integer", "writeOnly": true }, "rolloutInfo": { "additionalProperties": false, "description": "Contains information about policy rollout start and completion times.", "readOnly": true, "type": "object", "properties": { "endTime": { "description": "The estimated time that rollout for this policy will end in UNIX timestamp format.", "type": "integer" }, "rolloutDuration": { "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. Policies on the staging network deploy as quickly as possible without rollout. For staging policies this value will always be 1.", "maximum": 604800, "minimum": 3600, "type": "integer" }, "startTime": { "description": "The estimated time that rollout for this policy will begin in UNIX timestamp format.", "type": "integer" } } }, "user": { "description": "The user who created this policy version.", "readOnly": true, "type": "string" }, "variables": { "description": "Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as an Inline Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.", "type": "array", "items": { "additionalProperties": false, "title": "Variable", "type": "object", "required": [ "name", "type", "defaultValue" ], "properties": { "defaultValue": { "description": "The default value of the variable if no query parameter is provided. It needs to be one of the `enumOptions` if any are provided.", "type": "string" }, "enumOptions": { "description": "Optionally limits the set of possible values for a variable. References to an enum `id` insert a corresponding `value`.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "id", "value" ], "properties": { "id": { "description": "The unique identifier for each enum value, up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "value": { "description": "The value of the variable when the `id` is provided.", "type": "string" } } } }, "name": { "description": "The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "postfix": { "description": "A postfix added to the value provided for the variable, or to the default value.", "type": "string" }, "prefix": { "description": "A prefix added to the value provided for the variable, or to the default value.", "type": "string" }, "type": { "description": "The type of value for the variable, either `bool`, `number`, `url`, `color`, `gravity`, `placement`, `scaleDimension`, `grayscaleType`, `aspect`, `resizeType`, `dimension`, `perceptualQuality`, `string`, or `focus`.", "type": "string", "enum": [ "bool", "number", "url", "color", "gravity", "placement", "scaleDimension", "grayscaleType", "aspect", "resizeType", "dimension", "perceptualQuality", "string", "focus" ] } }, "x-akamai": { "file-path": "schemas/variable.yaml" } } }, "version": { "description": "The version number of this policy version.", "readOnly": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/policy-shared.yaml" } } ] } ] }, "id": { "description": "Unique identifier of the policy set.", "readOnly": true, "type": "string" }, "lastModified": { "description": "Date this policy set was last modified in ISO 8601 extended notation format.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "A friendly name for the policy set.", "type": "string" }, "properties": { "description": "The names of Property Manager properties using this policy set.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "region": { "description": "The geographic region for which the media using this policy set is optimized. Altering the value on an existing policy set voids previously cached images and videos and require their transformation again. The supported geographic regions are `US`, `EMEA`, `ASIA`, `AUSTRALIA`, `JAPAN`, or `CHINA`. `EMEA` is Europe, the Middle East, and Africa.", "title": "Region", "type": "string", "enum": [ "US", "EMEA", "ASIA", "AUSTRALIA", "JAPAN", "CHINA" ], "x-akamai": { "file-path": "schemas/policyset-region.yaml" } }, "type": { "description": "The type of media this policy set manages, either `IMAGE` or `VIDEO`.", "title": "MediaType", "type": "string", "enum": [ "IMAGE", "VIDEO" ], "x-akamai": { "file-path": "schemas/policyset-type.yaml" } }, "user": { "description": "Username of the person who most recently updated the policy set.", "readOnly": true, "type": "string" } }, "x-akamai": { "file-path": "schemas/policyset.yaml" } } } } }, "404": { "description": "Not found.", "content": { "application/problem+json": { "example": { "detail": "Policy set does not exist.", "instance": "/imaging/error-instances/7d773bc5-3290-448b-ace6-347e61af54c8", "status": 404, "title": "Not Found", "type": "/imaging/error-types/IVM_3001" }, "schema": { "additionalProperties": false, "description": "Error messaging.", "type": "object", "properties": { "detail": { "description": "A detailed description of the error.", "type": "string" }, "httpStatus": { "description": "The HTTP code for the error.", "type": "integer" }, "instance": { "description": "A reference to unique instance of the error.", "type": "string" }, "requestId": { "description": "An additional instance identifier for the error.", "type": "string" }, "title": { "description": "The summary description of the error.", "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } } } }, "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "put": { "description": "Update the `name` or `region` of an existing policy set on both networks.", "operationId": "put-policyset", "summary": "Update a policy set", "tags": [ "Policy sets" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Image & Video Manager API", "url": "https://techdocs.akamai.com/ivm/reference/put-policyset" }, "requestBody": { "required": true, "content": { "application/json": { "example": { "name": "my_renamed_policy_set" }, "schema": { "additionalProperties": false, "description": "Specifies the settings to update for an existing policy set.", "title": "Policy set update", "type": "object", "properties": { "name": { "description": "A friendly name for the policy set.", "example": "{{name}}", "type": "string" }, "region": { "description": "The geographic region for which the media using this policy set is optimized. Altering the value on an existing policy set voids previously cached images and videos and require their transformation again. The supported geographic regions are `US`, `EMEA`, `ASIA`, `AUSTRALIA`, `JAPAN`, or `CHINA`. `EMEA` is Europe, the Middle East, and Africa.", "example": "{{region}}", "title": "Region", "type": "string", "enum": [ "US", "EMEA", "ASIA", "AUSTRALIA", "JAPAN", "CHINA" ], "x-akamai": { "file-path": "schemas/policyset-region.yaml" } } }, "x-akamai": { "file-path": "schemas/policyset-update.yaml" } } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "example": { "id": "4a56adc0-9f16-14ce-d61d-56befacf783b-v", "lastModified": "2022-01-10 14:25:43+0000", "name": "my_renamed_policy_set", "region": "US", "type": "VIDEO", "user": "Akamai", "properties": [ "example.com" ] }, "schema": { "additionalProperties": false, "description": "Specifies details of a policy set, such as the type of media its policies optimize and the region for which their delivery is best optimized.", "title": "Policy set", "type": "object", "required": [ "type", "region" ], "properties": { "defaultPolicy": { "description": "The default policy to deploy this policy set with. If unspecified the policy set will use the system default.", "writeOnly": true, "oneOf": [ { "description": "Specifies details for each policy, such as variations in image size and formats and the transformations to apply.", "title": "Image policy", "type": "object", "x-akamai": { "file-path": "schemas/policy-image.yaml" }, "allOf": [ { "additionalProperties": false, "type": "object", "properties": { "output": { "additionalProperties": false, "description": "Dictates the output quality, either `quality` or `perceptualQuality`, and the formats created for each resized image. If unspecified, you get image formats that support all browsers at the default quality level of `85`, including WEBP, JPEG2000, and JPEG-XR for specific browsers.", "title": "Output", "type": "object", "properties": { "adaptiveQuality": { "description": "Overrides the quality of the image to serve when Image & Video Manager detects a slow connection with a round-trip time (RTT) of less than 300 ms. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of images for users with standard connections.", "maximum": 100, "minimum": 1, "type": "integer" }, "allowedFormats": { "description": "The graphics file formats allowed for browser specific results, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "minItems": 1, "readOnly": true, "type": "array", "uniqueItems": true, "default": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ], "items": { "description": "The values of the allowed graphics file formats, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "type": "string", "enum": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ] } }, "forcedFormats": { "description": "The forced extra formats for the `imFormat` query parameter, which requests a specific browser type. By default, Image & Video Manager detects the browser and returns the appropriate image.", "readOnly": true, "type": "array", "uniqueItems": true, "default": [], "items": { "description": "The values of the forced extra formats, including `gif`, `jpeg`, `png`, `webp`, `jpegxr`, and `jpeg2000`.", "type": "string", "enum": [ "gif", "jpeg", "png", "webp", "jpegxr", "jpeg2000" ] } }, "perceptualQuality": { "description": "Mutually exclusive with `quality`. The perceptual quality to use when comparing resulting images, which overrides the `quality` setting. Perceptual quality tunes each image format's quality dynamically based on the human-perceived quality of the output image. This can result in greater byte savings as compared to using regular `quality` because many images can be encoded at a much lower quality without compromising the perceived quality of the image. In addition, certain images may need to be encoded at a slightly higher quality in order to maintain human-perceived quality. Value tiers are `high`, `mediumHigh`, `medium`, `mediumLow`, and `low`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "perceptualQualityFloor": { "description": "Applies only when `perceptualQuality` is set. Sets a minimum image quality to respect when using perceptual quality. Perceptual quality won't reduce the quality below this value, even if it determines the compressed image to be acceptably visually similar.", "maximum": 100, "minimum": 1, "type": "integer" }, "quality": { "description": "Mutually exclusive with `perceptualQuality`, used by default if neither is specified. The chosen quality of output images from 1-100, with 1 being the lowest quality and 100 being the highest.", "oneOf": [ { "default": 85, "maximum": 100, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } } }, "postBreakpointTransformations": { "description": "Post-processing Transformations are applied to the image after image and quality settings have been applied.", "type": "array", "items": { "description": "A transformation to apply to the image/object/text.", "x-akamai": { "file-path": "schemas/transformation-post-breakpoint.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Places a transparent image on a set background color. Specify the color in CSS hexadecimal format.", "title": "BackgroundColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value for the background.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "BackgroundColor", "description": "Identifies the type of transformation, `BackgroundColor` in this case.", "type": "string", "enum": [ "BackgroundColor" ] } }, "x-akamai": { "file-path": "schemas/t-background-color.yaml" } }, { "additionalProperties": false, "description": "Applies a Gaussian blur to the image.", "title": "Blur", "type": "object", "required": [ "transformation" ], "properties": { "sigma": { "description": "The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.", "oneOf": [ { "default": 5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Blur", "description": "Identifies the type of transformation, `Blur` in this case.", "type": "string", "enum": [ "Blur" ] } }, "x-akamai": { "file-path": "schemas/t-blur.yaml" } }, { "additionalProperties": false, "description": "Changes any color in an image within the specified volume of the HSL colorspace to transparent or semi-transparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.", "title": "ChromaKey", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120\u00b0 on the color wheel.", "oneOf": [ { "default": 120, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueFeather": { "description": "How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30\u00b0 around the Hue Tolerance.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueTolerance": { "description": "How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30\u00b0 around the specified hue.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessFeather": { "description": "How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessTolerance": { "description": "How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a color must be within 75% of the full color to full white or full black for full removal.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationFeather": { "description": "How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the Saturation Tolerance.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationTolerance": { "description": "How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "ChromaKey", "description": "Identifies the type of transformation, `ChromaKey` in this case.", "type": "string", "enum": [ "ChromaKey" ] } }, "x-akamai": { "file-path": "schemas/t-chroma-key.yaml" } }, { "additionalProperties": false, "description": "An ordered combination of transformations to perform. Use to represent a sequence of transformations as a single transformation.", "title": "Compound", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Compound", "description": "Identifies the type of transformation, `Compound` in this case.", "type": "string", "enum": [ "Compound" ] }, "transformations": { "description": "A set of nested image transformations to apply to the source image.", "type": "array", "items": { "type": "object" } } }, "x-akamai": { "file-path": "schemas/t-compound.yaml" } }, { "additionalProperties": false, "description": "Adjusts both the contrast and brightness of an image.", "title": "Contrast", "type": "object", "required": [ "transformation" ], "properties": { "brightness": { "description": "Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of `1` produces a white image. A value of `-1` produces a black image. The default value is `0`, which leaves the image unchanged. The acceptable value range is `-1.0` to `1.0`. Values outside of the acceptable range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "contrast": { "description": "Adjusts the contrast of the image. Expressed as a range from `-1` to `1`, positive values increase contrast, negative values decrease it, while `0` leaves the image unchanged. Values outside of the `-1` to `1` range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Contrast", "description": "Identifies the type of transformation, `Contrast` in this case.", "type": "string", "enum": [ "Contrast" ] } }, "x-akamai": { "file-path": "schemas/t-contrast.yaml" } }, { "additionalProperties": false, "description": "Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears _goopy_. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.", "title": "Goop", "type": "object", "required": [ "transformation" ], "properties": { "chaos": { "description": "Specifies the greatest distance control points may move from their original position. A value of `1.0` shifts control points over as far as the next one in the original grid. A value of `0.0` leaves the image unchanged. Values under `0.5` work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "density": { "description": "Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium- to large-size images.", "oneOf": [ { "default": 4, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "power": { "description": "By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldn't need to vary the default value of `2.0`.", "oneOf": [ { "default": 2, "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "seed": { "description": "Specifies your own `seed` value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used, `Goop` distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Goop", "description": "Identifies the type of transformation, `Goop` in this case.", "type": "string", "enum": [ "Goop" ] } }, "x-akamai": { "file-path": "schemas/t-goop.yaml" } }, { "additionalProperties": false, "description": "Restricts image color to shades of gray only.", "title": "Grayscale", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Grayscale", "description": "Identifies the type of transformation, `Grayscale` in this case.", "type": "string", "enum": [ "Grayscale" ] }, "type": { "default": "Rec709", "description": "The algorithm used to transform colors to grays, either `Brightness`, `Lightness`, `Rec601`, or the default `Rec709`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "Rec601", "Rec709", "Brightness", "Lightness" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-grayscale.yaml" } }, { "additionalProperties": false, "description": "Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as `Grayscale` and `MaxColors`. If you're using more than one, consider the order to apply them for the desired results.", "title": "HSL", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightness": { "description": "A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green, whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than `1.0` decrease the lightness of colors in the image. Values greater than `1.0` increase the lightness of colors in the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSL", "description": "Identifies the type of transformation, `HSL` in this case.", "type": "string", "enum": [ "HSL" ] } }, "x-akamai": { "file-path": "schemas/t-hsl.yaml" } }, { "additionalProperties": false, "description": "Identical to HSL except it replaces `lightness` with `value`. For example, if you reduce the `lightness` of a light green, almost white, image, the color turns a vibrant green. Reducing the `value` turns the image a darker color, close to gray. This happens because the original image color is very close to white.", "title": "HSV", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0.0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSV", "description": "Identifies the type of transformation, `HSV` in this case.", "type": "string", "enum": [ "HSV" ] }, "value": { "description": "A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-hsv.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the dimensions of the source image. You need to select a dimension for comparison, which is either `width` and `height` or `both`.", "title": "IfDimension", "type": "object", "required": [ "transformation", "value" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "dimension": { "description": "The dimension to use to select the transformation, either `height`, `width`, or `both`. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "default": "width", "title": "String", "type": "string", "enum": [ "width", "height", "both" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "equal": { "description": "The transformation performed only if the source image's dimension is equal to the `value` listed.", "type": "object" }, "greaterThan": { "description": "The transformation performed if the source image's dimension is greater than the `value` listed.", "type": "object" }, "lessThan": { "description": "The transformation performed if the source image's dimension is less than the `value` listed.", "type": "object" }, "transformation": { "default": "IfDimension", "description": "Identifies the type of transformation, `IfDimension` in this case.", "type": "string", "enum": [ "IfDimension" ] }, "value": { "description": "The value to compare against the source image dimension. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-if-dimension.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the orientation of the source image. Defaults to the `default` transformation if no transformation is specified for the orientation.", "title": "IfOrientation", "type": "object", "required": [ "transformation" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "landscape": { "description": "The transformation performed if the source image uses landscape orientation.", "type": "object" }, "portrait": { "description": "The transformation performed if the source image uses portrait orientation.", "type": "object" }, "square": { "description": "The transformation performed if the source image uses a square orientation.", "type": "object" }, "transformation": { "default": "IfOrientation", "description": "Identifies the type of transformation, `IfOrientation` in this case.", "type": "string", "enum": [ "IfOrientation" ] } }, "x-akamai": { "file-path": "schemas/t-if-orientation.yaml" } }, { "additionalProperties": false, "description": "Set the maximum number of colors in the image palette. Reducing the number of colors in an image can help to reduce file size.", "title": "MaxColors", "type": "object", "required": [ "transformation", "colors" ], "properties": { "colors": { "description": "The value representing the maximum number of colors to use with the source image.", "oneOf": [ { "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MaxColors", "description": "Identifies the type of transformation, `MaxColors` in this case.", "type": "string", "enum": [ "MaxColors" ] } }, "x-akamai": { "file-path": "schemas/t-max-colors.yaml" } }, { "additionalProperties": false, "description": "Flips an image horizontally, vertically, or both.", "minProperties": 2, "title": "Mirror", "type": "object", "required": [ "transformation" ], "properties": { "horizontal": { "description": "Flips the image horizontally.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Mirror", "description": "Identifies the type of transformation, `Mirror` in this case.", "title": "IfDimension", "type": "string", "enum": [ "Mirror" ] }, "vertical": { "description": "Flips the image vertically.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-mirror.yaml" } }, { "additionalProperties": false, "description": "Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color's lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.", "title": "MonoHue", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MonoHue", "description": "Identifies the type of transformation, `MonoHue` in this case.", "type": "string", "enum": [ "MonoHue" ] } }, "x-akamai": { "file-path": "schemas/t-mono-hue.yaml" } }, { "additionalProperties": false, "description": "Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.", "title": "Opacity", "type": "object", "required": [ "transformation", "opacity" ], "properties": { "opacity": { "description": "Represents alpha values on a scale of `0` to `1`. Values below `1` increase transparency, and `0` is invisible. For images that have some transparency, values above `1` increase the opacity of the transparent portions.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Opacity", "description": "Identifies the type of transformation, `Opacity` in this case.", "type": "string", "enum": [ "Opacity" ] } }, "x-akamai": { "file-path": "schemas/t-opacity.yaml" } }, { "additionalProperties": false, "description": "Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.", "title": "RemoveColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value to remove.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "feather": { "description": "The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent, creating a softer edge. The first real-time request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "tolerance": { "description": "The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.", "oneOf": [ { "default": 0.2, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RemoveColor", "description": "Identifies the type of transformation, `RemoveColor` in this case.", "type": "string", "enum": [ "RemoveColor" ] } }, "x-akamai": { "file-path": "schemas/t-remove-color.yaml" } }, { "additionalProperties": false, "description": "Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as _sharpening_ an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image & Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.", "title": "UnsharpMask", "type": "object", "required": [ "transformation" ], "properties": { "gain": { "description": "Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "sigma": { "description": "The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels, `1.0` by default. High values emphasize large details and low values emphasize small details.", "oneOf": [ { "default": 1, "format": "float", "maximum": 10, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "threshold": { "description": "Set the minimum change required to include a detail in the filter. Higher values discard more changes.", "oneOf": [ { "default": 0.05, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "UnsharpMask", "description": "Identifies the type of transformation, `UnsharpMask` in this case.", "type": "string", "enum": [ "UnsharpMask" ] } }, "x-akamai": { "file-path": "schemas/t-unsharp-mask.yaml" } } ] } }, "transformations": { "description": "Set of image transformations to apply to the source image. If unspecified, no operations are performed.", "type": "array", "items": { "description": "A transformation to apply to the image/object/text.", "x-akamai": { "file-path": "schemas/transformation.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Places a specified `image` beside the source image. The API places the `image` on a major dimension, then aligns it on the minor dimension. Transparent pixels fill any area not covered by either image.", "title": "Append", "type": "object", "required": [ "transformation", "image" ], "properties": { "gravity": { "default": "Center", "description": "Specifies where to place the `image` relative to the source image. The available values represent the eight cardinal directions (`North`, `South`, `East`, `West`, `NorthEast`, `NorthWest`, `SouthEast`, `SouthWest`) and a `Center` by default.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravityPriority": { "description": "Determines the exact placement of the `image` when `gravity` is `Center` or a diagonal. The value is either `horizontal` or `vertical`. Use `horizontal` to append an `image` east or west of the source image. This aligns the `image` on the vertical gravity component, placing `Center` gravity east. Use `vertical` to append an `image` north or south of the source image. This aligns the `image` on the horizontal gravity component, placing `Center` gravity south.", "oneOf": [ { "default": "horizontal", "title": "String enum", "type": "string", "enum": [ "horizontal", "vertical" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "image": { "x-akamai": { "file-path": "schemas/image-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "A rectangular box, with a specified color and applied transformation.", "title": "Box image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the box, not the color of the edges of the box. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Box", "description": "Identifies the type of image, `Box` in this case.", "type": "string", "enum": [ "Box" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-box.yaml" } }, { "additionalProperties": false, "description": "A simple, solid, monochrome circle of a specified diameter on a transparent background.", "title": "Circle image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "diameter": { "description": "The diameter of the circle. The diameter will be the width and the height of the image in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Circle", "description": "Identifies the type of image, `Circle` in this case.", "type": "string", "enum": [ "Circle" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-circle.yaml" } }, { "additionalProperties": false, "description": "A snippet of text. Defines the font family, font size, fill color, outline stroke width, and outline color.", "title": "Text image", "type": "object", "required": [ "type", "text" ], "properties": { "fill": { "description": "The main fill color of the text.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "size": { "description": "The size in pixels to render the text.", "oneOf": [ { "default": 72, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "stroke": { "description": "The color of the outline of the text.", "oneOf": [ { "default": "#FFF", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "strokeSize": { "description": "The thickness in points of the outline of the text.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "text": { "description": "The line of text to render.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Text", "description": "Identifies the type of image, `Text` in this case.", "type": "string", "enum": [ "Text" ] }, "typeface": { "description": "The font family to apply to the text image. This may be the URL of a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.", "oneOf": [ { "default": "DejaVuSans", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-text.yaml" } }, { "additionalProperties": false, "description": "An image loaded from a URL.", "title": "URL image", "type": "object", "required": [ "url" ], "properties": { "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "URL", "description": "Identifies the type of image, `URL` in this case.", "type": "string", "enum": [ "URL" ] }, "url": { "description": "The URL of the image.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-url.yaml" } } ] }, "preserveMinorDimension": { "description": "Whether to preserve the source image's minor dimension, `false` by default. The minor dimension is the dimension opposite the dimension that the appending `image` is placed. For example, the dimensions of the source image are 100 × 100 pixels. The dimensions of the appending `image` are 50 × 150 pixels. The `gravity` is set to `East`. This makes the major dimension horizontal and the source image's minor dimension vertical. To preserve the source image's minor dimension at 100 pixels, the `preserveMinorDimension` is set to `true`. As a result of the append, the major dimension expanded with the appended image to 150 pixels. The source image's minor dimension was maintained at 100 pixels. The total combined dimension of the image is 150 × 100 pixels.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Append", "description": "Identifies the type of transformation, `Append` in this case.", "type": "string", "enum": [ "Append" ] } }, "x-akamai": { "file-path": "schemas/t-append.yaml" } }, { "additionalProperties": false, "description": "Changes the height or width of an image, either by cropping or expanding the area, to an aspect ratio of your choosing.", "title": "AspectCrop", "type": "object", "required": [ "transformation" ], "properties": { "allowExpansion": { "description": "Increases the size of the image canvas to achieve the requested aspect ratio instead of cropping the image. Use the Horizontal Offset and Vertical Offset settings to determine where to add the fully transparent pixels on the expanded image canvas.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height term of the aspect ratio to crop.", "oneOf": [ { "default": 1, "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "AspectCrop", "description": "Identifies the type of transformation, `AspectCrop` in this case.", "type": "string", "enum": [ "AspectCrop" ] }, "width": { "description": "The width term of the aspect ratio to crop.", "oneOf": [ { "default": 1, "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "xPosition": { "description": "Specifies the horizontal portion of the image you want to keep when the aspect ratio cropping is applied. When using Allow Expansion this setting defines the horizontal position of the image on the new expanded image canvas.", "oneOf": [ { "default": 0.5, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "description": "Specifies the horizontal portion of the image you want to keep when cropping by aspect ratio crop. When using `allowExpansion`, this setting defines the horizontal position of the image on the new expanded image canvas.", "oneOf": [ { "default": 0.5, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-aspect-crop.yaml" } }, { "additionalProperties": false, "description": "Places a transparent image on a set background color. Specify the color in CSS hexadecimal format.", "title": "BackgroundColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value for the background.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "BackgroundColor", "description": "Identifies the type of transformation, `BackgroundColor` in this case.", "type": "string", "enum": [ "BackgroundColor" ] } }, "x-akamai": { "file-path": "schemas/t-background-color.yaml" } }, { "additionalProperties": false, "description": "Applies a Gaussian blur to the image.", "title": "Blur", "type": "object", "required": [ "transformation" ], "properties": { "sigma": { "description": "The number of pixels to scatter the original pixel by to create the blur effect. Resulting images may be larger than the original as pixels at the edge of the image might scatter outside the image's original dimensions.", "oneOf": [ { "default": 5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Blur", "description": "Identifies the type of transformation, `Blur` in this case.", "type": "string", "enum": [ "Blur" ] } }, "x-akamai": { "file-path": "schemas/t-blur.yaml" } }, { "additionalProperties": false, "description": "Changes any color in an image within the specified volume of the HSL colorspace to transparent or semi-transparent. This transformation applies a 'green screen' technique commonly used to isolate and remove background colors.", "title": "ChromaKey", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The hue to remove. Enter the degree of rotation between 0 and 360 degrees around the color wheel. By default Chroma Key removes a green hue, 120\u00b0 on the color wheel.", "oneOf": [ { "default": 120, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueFeather": { "description": "How much additional hue to make semi-transparent beyond the Hue Tolerance. By default Hue Feather is 0.083 which applies semi-transparency to hues 30\u00b0 around the Hue Tolerance.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "hueTolerance": { "description": "How close a color's hue needs to be to the selected hue for it to be changed to fully transparent. If you enter the maximum value of 1.0 the entire image is made transparent. By default Hue Tolerance is approximately 0.083 or 8.3% of the color wheel. This value corresponds to 30\u00b0 around the specified hue.", "oneOf": [ { "default": 0.083, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessFeather": { "description": "How much additional lightness to make semi-transparent beyond the Lightness Tolerance. The default value of 0.1 corresponds to 10% away from the tolerated lightness towards full black or full white.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightnessTolerance": { "description": "How much of the lightest part and darkest part of a color to preserve. For example, you can space this value out from the middle (i.e. 0.5 lightness or full color) to help preserve the splash lighting impact in the image. You can define how close the color needs to be to the full color to remove it from your image. The default value of 0.75 means that a color must be within 75% of the full color to full white or full black for full removal.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationFeather": { "description": "How much additional saturation to make semi-transparent beyond the Saturation Tolerance. By default Saturation Feather is 0.1 which applies semi-transparency to hues 10% below the Saturation Tolerance.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturationTolerance": { "description": "How close a color's saturation needs to be to full saturation for it to be changed to fully transparent. For example, you can define how green the color needs to be to remove it from your image. The default value of 0.75 means that a color must be within 75% of full saturation in order to be made fully transparent.", "oneOf": [ { "default": 0.75, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "ChromaKey", "description": "Identifies the type of transformation, `ChromaKey` in this case.", "type": "string", "enum": [ "ChromaKey" ] } }, "x-akamai": { "file-path": "schemas/t-chroma-key.yaml" } }, { "additionalProperties": false, "description": "Applies another image to the source image, either as an overlay or an underlay. The image that's underneath is visible in areas that are beyond the edges of the top image or that are less than 100% opaque. A common use of an overlay composite is to add a watermark.", "title": "Composite", "type": "object", "required": [ "transformation", "image" ], "properties": { "gravity": { "default": "NorthWest", "description": "Compass direction indicating the corner or edge of the base image to place the applied image. Use Horizontal and Vertical Offset to adjust the applied image's gravity position.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "image": { "x-akamai": { "file-path": "schemas/image-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "A rectangular box, with a specified color and applied transformation.", "title": "Box image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the box, not the color of the edges of the box. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Box", "description": "Identifies the type of image, `Box` in this case.", "type": "string", "enum": [ "Box" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-box.yaml" } }, { "additionalProperties": false, "description": "A simple, solid, monochrome circle of a specified diameter on a transparent background.", "title": "Circle image", "type": "object", "required": [ "type" ], "properties": { "color": { "description": "The fill color of the circle. The API supports hexadecimal representation and CSS hexadecimal color values.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "diameter": { "description": "The diameter of the circle. The diameter will be the width and the height of the image in pixels.", "oneOf": [ { "default": 1, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Circle", "description": "Identifies the type of image, `Circle` in this case.", "type": "string", "enum": [ "Circle" ] }, "width": { "description": "The width of the box in pixels.", "oneOf": [ { "default": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-circle.yaml" } }, { "additionalProperties": false, "description": "A snippet of text. Defines the font family, font size, fill color, outline stroke width, and outline color.", "title": "Text image", "type": "object", "required": [ "type", "text" ], "properties": { "fill": { "description": "The main fill color of the text.", "oneOf": [ { "default": "#000", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "size": { "description": "The size in pixels to render the text.", "oneOf": [ { "default": 72, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "stroke": { "description": "The color of the outline of the text.", "oneOf": [ { "default": "#FFF", "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "strokeSize": { "description": "The thickness in points of the outline of the text.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "text": { "description": "The line of text to render.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "Text", "description": "Identifies the type of image, `Text` in this case.", "type": "string", "enum": [ "Text" ] }, "typeface": { "description": "The font family to apply to the text image. This may be the URL of a TrueType or WOFF (v1) typeface, or a string that refers to one of the standard built-in browser fonts.", "oneOf": [ { "default": "DejaVuSans", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-text.yaml" } }, { "additionalProperties": false, "description": "An image loaded from a URL.", "title": "URL image", "type": "object", "required": [ "url" ], "properties": { "transformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "type": { "default": "URL", "description": "Identifies the type of image, `URL` in this case.", "type": "string", "enum": [ "URL" ] }, "url": { "description": "The URL of the image.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/image-type-url.yaml" } } ] }, "placement": { "description": "Where to place the specified image, either `Over` or `Under` the existing image. Watermarks are usually applied over. Backgrounds are usually applied under.", "oneOf": [ { "default": "Over", "title": "String enum", "type": "string", "enum": [ "Over", "Under", "Mask", "Stencil" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "scale": { "description": "A multiplier to resize the applied image relative to the source image and preserve aspect ratio, 1 by default. Set the `scaleDimension` to calculate the `scale` from the source image's width or height.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "scaleDimension": { "description": "The dimension, either `width` or `height`, of the source image to scale.", "oneOf": [ { "default": "width", "title": "String enum", "type": "string", "enum": [ "width", "height" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Composite", "description": "Identifies the type of transformation, `Composite` in this case.", "type": "string", "enum": [ "Composite" ] }, "xPosition": { "description": "The x-axis position of the image to apply.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "default": 0, "description": "The y-axis position of the image to apply.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-composite.yaml" } }, { "additionalProperties": false, "description": "An ordered combination of transformations to perform. Use to represent a sequence of transformations as a single transformation.", "title": "Compound", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Compound", "description": "Identifies the type of transformation, `Compound` in this case.", "type": "string", "enum": [ "Compound" ] }, "transformations": { "description": "A set of nested image transformations to apply to the source image.", "type": "array", "items": { "type": "object" } } }, "x-akamai": { "file-path": "schemas/t-compound.yaml" } }, { "additionalProperties": false, "description": "Adjusts both the contrast and brightness of an image.", "title": "Contrast", "type": "object", "required": [ "transformation" ], "properties": { "brightness": { "description": "Adjusts the brightness of the image. Positive values increase brightness and negative values decrease brightness. A value of `1` produces a white image. A value of `-1` produces a black image. The default value is `0`, which leaves the image unchanged. The acceptable value range is `-1.0` to `1.0`. Values outside of the acceptable range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "contrast": { "description": "Adjusts the contrast of the image. Expressed as a range from `-1` to `1`, positive values increase contrast, negative values decrease it, while `0` leaves the image unchanged. Values outside of the `-1` to `1` range clamp to this range.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": -1, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Contrast", "description": "Identifies the type of transformation, `Contrast` in this case.", "type": "string", "enum": [ "Contrast" ] } }, "x-akamai": { "file-path": "schemas/t-contrast.yaml" } }, { "additionalProperties": false, "description": "Crops an image.", "title": "Crop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "allowExpansion": { "description": "If cropping an area outside of the existing canvas, expands the image canvas.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "NorthWest", "description": "Frame of reference for X and Y positions.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The number of pixels to crop along the y-axis.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Crop", "description": "Identifies the type of transformation, `Crop` in this case.", "type": "string", "enum": [ "Crop" ] }, "width": { "description": "The number of pixels to crop along the x-axis.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "xPosition": { "description": "The x-axis position of the image to crop from.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yPosition": { "description": "The y-axis position of the image to crop from.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-crop.yaml" } }, { "additionalProperties": false, "description": "Applies a method to detect faces in the source image and applies the rectangular crop on either the `biggest` face or `all` of the faces detected. Image & Video Manager tries to preserve faces in the image instead of using specified crop coordinates.", "title": "FaceCrop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "algorithm": { "description": "Specifies the type of algorithm used to detect faces in the image, either `cascade` for the cascade classifier algorithm or `dnn` for the deep neural network algorithm, `cascade` by default.", "oneOf": [ { "default": "cascade", "title": "String enum", "type": "string", "enum": [ "cascade", "dnn" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "confidence": { "description": "With `algorithm` set to `dnn`, specifies the minimum confidence needed to detect faces in the image. Values range from `0` to `1` for increased confidence, and possibly fewer faces detected.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "failGravity": { "default": "Center", "description": "Controls placement of the crop if Image & Video Manager does not detect any faces in the image. Directions are relative to the edges of the image being transformed.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "focus": { "description": "Distinguishes the faces detected, either `biggestFace` or `allFaces` to place the crop rectangle around the full set of faces. This is `all` by default.", "oneOf": [ { "default": "allFaces", "title": "String enum", "type": "string", "enum": [ "allFaces", "biggestFace" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "Center", "description": "Controls placement of the crop. Directions are relative to the face, plus padding.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height of the output image in pixels relative to the specified `style` value.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "The padding ratio based on the dimensions of the biggest face detected, `0.5` by default. Larger values increase padding.", "oneOf": [ { "default": 0.5, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the faces detected in the source image, `zoom` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` places a raw crop around the faces, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and faces as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the faces, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "zoom", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FaceCrop", "description": "Identifies the type of transformation, `FaceCrop` in this case.", "type": "string", "enum": [ "FaceCrop" ] }, "width": { "description": "The width of the output image in pixels relative to the specified `style` value.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-face-crop.yaml" } }, { "additionalProperties": false, "description": "Identifies prominent features of the source image, then crops around as many of these features as possible relative to the specified `width` and `height` values.", "title": "FeatureCrop", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "failGravity": { "default": "Center", "description": "Controls placement of the crop if Image & Video Manager does not detect any features in the image. Directions are relative to the edges of the image being transformed.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "featureRadius": { "description": "The size in pixels of the important features to search for. If identified, two features never appear closer together than this value, `8.0` by default.", "oneOf": [ { "default": 8, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "gravity": { "default": "Center", "description": "Controls placement of the crop. Directions are relative to the region of interest plus padding.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "maxFeatures": { "description": "The maximum number of features to identify as important features, `32` by default. The strongest features are always chosen.", "oneOf": [ { "default": 32, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "minFeatureQuality": { "description": "Determines the minimum quality level of the feature identified. To consider a feature important, the feature needs to surpass this value. Image & Video Manager measures quality on a scale from `0` for the lowest quality to `1` for the highest quality, `.1` by default.", "oneOf": [ { "default": 0.1, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "Adds space around the region of interest. The amount of padding added is directly related to the size of the bounding box of the selected features. Specifically, the region of interest is expanded in all directions by the largest dimension of the bounding box of the selected features multiplied by this value.", "oneOf": [ { "default": 0.05, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the features identified in the source image, `fill` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` performs a raw crop around the features, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and features as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the features, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "zoom", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FeatureCrop", "description": "Identifies the type of transformation, `FeatureCrop` in this case.", "type": "string", "enum": [ "FeatureCrop" ] }, "width": { "description": "The width in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-feature-crop.yaml" } }, { "additionalProperties": false, "description": "Resizes an image to fit within a specific size box and then uses a fill of that same image to cover any transparent space at the edges. By default the fill image has a Blur transformation with a sigma value of 8 applied. Customize the transformation using the `fillTransformation` parameter.", "title": "FitAndFill", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "fillTransformation": { "description": "A nested image transformation to apply to the source image.", "title": "Nested transformation", "type": "object", "x-akamai": { "file-path": "schemas/transformation-nested.yaml" } }, "height": { "description": "The height value of the resized image.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "FitAndFill", "description": "Identifies the type of transformation, `FitAndFill` in this case.", "type": "string", "enum": [ "FitAndFill" ] }, "width": { "description": "The width value of the resized image.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-fit-and-fill.yaml" } }, { "additionalProperties": false, "description": "Distorts an image by randomly repositioning a set of control points along a specified grid. The transformed image appears _goopy_. Adjust the density of the grid and the degree of randomity. You can use this transformation to create watermarks for use in security.", "title": "Goop", "type": "object", "required": [ "transformation" ], "properties": { "chaos": { "description": "Specifies the greatest distance control points may move from their original position. A value of `1.0` shifts control points over as far as the next one in the original grid. A value of `0.0` leaves the image unchanged. Values under `0.5` work better for subtle distortions, otherwise control points may pass each other and cause a twisting effect.", "oneOf": [ { "default": 0.25, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "density": { "description": "Controls the density of control points used to distort the image. The largest dimension of the input image is divided up to fit this number of control points. A grid of points is extended on the smaller dimension such that each row and column of control points is equidistant from each adjacent row or column. This parameter strongly affects transformation performance. Be careful choosing values above the default if you expect to transform medium- to large-size images.", "oneOf": [ { "default": 4, "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "power": { "description": "By default, the distortion algorithm relies on inverse squares to calculate distance but this allows you to change the exponent. You shouldn't need to vary the default value of `2.0`.", "oneOf": [ { "default": 2, "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "seed": { "description": "Specifies your own `seed` value as an alternative to the default, which is subject to variability. This allows for reproducible and deterministic distortions. If all parameters are kept equal and a constant seed is used, `Goop` distorts an input image consistently over many transformations. By default, this value is set to the current Epoch Time measured in milliseconds, which provides inconsistent transformation output.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Goop", "description": "Identifies the type of transformation, `Goop` in this case.", "type": "string", "enum": [ "Goop" ] } }, "x-akamai": { "file-path": "schemas/t-goop.yaml" } }, { "additionalProperties": false, "description": "Restricts image color to shades of gray only.", "title": "Grayscale", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Grayscale", "description": "Identifies the type of transformation, `Grayscale` in this case.", "type": "string", "enum": [ "Grayscale" ] }, "type": { "default": "Rec709", "description": "The algorithm used to transform colors to grays, either `Brightness`, `Lightness`, `Rec601`, or the default `Rec709`.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "Rec601", "Rec709", "Brightness", "Lightness" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-grayscale.yaml" } }, { "additionalProperties": false, "description": "Adjusts the hue, saturation, and lightness (HSL) of an image. Hue is the number of degrees that colors rotate around the color wheel. Saturation is a multiplier to increase or decrease color saturation. Lightness is a multiplier to increase or decrease the lightness of an image. Other transformations can also affect color, such as `Grayscale` and `MaxColors`. If you're using more than one, consider the order to apply them for the desired results.", "title": "HSL", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "lightness": { "description": "A multiplier to adjust the lightness of colors in the image. Note that lightness is distinct from brightness. For example, reducing the lightness of a light green might give you a lime green, whereas reducing the brightness of a light green might give you a darker shade of the same green. Values less than `1.0` decrease the lightness of colors in the image. Values greater than `1.0` increase the lightness of colors in the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSL", "description": "Identifies the type of transformation, `HSL` in this case.", "type": "string", "enum": [ "HSL" ] } }, "x-akamai": { "file-path": "schemas/t-hsl.yaml" } }, { "additionalProperties": false, "description": "Identical to HSL except it replaces `lightness` with `value`. For example, if you reduce the `lightness` of a light green, almost white, image, the color turns a vibrant green. Reducing the `value` turns the image a darker color, close to gray. This happens because the original image color is very close to white.", "title": "HSV", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "The number of degrees to rotate colors around the color wheel, `0.0` by default.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "saturation": { "description": "A multiplier to adjust the saturation of colors in the image. Values less than `1.0` decrease saturation and values greater than `1.0` increase the saturation. A value of `0.0` removes all color from the image.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "HSV", "description": "Identifies the type of transformation, `HSV` in this case.", "type": "string", "enum": [ "HSV" ] }, "value": { "description": "A multiplier to adjust the lightness or darkness of the images base color. Values less than 1.0 decrease the base colors in the image, making them appear darker. Values greater than 1.0 increase the base colors in the image, making them appear lighter.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-hsv.yaml" } }, { "additionalProperties": false, "description": "Apply artistic transformations to images quickly and dynamically by specifying transformations with a query string appended to the image URL.\n- transformation\n- query\n- allowedTransformations", "title": "ImQuery", "type": "object", "properties": { "allowedTransformations": { "description": "Specifies the transformations that can be applied using the query string parameter.", "type": "array", "items": { "type": "string", "enum": [ "Append", "AspectCrop", "BackgroundColor", "Blur", "Composite", "Contrast", "Crop", "ChromaKey", "FaceCrop", "FeatureCrop", "FitAndFill", "Goop", "Grayscale", "HSL", "HSV", "MaxColors", "Mirror", "MonoHue", "Opacity", "RegionOfInterestCrop", "RelativeCrop", "RemoveColor", "Resize", "Rotate", "Scale", "Shear", "Trim", "UnsharpMask", "IfDimension", "IfOrientation" ] } }, "query": { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } }, "transformation": { "default": "ImQuery", "description": "Identifies the type of transformation, `ImQuery` in this case.", "type": "string", "enum": [ "ImQuery" ] } }, "x-akamai": { "file-path": "schemas/t-im-query.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the dimensions of the source image. You need to select a dimension for comparison, which is either `width` and `height` or `both`.", "title": "IfDimension", "type": "object", "required": [ "transformation", "value" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "dimension": { "description": "The dimension to use to select the transformation, either `height`, `width`, or `both`. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "default": "width", "title": "String", "type": "string", "enum": [ "width", "height", "both" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "equal": { "description": "The transformation performed only if the source image's dimension is equal to the `value` listed.", "type": "object" }, "greaterThan": { "description": "The transformation performed if the source image's dimension is greater than the `value` listed.", "type": "object" }, "lessThan": { "description": "The transformation performed if the source image's dimension is less than the `value` listed.", "type": "object" }, "transformation": { "default": "IfDimension", "description": "Identifies the type of transformation, `IfDimension` in this case.", "type": "string", "enum": [ "IfDimension" ] }, "value": { "description": "The value to compare against the source image dimension. Allows [variable](https://techdocs.akamai.com/ivm/reference/variable) substitution.", "oneOf": [ { "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-if-dimension.yaml" } }, { "additionalProperties": false, "description": "Chooses a transformation depending on the orientation of the source image. Defaults to the `default` transformation if no transformation is specified for the orientation.", "title": "IfOrientation", "type": "object", "required": [ "transformation" ], "properties": { "default": { "description": "A no-op transformation, by default.", "type": "object" }, "landscape": { "description": "The transformation performed if the source image uses landscape orientation.", "type": "object" }, "portrait": { "description": "The transformation performed if the source image uses portrait orientation.", "type": "object" }, "square": { "description": "The transformation performed if the source image uses a square orientation.", "type": "object" }, "transformation": { "default": "IfOrientation", "description": "Identifies the type of transformation, `IfOrientation` in this case.", "type": "string", "enum": [ "IfOrientation" ] } }, "x-akamai": { "file-path": "schemas/t-if-orientation.yaml" } }, { "additionalProperties": false, "description": "Set the maximum number of colors in the image palette. Reducing the number of colors in an image can help to reduce file size.", "title": "MaxColors", "type": "object", "required": [ "transformation", "colors" ], "properties": { "colors": { "description": "The value representing the maximum number of colors to use with the source image.", "oneOf": [ { "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MaxColors", "description": "Identifies the type of transformation, `MaxColors` in this case.", "type": "string", "enum": [ "MaxColors" ] } }, "x-akamai": { "file-path": "schemas/t-max-colors.yaml" } }, { "additionalProperties": false, "description": "Flips an image horizontally, vertically, or both.", "minProperties": 2, "title": "Mirror", "type": "object", "required": [ "transformation" ], "properties": { "horizontal": { "description": "Flips the image horizontally.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Mirror", "description": "Identifies the type of transformation, `Mirror` in this case.", "title": "IfDimension", "type": "string", "enum": [ "Mirror" ] }, "vertical": { "description": "Flips the image vertically.", "oneOf": [ { "default": false, "title": "Boolean", "type": "boolean" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-mirror.yaml" } }, { "additionalProperties": false, "description": "Allows you to set all hues in an image to a single specified hue of your choosing. Mono Hue maintains the original color's lightness and saturation but sets the hue to that of the specified value. This has the effect of making the image shades of the specified hue.", "title": "MonoHue", "type": "object", "required": [ "transformation" ], "properties": { "hue": { "description": "Specify a hue by indicating the degree of rotation between 0 and 360 degrees around the color wheel. By default Mono Hue applies a red hue, 0.0 on the color wheel.", "oneOf": [ { "default": 0, "format": "float", "maximum": 360, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "MonoHue", "description": "Identifies the type of transformation, `MonoHue` in this case.", "type": "string", "enum": [ "MonoHue" ] } }, "x-akamai": { "file-path": "schemas/t-mono-hue.yaml" } }, { "additionalProperties": false, "description": "Adjusts the level of transparency of an image. Use this transformation to make an image more or less transparent.", "title": "Opacity", "type": "object", "required": [ "transformation", "opacity" ], "properties": { "opacity": { "description": "Represents alpha values on a scale of `0` to `1`. Values below `1` increase transparency, and `0` is invisible. For images that have some transparency, values above `1` increase the opacity of the transparent portions.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Opacity", "description": "Identifies the type of transformation, `Opacity` in this case.", "type": "string", "enum": [ "Opacity" ] } }, "x-akamai": { "file-path": "schemas/t-opacity.yaml" } }, { "additionalProperties": false, "description": "Crops to a region around a specified area of interest relative to the specified `width` and `height` values.", "title": "RegionOfInterestCrop", "type": "object", "required": [ "transformation", "width", "height", "regionOfInterest" ], "properties": { "gravity": { "default": "Center", "description": "The placement of the crop area relative to the specified area of interest.", "oneOf": [ { "description": "The placement or region within an image. The available values represent the eight cardinal directions, `East`, `West`, `North`, `NorthEast`, `NorthWest`, `South`, `SouthEast`, `SouthWest`, and a `Center`.", "title": "Gravity value", "type": "string", "enum": [ "North", "NorthEast", "NorthWest", "South", "SouthEast", "SouthWest", "Center", "East", "West" ], "x-akamai": { "file-path": "schemas/gravity.yaml" } }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "regionOfInterest": { "x-akamai": { "file-path": "schemas/shape-type.yaml" }, "oneOf": [ { "additionalProperties": false, "description": "Defines a circle with a specified `radius` from its `center` point.", "title": "Circle", "type": "object", "required": [ "center", "radius" ], "properties": { "center": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, "radius": { "description": "The radius of the circle measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-circle.yaml" } }, { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, { "additionalProperties": false, "description": "Defines a polygon from a series of connected points.", "title": "Polygon", "type": "object", "required": [ "points" ], "properties": { "points": { "description": "Series of PointShapeType objects. The last and first points connect to close the shape automatically.", "type": "array", "items": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } } } }, "x-akamai": { "file-path": "schemas/shape-type-polygon.yaml" } }, { "additionalProperties": false, "description": "Defines a rectangle's `width` and `height` relative to an `anchor` point at the top left corner.", "title": "Rectangle", "type": "object", "required": [ "anchor", "width", "height" ], "properties": { "anchor": { "additionalProperties": false, "description": "Defines coordinates for a single point, to help define polygons and rectangles. Each point may be an object with `x` and `y` members or a two-element array.", "title": "Point", "type": "object", "required": [ "x", "y" ], "properties": { "x": { "description": "The horizontal position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "y": { "description": "The vertical position of the point, measured in pixels.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-point.yaml" } }, "height": { "description": "Extends the rectangle down from the `anchor` point.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "width": { "description": "Extends the rectangle right from the `anchor` point.", "oneOf": [ { "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/shape-type-rectangle.yaml" } }, { "additionalProperties": false, "description": "Identifies a combined shape based on a set of other shapes.", "title": "Union", "type": "object", "required": [ "shapes" ], "properties": { "shapes": { "description": "A nested shape used to describe a more complex shape.", "type": "array", "items": { "description": "A nested shape used to describe a more complex shape.", "title": "Nested shape", "type": "object", "x-akamai": { "file-path": "schemas/shape-type-nested.yaml" } } } }, "x-akamai": { "file-path": "schemas/shape-type-union.yaml" } } ] }, "style": { "description": "Specifies how to crop or scale a crop area for the specified area of interest in the source image, `zoom` by default. The output image resizes to the specified `width` and `height` values. A value of `crop` places raw crop around the point of interest, relative to the specified `gravity` value. A value of `fill` scales the crop area to include as much of the image and point of interest as possible, relative to the specified `width` and `height` values. A value of `zoom` scales the crop area as small as possible to fit the point of interest, relative to the specified `width` and `height` values.", "oneOf": [ { "default": "fill", "title": "String enum", "type": "string", "enum": [ "crop", "fill", "zoom" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RegionOfInterestCrop", "description": "Identifies the type of transformation, `RegionOfInterestCrop` in this case.", "type": "string", "enum": [ "RegionOfInterestCrop" ] }, "width": { "description": "The width in pixels of the output image relative to the specified `style` value.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-region-of-interest-crop.yaml" } }, { "additionalProperties": false, "description": "Shrinks or expands an image relative to the image's specified dimensions. Image & Video Manager fills the expanded areas with transparency. Positive values shrink the side, while negative values expand it.", "title": "RelativeCrop", "type": "object", "required": [ "transformation" ], "properties": { "east": { "description": "The number of pixels to shrink or expand the right side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "north": { "description": "The number of pixels to shrink or expand the top side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "south": { "description": "The number of pixels to shrink or expand the bottom side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RelativeCrop", "description": "Identifies the type of transformation, `RelativeCrop` in this case.", "type": "string", "enum": [ "RelativeCrop" ] }, "west": { "description": "The number of pixels to shrink or expand the left side of the image.", "oneOf": [ { "default": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-relative-crop.yaml" } }, { "additionalProperties": false, "description": "Removes a specified color from an image and replaces it with transparent pixels. This transformation is ideal for removing solid background colors from product images photographed on clean, consistent backgrounds without any shadows.", "title": "RemoveColor", "type": "object", "required": [ "transformation", "color" ], "properties": { "color": { "description": "The hexadecimal CSS color value to remove.", "oneOf": [ { "pattern": "^#[0-9a-fA-Z]{3,8}$", "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "feather": { "description": "The RemoveColor transformation may create a hard edge around an image. To minimize these hard edges and make the removal of the color more gradual in appearance, use the Feather option. This option allows you to extend the color removal beyond the specified Tolerance. The pixels in this extended tolerance become semi-transparent, creating a softer edge. The first real-time request for an image using the feather option may result in a slow transformation time. Subsequent requests are not impacted as they are served directly out of cache.", "oneOf": [ { "default": 0, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "tolerance": { "description": "The Tolerance option defines how close the color needs to be to the selected color before it's changed to fully transparent. Set the Tolerance to 0.0 to remove only the exact color specified.", "oneOf": [ { "default": 0.2, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "RemoveColor", "description": "Identifies the type of transformation, `RemoveColor` in this case.", "type": "string", "enum": [ "RemoveColor" ] } }, "x-akamai": { "file-path": "schemas/t-remove-color.yaml" } }, { "additionalProperties": false, "description": "Resizes an image to a particular, absolute dimension. If you don't enter a `width` or a `height`, the image is resized with the `fit` aspect preservation mode, which selects a value for the missing dimension that preserves the image's aspect.", "title": "Resize", "type": "object", "required": [ "transformation" ], "properties": { "aspect": { "description": "Preserves the aspect ratio. Select `fit` to make the image fit entirely within the selected width and height. When using `fit`, the resulting image has the largest possible size for the specified dimensions. Select `fill` to size the image so it both completely fills the dimensions and has the smallest possible file size. Otherwise `ignore` changes the original aspect ratio to fit within an arbitrarily shaped rectangle.", "oneOf": [ { "default": "fit", "title": "String enum", "type": "string", "enum": [ "fit", "fill", "ignore" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "height": { "description": "The height to resize the source image to. Must be set if `width` is not specified.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Resize", "description": "Identifies the type of transformation, `Resize` in this case.", "type": "string", "enum": [ "Resize" ] }, "type": { "description": "Sets constraints for the image resize. Select `normal` to resize in all cases, either increasing or decreasing the dimensions. Select `downsize` to ignore this transformation if the result would be larger than the original. Select `upsize` to ignore this transformation if the result would be smaller.", "oneOf": [ { "default": "normal", "title": "String enum", "type": "string", "enum": [ "normal", "upsize", "downsize" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "width": { "description": "The width to resize the source image to. Must be set if `height` is not specified.", "oneOf": [ { "minimum": 1, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-resize.yaml" } }, { "additionalProperties": false, "description": "Rotate the image around its center by indicating the degrees of rotation.", "title": "Rotate", "type": "object", "required": [ "transformation", "degrees" ], "properties": { "degrees": { "description": "The value to rotate the image by. Positive values rotate clockwise, while negative values rotate counter-clockwise.", "oneOf": [ { "format": "float", "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Rotate", "description": "Identifies the type of transformation, `Rotate` in this case.", "type": "string", "enum": [ "Rotate" ] } }, "x-akamai": { "file-path": "schemas/t-rotate.yaml" } }, { "additionalProperties": false, "description": "Changes the image's size to different dimensions relative to its starting size.", "title": "Scale", "type": "object", "required": [ "transformation", "width", "height" ], "properties": { "height": { "description": "Scaling factor for the input height to determine the output height of the image, where values between `0` and `1` decrease size. Image dimensions need to be non-zero positive numbers.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Scale", "description": "Identifies the type of transformation, `Scale` in this case.", "type": "string", "enum": [ "Scale" ] }, "width": { "description": "Scaling factor for the input width to determine the output width of the image, where `1` leaves the width unchanged. Values greater than `1` increase the image size. Image dimensions need to be non-zero positive numbers.", "oneOf": [ { "exclusiveMinimum": true, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-scale.yaml" } }, { "additionalProperties": false, "description": "Slants an image into a parallelogram, as a percent of the starting dimension as represented in decimal format. You need to specify at least one axis property. Transparent pixels fill empty areas around the sheared image as needed, so it's often useful to use a `BackgroundColor` transformation for these areas.", "title": "Shear", "type": "object", "required": [ "transformation" ], "properties": { "transformation": { "default": "Shear", "description": "Identifies the type of transformation, `Shear` in this case.", "type": "string", "enum": [ "Shear" ] }, "xShear": { "description": "The amount to shear along the x-axis, measured in multiples of the image's width. Required if `yShear` is not specified.", "oneOf": [ { "default": 0, "format": "float", "maximum": 5, "minimum": -5, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "yShear": { "description": "The amount to shear along the y-axis, measured in multiples of the image's height. Required if `xShear` is not specified.", "oneOf": [ { "default": 0, "format": "float", "maximum": 5, "minimum": -5, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } }, "x-akamai": { "file-path": "schemas/t-shear.yaml" } }, { "additionalProperties": false, "description": "Automatically crops uniform backgrounds from the edges of an image.", "title": "Trim", "type": "object", "required": [ "transformation" ], "properties": { "fuzz": { "description": "The fuzz tolerance of the trim, a value between `0` and `1` that determines the acceptable amount of background variation before trimming stops.", "oneOf": [ { "default": 0.08, "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "padding": { "description": "The amount of padding in pixels to add to the trimmed image.", "oneOf": [ { "default": 0, "minimum": 0, "title": "Integer", "type": "integer" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "Trim", "description": "Identifies the type of transformation, `Trim` in this case.", "type": "string", "enum": [ "Trim" ] } }, "x-akamai": { "file-path": "schemas/t-trim.yaml" } }, { "additionalProperties": false, "description": "Emphasizes edges and details in source images without distorting the colors. Although this effect is often referred to as _sharpening_ an image, it actually creates a blurred, inverted copy of the image known as an unsharp mask. Image & Video Manager combines the unsharp mask with the source image to create an image perceived as clearer.", "title": "UnsharpMask", "type": "object", "required": [ "transformation" ], "properties": { "gain": { "description": "Set how much emphasis the filter applies to details. Higher values increase apparent sharpness of details.", "oneOf": [ { "default": 1, "format": "float", "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "sigma": { "description": "The standard deviation of the Gaussian distribution used in the in unsharp mask, measured in pixels, `1.0` by default. High values emphasize large details and low values emphasize small details.", "oneOf": [ { "default": 1, "format": "float", "maximum": 10, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "threshold": { "description": "Set the minimum change required to include a detail in the filter. Higher values discard more changes.", "oneOf": [ { "default": 0.05, "format": "float", "maximum": 1, "minimum": 0, "title": "Number", "type": "number" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "transformation": { "default": "UnsharpMask", "description": "Identifies the type of transformation, `UnsharpMask` in this case.", "type": "string", "enum": [ "UnsharpMask" ] } }, "x-akamai": { "file-path": "schemas/t-unsharp-mask.yaml" } } ] } }, "video": { "default": false, "description": "Identifies this as an image policy.", "readOnly": true, "type": "boolean", "enum": [ false ] } }, "x-akamai": { "file-path": "schemas/policy-image-specific.yaml" } }, { "additionalProperties": false, "properties": { "breakpoints": { "additionalProperties": false, "description": "The breakpoint widths (in pixels) to use to create derivative images or videos.", "title": "Breakpoints", "type": "object", "properties": { "widths": { "description": "Specifies each integer breakpoint width value.", "minItems": 1, "type": "array", "items": { "maximum": 5000, "minimum": 1, "type": "integer" } } } }, "dateCreated": { "description": "Date this policy version was created in ISO 8601 extended notation format.", "readOnly": true, "type": "string" }, "hosts": { "description": "Hosts that are allowed for image or video URLs within transformations or variables.", "type": "array", "items": { "type": "string" } }, "id": { "description": "Unique identifier for a policy which can be up to 64 alphanumeric characters and can include underscores or dashes.", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "readOnly": true, "type": "string" }, "previousVersion": { "description": "The previous version number of this policy version.", "readOnly": true, "type": "integer" }, "rolloutDuration": { "default": 3600, "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. This value has no effect on the staging network.", "maximum": 604800, "minimum": 3600, "type": "integer", "writeOnly": true }, "rolloutInfo": { "additionalProperties": false, "description": "Contains information about policy rollout start and completion times.", "readOnly": true, "type": "object", "properties": { "endTime": { "description": "The estimated time that rollout for this policy will end in UNIX timestamp format.", "type": "integer" }, "rolloutDuration": { "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. Policies on the staging network deploy as quickly as possible without rollout. For staging policies this value will always be 1.", "maximum": 604800, "minimum": 3600, "type": "integer" }, "startTime": { "description": "The estimated time that rollout for this policy will begin in UNIX timestamp format.", "type": "integer" } } }, "user": { "description": "The user who created this policy version.", "readOnly": true, "type": "string" }, "variables": { "description": "Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as an Inline Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.", "type": "array", "items": { "additionalProperties": false, "title": "Variable", "type": "object", "required": [ "name", "type", "defaultValue" ], "properties": { "defaultValue": { "description": "The default value of the variable if no query parameter is provided. It needs to be one of the `enumOptions` if any are provided.", "type": "string" }, "enumOptions": { "description": "Optionally limits the set of possible values for a variable. References to an enum `id` insert a corresponding `value`.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "id", "value" ], "properties": { "id": { "description": "The unique identifier for each enum value, up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "value": { "description": "The value of the variable when the `id` is provided.", "type": "string" } } } }, "name": { "description": "The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "postfix": { "description": "A postfix added to the value provided for the variable, or to the default value.", "type": "string" }, "prefix": { "description": "A prefix added to the value provided for the variable, or to the default value.", "type": "string" }, "type": { "description": "The type of value for the variable, either `bool`, `number`, `url`, `color`, `gravity`, `placement`, `scaleDimension`, `grayscaleType`, `aspect`, `resizeType`, `dimension`, `perceptualQuality`, `string`, or `focus`.", "type": "string", "enum": [ "bool", "number", "url", "color", "gravity", "placement", "scaleDimension", "grayscaleType", "aspect", "resizeType", "dimension", "perceptualQuality", "string", "focus" ] } }, "x-akamai": { "file-path": "schemas/variable.yaml" } } }, "version": { "description": "The version number of this policy version.", "readOnly": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/policy-shared.yaml" } } ] }, { "description": "Specifies details for each policy such as video size.", "title": "Video policy", "type": "object", "x-akamai": { "file-path": "schemas/policy-video.yaml" }, "allOf": [ { "additionalProperties": false, "type": "object", "properties": { "output": { "additionalProperties": false, "description": "Dictates the output quality for each resized video.", "title": "Output", "type": "object", "properties": { "perceptualQuality": { "description": "The quality of derivative videos. High preserves video quality with reduced byte savings while low reduces video quality to increase byte savings.", "oneOf": [ { "default": "medium", "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "placeholderVideoUrl": { "description": "Allows you to add a specific placeholder video that appears when a user first requests a video, but before Image & Video Manager processes the video. If not specified the original video plays during the processing time.", "oneOf": [ { "title": "String", "type": "string" }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] }, "videoAdaptiveQuality": { "description": "Overrides the quality of video to serve when Image & Video Manager detects a slow connection with a round-trip time (RTT) of 300 ms. Specifying lower values lets users with slow connections browse your site with reduced load times without impacting the quality of videos for users with faster connections.", "oneOf": [ { "title": "String enum", "type": "string", "enum": [ "high", "mediumHigh", "medium", "mediumLow", "low" ] }, { "additionalProperties": false, "description": "References the name of a variable defined by the policy. Use this object to substitute preset values within transformations, or to pass in values dynamically using image URL query parameters.", "title": "Inline variable", "type": "object", "required": [ "var" ], "properties": { "var": { "description": "Corresponds to the `name` of the variable declared by the policy, to insert the corresponding value.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" } }, "x-akamai": { "file-path": "schemas/variable-inline.yaml" } } ] } } }, "video": { "default": true, "description": "Identifies this as a video policy.", "readOnly": true, "type": "boolean", "enum": [ true ] } }, "x-akamai": { "file-path": "schemas/policy-video-specific.yaml" } }, { "additionalProperties": false, "properties": { "breakpoints": { "additionalProperties": false, "description": "The breakpoint widths (in pixels) to use to create derivative images or videos.", "title": "Breakpoints", "type": "object", "properties": { "widths": { "description": "Specifies each integer breakpoint width value.", "minItems": 1, "type": "array", "items": { "maximum": 5000, "minimum": 1, "type": "integer" } } } }, "dateCreated": { "description": "Date this policy version was created in ISO 8601 extended notation format.", "readOnly": true, "type": "string" }, "hosts": { "description": "Hosts that are allowed for image or video URLs within transformations or variables.", "type": "array", "items": { "type": "string" } }, "id": { "description": "Unique identifier for a policy which can be up to 64 alphanumeric characters and can include underscores or dashes.", "maxLength": 64, "minLength": 1, "pattern": "^[A-Za-z0-9_-]+$", "readOnly": true, "type": "string" }, "previousVersion": { "description": "The previous version number of this policy version.", "readOnly": true, "type": "integer" }, "rolloutDuration": { "default": 3600, "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. This value has no effect on the staging network.", "maximum": 604800, "minimum": 3600, "type": "integer", "writeOnly": true }, "rolloutInfo": { "additionalProperties": false, "description": "Contains information about policy rollout start and completion times.", "readOnly": true, "type": "object", "properties": { "endTime": { "description": "The estimated time that rollout for this policy will end in UNIX timestamp format.", "type": "integer" }, "rolloutDuration": { "description": "The amount of time in seconds that the policy takes to roll out. During the rollout an increasing proportion of images and videos will begin to use the new policy instead of the cached images and videos from the previous version. Policies on the staging network deploy as quickly as possible without rollout. For staging policies this value will always be 1.", "maximum": 604800, "minimum": 3600, "type": "integer" }, "startTime": { "description": "The estimated time that rollout for this policy will begin in UNIX timestamp format.", "type": "integer" } } }, "user": { "description": "The user who created this policy version.", "readOnly": true, "type": "string" }, "variables": { "description": "Declares variables for use within the policy. Any variable declared here can be invoked throughout transformations as an Inline Variable object, so that you don't have to specify values separately. You can also pass in these variable names and values dynamically as query parameters in the image's request URL.", "type": "array", "items": { "additionalProperties": false, "title": "Variable", "type": "object", "required": [ "name", "type", "defaultValue" ], "properties": { "defaultValue": { "description": "The default value of the variable if no query parameter is provided. It needs to be one of the `enumOptions` if any are provided.", "type": "string" }, "enumOptions": { "description": "Optionally limits the set of possible values for a variable. References to an enum `id` insert a corresponding `value`.", "minItems": 1, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "id", "value" ], "properties": { "id": { "description": "The unique identifier for each enum value, up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "value": { "description": "The value of the variable when the `id` is provided.", "type": "string" } } } }, "name": { "description": "The name of the variable, also available as the query parameter name to set the variable's value dynamically. Use up to 50 alphanumeric characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9]+$", "type": "string" }, "postfix": { "description": "A postfix added to the value provided for the variable, or to the default value.", "type": "string" }, "prefix": { "description": "A prefix added to the value provided for the variable, or to the default value.", "type": "string" }, "type": { "description": "The type of value for the variable, either `bool`, `number`, `url`, `color`, `gravity`, `placement`, `scaleDimension`, `grayscaleType`, `aspect`, `resizeType`, `dimension`, `perceptualQuality`, `string`, or `focus`.", "type": "string", "enum": [ "bool", "number", "url", "color", "gravity", "placement", "scaleDimension", "grayscaleType", "aspect", "resizeType", "dimension", "perceptualQuality", "string", "focus" ] } }, "x-akamai": { "file-path": "schemas/variable.yaml" } } }, "version": { "description": "The version number of this policy version.", "readOnly": true, "type": "integer" } }, "x-akamai": { "file-path": "schemas/policy-shared.yaml" } } ] } ] }, "id": { "description": "Unique identifier of the policy set.", "readOnly": true, "type": "string" }, "lastModified": { "description": "Date this policy set was last modified in ISO 8601 extended notation format.", "format": "date-time", "readOnly": true, "type": "string" }, "name": { "description": "A friendly name for the policy set.", "type": "string" }, "properties": { "description": "The names of Property Manager properties using this policy set.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "region": { "description": "The geographic region for which the media using this policy set is optimized. Altering the value on an existing policy set voids previously cached images and videos and require their transformation again. The supported geographic regions are `US`, `EMEA`, `ASIA`, `AUSTRALIA`, `JAPAN`, or `CHINA`. `EMEA` is Europe, the Middle East, and Africa.", "title": "Region", "type": "string", "enum": [ "US", "EMEA", "ASIA", "AUSTRALIA", "JAPAN", "CHINA" ], "x-akamai": { "file-path": "schemas/policyset-region.yaml" } }, "type": { "description": "The type of media this policy set manages, either `IMAGE` or `VIDEO`.", "title": "MediaType", "type": "string", "enum": [ "IMAGE", "VIDEO" ], "x-akamai": { "file-path": "schemas/policyset-type.yaml" } }, "user": { "description": "Username of the person who most recently updated the policy set.", "readOnly": true, "type": "string" } }, "x-akamai": { "file-path": "schemas/policyset.yaml" } } } } }, "400": { "description": "Unable to update policy set.", "content": { "application/problem+json": { "examples": { "Does Not Exist": { "value": { "detail": "Policy set does not exist.", "instance": "/imaging/error-instances/bf39e042-9d21-4ef3-88f1-eacf487d12f8", "requestId": "5fb7efe81b819c76", "status": 400, "title": "Bad Request", "type": "/imaging/error-types/IVM_9000" } }, "Missing China Addon": { "value": { "detail": "Contract A-CCT7890 cannot create policy sets for the China region.", "instance": "/imaging/error-instances/0b66238c-44f3-4e9f-917b-e3847570529d", "status": 400, "title": "Bad Request", "type": "/imaging/error-types/IVM_1003" } } }, "schema": { "additionalProperties": false, "description": "Error messaging.", "type": "object", "properties": { "detail": { "description": "A detailed description of the error.", "type": "string" }, "httpStatus": { "description": "The HTTP code for the error.", "type": "integer" }, "instance": { "description": "A reference to unique instance of the error.", "type": "string" }, "requestId": { "description": "An additional instance identifier for the error.", "type": "string" }, "title": { "description": "The summary description of the error.", "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } } } }, "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "delete": { "description": "Delete a policy set from a contract on both networks.", "operationId": "delete-policyset", "summary": "Delete a policy set", "tags": [ "Policy sets" ], "externalDocs": { "description": "See documentation for this operation in Akamai's Image & Video Manager API", "url": "https://techdocs.akamai.com/ivm/reference/delete-policyset" }, "responses": { "204": { "description": "Confirms the deletion of the policy set.", "content": { "*/*": {} } }, "404": { "description": "Could not delete policy set.", "content": { "application/problem+json": { "example": { "detail": "Policy set does not exist.", "instance": "/imaging/error-instances/7d773bc5-3290-448b-ace6-347e61af54c8", "status": 404, "title": "Not Found", "type": "/imaging/error-types/IVM_3001" }, "schema": { "additionalProperties": false, "description": "Error messaging.", "type": "object", "properties": { "detail": { "description": "A detailed description of the error.", "type": "string" }, "httpStatus": { "description": "The HTTP code for the error.", "type": "integer" }, "instance": { "description": "A reference to unique instance of the error.", "type": "string" }, "requestId": { "description": "An additional instance identifier for the error.", "type": "string" }, "title": { "description": "The summary description of the error.", "type": "string" }, "type": { "description": "The type of error.", "type": "string" } }, "x-akamai": { "file-path": "schemas/error.yaml" } } } } } }, "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "example": "{{accountSwitchKey}}", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ] }, "parameters": [ { "description": "Unique identifier for a policy set.", "example": "{{policySetId}}", "in": "path", "name": "policySetId", "required": true, "schema": { "example": "053eef00-9f85-11ec-a51d-47eefacf795d", "type": "string" }, "x-akamai": { "file-path": "parameters/policySetId-path.yaml" } }, { "description": "Unique identifier for the Akamai Contract containing the policy sets. Required if you have access to more than one contract with Image & Video Manager.", "example": "{{Contract}}", "in": "header", "name": "Contract", "required": false, "schema": { "example": "A-CCT7890", "type": "string" }, "x-akamai": { "file-path": "parameters/contractId-header.yaml" } } ] } }, "x-readme": { "samples-languages": [ "curl", "python", "node" ] }, "servers": [ { "url": "https://{hostname}/imaging/v2" } ] }