{ "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": { "Action": { "additionalProperties": false, "properties": { "blur": { "anyOf": [ { "additionalProperties": false, "properties": { "selector": { "anyOf": [ { "additionalProperties": false, "properties": { "data-cy": { "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" } }, "type": "object" }, { "type": "string" } ], "description": "The selector to use to select the DOM element. The selector can be defined as string or an object with properties to select the element." } }, "required": [ "selector" ], "type": "object" }, { "additionalProperties": false, "properties": { "data-cy": { "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" } }, "type": "object" }, { "enum": [ true ], "type": "boolean" }, { "type": "string" } ], "description": "A blur action triggers a blur event on the selected DOM element to remove focus." }, "click": { "anyOf": [ { "additionalProperties": false, "properties": { "force": { "default": false, "description": "If true, the click event is triggered even if the element is not visible. The default is false.", "type": "boolean" }, "multiple": { "default": false, "description": "If true, the click event is triggered on all matching elements. The default is false.", "type": "boolean" }, "selector": { "anyOf": [ { "additionalProperties": false, "properties": { "data-cy": { "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" } }, "type": "object" }, { "type": "string" } ], "description": "The selector to use to select the DOM element. The selector can be defined as string or an object with properties to select the element." } }, "required": [ "selector" ], "type": "object" }, { "additionalProperties": false, "properties": { "data-cy": { "type": "string" }, "force": { "default": false, "description": "If true, the click event is triggered even if the element is not visible. The default is false.", "type": "boolean" }, "multiple": { "default": false, "description": "If true, the click event is triggered on all matching elements. The default is false.", "type": "boolean" } }, "type": "object" }, { "additionalProperties": false, "properties": { "force": { "default": false, "description": "If true, the click event is triggered even if the element is not visible. The default is false.", "type": "boolean" }, "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] }, "multiple": { "default": false, "description": "If true, the click event is triggered on all matching elements. The default is false.", "type": "boolean" } }, "type": "object" }, { "additionalProperties": false, "properties": { "force": { "default": false, "description": "If true, the click event is triggered even if the element is not visible. The default is false.", "type": "boolean" }, "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" }, "multiple": { "default": false, "description": "If true, the click event is triggered on all matching elements. The default is false.", "type": "boolean" } }, "type": "object" }, { "type": "string" } ], "description": "A click action triggers a click event on the selected DOM element." }, "fileUpload": { "anyOf": [ { "additionalProperties": false, "properties": { "encoding": { "description": "The encoding of the file. If not provided, the encoding is determined automatically. Default is 'utf8' or 'binary' depending of file extension.", "enum": [ "binary", "utf-8", "utf8" ], "examples": [ [ "binary", "utf8" ] ], "type": "string" }, "file": { "description": "The path to the file to upload. Resolve the file path relative to the current working directory. Currently, only a single file of types .json, .txt, .csv, .png, .jpg, .jpeg, .gif can be uploaded. If file does not have required extension, overwrite extension in the fileName property.", "type": "string" }, "fileName": { "description": "The name of the file to use when uploading including file extension. If not provided, the file name is determined from the file path.", "examples": [ "file.txt" ], "type": "string" }, "force": { "default": false, "description": "If true, the file is uploaded even if the element is not visible. The default is false.", "type": "boolean" }, "mimeType": { "description": "The MIME type of the file. If not provided, the MIME type is determined automatically.", "examples": [ "application/json", "text/csv", "image/png" ], "type": "string" }, "selector": { "anyOf": [ { "additionalProperties": false, "properties": { "data-cy": { "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" } }, "type": "object" }, { "type": "string" } ], "description": "The selector to use to select the DOM element. The selector can be defined as string or an object with properties to select the element." }, "subjectType": { "default": "input", "description": "The type of the file input element. The default is 'input'.", "enum": [ "drag-n-drop", "input" ], "type": "string" } }, "required": [ "file", "selector" ], "type": "object" }, { "additionalProperties": false, "properties": { "data-cy": { "type": "string" }, "encoding": { "description": "The encoding of the file. If not provided, the encoding is determined automatically. Default is 'utf8' or 'binary' depending of file extension.", "enum": [ "binary", "utf-8", "utf8" ], "examples": [ [ "binary", "utf8" ] ], "type": "string" }, "file": { "description": "The path to the file to upload. Resolve the file path relative to the current working directory. Currently, only a single file of types .json, .txt, .csv, .png, .jpg, .jpeg, .gif can be uploaded. If file does not have required extension, overwrite extension in the fileName property.", "type": "string" }, "fileName": { "description": "The name of the file to use when uploading including file extension. If not provided, the file name is determined from the file path.", "examples": [ "file.txt" ], "type": "string" }, "force": { "default": false, "description": "If true, the file is uploaded even if the element is not visible. The default is false.", "type": "boolean" }, "mimeType": { "description": "The MIME type of the file. If not provided, the MIME type is determined automatically.", "examples": [ "application/json", "text/csv", "image/png" ], "type": "string" }, "subjectType": { "default": "input", "description": "The type of the file input element. The default is 'input'.", "enum": [ "drag-n-drop", "input" ], "type": "string" } }, "required": [ "file" ], "type": "object" }, { "additionalProperties": false, "properties": { "encoding": { "description": "The encoding of the file. If not provided, the encoding is determined automatically. Default is 'utf8' or 'binary' depending of file extension.", "enum": [ "binary", "utf-8", "utf8" ], "examples": [ [ "binary", "utf8" ] ], "type": "string" }, "file": { "description": "The path to the file to upload. Resolve the file path relative to the current working directory. Currently, only a single file of types .json, .txt, .csv, .png, .jpg, .jpeg, .gif can be uploaded. If file does not have required extension, overwrite extension in the fileName property.", "type": "string" }, "fileName": { "description": "The name of the file to use when uploading including file extension. If not provided, the file name is determined from the file path.", "examples": [ "file.txt" ], "type": "string" }, "force": { "default": false, "description": "If true, the file is uploaded even if the element is not visible. The default is false.", "type": "boolean" }, "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] }, "mimeType": { "description": "The MIME type of the file. If not provided, the MIME type is determined automatically.", "examples": [ "application/json", "text/csv", "image/png" ], "type": "string" }, "subjectType": { "default": "input", "description": "The type of the file input element. The default is 'input'.", "enum": [ "drag-n-drop", "input" ], "type": "string" } }, "required": [ "file" ], "type": "object" }, { "additionalProperties": false, "properties": { "encoding": { "description": "The encoding of the file. If not provided, the encoding is determined automatically. Default is 'utf8' or 'binary' depending of file extension.", "enum": [ "binary", "utf-8", "utf8" ], "examples": [ [ "binary", "utf8" ] ], "type": "string" }, "file": { "description": "The path to the file to upload. Resolve the file path relative to the current working directory. Currently, only a single file of types .json, .txt, .csv, .png, .jpg, .jpeg, .gif can be uploaded. If file does not have required extension, overwrite extension in the fileName property.", "type": "string" }, "fileName": { "description": "The name of the file to use when uploading including file extension. If not provided, the file name is determined from the file path.", "examples": [ "file.txt" ], "type": "string" }, "force": { "default": false, "description": "If true, the file is uploaded even if the element is not visible. The default is false.", "type": "boolean" }, "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" }, "mimeType": { "description": "The MIME type of the file. If not provided, the MIME type is determined automatically.", "examples": [ "application/json", "text/csv", "image/png" ], "type": "string" }, "subjectType": { "default": "input", "description": "The type of the file input element. The default is 'input'.", "enum": [ "drag-n-drop", "input" ], "type": "string" } }, "required": [ "file" ], "type": "object" }, { "type": "string" } ], "description": "Use the file upload action to upload a file using the file input element. Currently supported file types are .json, .txt, .csv, .png, .jpg, .jpeg, .gif." }, "focus": { "anyOf": [ { "additionalProperties": false, "properties": { "selector": { "anyOf": [ { "additionalProperties": false, "properties": { "data-cy": { "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" } }, "type": "object" }, { "type": "string" } ], "description": "The selector to use to select the DOM element. The selector can be defined as string or an object with properties to select the element." } }, "required": [ "selector" ], "type": "object" }, { "additionalProperties": false, "properties": { "data-cy": { "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" } }, "type": "object" }, { "type": "string" } ], "description": "A focus action triggers a focus event on the selected DOM element." }, "highlight": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "additionalProperties": false, "properties": { "border": { "description": "The border style. Use any valid CSS border style. If provided an object, keys override the default border style.", "examples": [ "1px solid red" ] }, "clear": { "default": false, "description": "If true, existing highlights will be cleared before highlighting. The default is false.", "type": "boolean" }, "height": { "description": "Overwrite the height of the highlighted element. If smaller than 1, the value is used as percentage of the element height.", "type": "number" }, "multiple": { "default": false, "description": "If true, the highlight is applied to all elements in the selection. The default is false.", "type": "boolean" }, "offset": { "description": "The outline offset. The default is -2px.", "type": "string" }, "selector": { "anyOf": [ { "additionalProperties": false, "properties": { "data-cy": { "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" } }, "type": "object" }, { "type": "string" } ], "description": "The selector to use to select the DOM element. The selector can be defined as string or an object with properties to select the element." }, "styles": { "description": "The CSS styles to apply to the DOM element. Use any valid CSS styles.", "examples": [ [ "background-color: yellow", "outline: dashed", "outline-offset: +3px" ] ] }, "width": { "description": "Overwrite the width of the highlighted element. If smaller than 1, the value is used as percentage of the element width.", "type": "number" } }, "required": [ "selector" ], "type": "object" }, { "additionalProperties": false, "properties": { "border": { "description": "The border style. Use any valid CSS border style. If provided an object, keys override the default border style.", "examples": [ "1px solid red" ] }, "clear": { "default": false, "description": "If true, existing highlights will be cleared before highlighting. The default is false.", "type": "boolean" }, "data-cy": { "type": "string" }, "height": { "description": "Overwrite the height of the highlighted element. If smaller than 1, the value is used as percentage of the element height.", "type": "number" }, "multiple": { "default": false, "description": "If true, the highlight is applied to all elements in the selection. The default is false.", "type": "boolean" }, "offset": { "description": "The outline offset. The default is -2px.", "type": "string" }, "styles": { "description": "The CSS styles to apply to the DOM element. Use any valid CSS styles.", "examples": [ [ "background-color: yellow", "outline: dashed", "outline-offset: +3px" ] ] }, "width": { "description": "Overwrite the width of the highlighted element. If smaller than 1, the value is used as percentage of the element width.", "type": "number" } }, "type": "object" }, { "additionalProperties": false, "properties": { "border": { "description": "The border style. Use any valid CSS border style. If provided an object, keys override the default border style.", "examples": [ "1px solid red" ] }, "clear": { "default": false, "description": "If true, existing highlights will be cleared before highlighting. The default is false.", "type": "boolean" }, "height": { "description": "Overwrite the height of the highlighted element. If smaller than 1, the value is used as percentage of the element height.", "type": "number" }, "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] }, "multiple": { "default": false, "description": "If true, the highlight is applied to all elements in the selection. The default is false.", "type": "boolean" }, "offset": { "description": "The outline offset. The default is -2px.", "type": "string" }, "styles": { "description": "The CSS styles to apply to the DOM element. Use any valid CSS styles.", "examples": [ [ "background-color: yellow", "outline: dashed", "outline-offset: +3px" ] ] }, "width": { "description": "Overwrite the width of the highlighted element. If smaller than 1, the value is used as percentage of the element width.", "type": "number" } }, "type": "object" }, { "additionalProperties": false, "properties": { "border": { "description": "The border style. Use any valid CSS border style. If provided an object, keys override the default border style.", "examples": [ "1px solid red" ] }, "clear": { "default": false, "description": "If true, existing highlights will be cleared before highlighting. The default is false.", "type": "boolean" }, "height": { "description": "Overwrite the height of the highlighted element. If smaller than 1, the value is used as percentage of the element height.", "type": "number" }, "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" }, "multiple": { "default": false, "description": "If true, the highlight is applied to all elements in the selection. The default is false.", "type": "boolean" }, "offset": { "description": "The outline offset. The default is -2px.", "type": "string" }, "styles": { "description": "The CSS styles to apply to the DOM element. Use any valid CSS styles.", "examples": [ [ "background-color: yellow", "outline: dashed", "outline-offset: +3px" ] ] }, "width": { "description": "Overwrite the width of the highlighted element. If smaller than 1, the value is used as percentage of the element width.", "type": "number" } }, "type": "object" }, { "additionalProperties": false, "properties": { "clear": { "enum": [ true ], "type": "boolean" } }, "required": [ "clear" ], "type": "object" }, { "items": { "anyOf": [ { "additionalProperties": false, "properties": { "border": { "description": "The border style. Use any valid CSS border style. If provided an object, keys override the default border style.", "examples": [ "1px solid red" ] }, "clear": { "default": false, "description": "If true, existing highlights will be cleared before highlighting. The default is false.", "type": "boolean" }, "height": { "description": "Overwrite the height of the highlighted element. If smaller than 1, the value is used as percentage of the element height.", "type": "number" }, "multiple": { "default": false, "description": "If true, the highlight is applied to all elements in the selection. The default is false.", "type": "boolean" }, "offset": { "description": "The outline offset. The default is -2px.", "type": "string" }, "selector": { "anyOf": [ { "additionalProperties": false, "properties": { "data-cy": { "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" } }, "type": "object" }, { "type": "string" } ], "description": "The selector to use to select the DOM element. The selector can be defined as string or an object with properties to select the element." }, "styles": { "description": "The CSS styles to apply to the DOM element. Use any valid CSS styles.", "examples": [ [ "background-color: yellow", "outline: dashed", "outline-offset: +3px" ] ] }, "width": { "description": "Overwrite the width of the highlighted element. If smaller than 1, the value is used as percentage of the element width.", "type": "number" } }, "required": [ "selector" ], "type": "object" }, { "additionalProperties": false, "properties": { "border": { "description": "The border style. Use any valid CSS border style. If provided an object, keys override the default border style.", "examples": [ "1px solid red" ] }, "clear": { "default": false, "description": "If true, existing highlights will be cleared before highlighting. The default is false.", "type": "boolean" }, "data-cy": { "type": "string" }, "height": { "description": "Overwrite the height of the highlighted element. If smaller than 1, the value is used as percentage of the element height.", "type": "number" }, "multiple": { "default": false, "description": "If true, the highlight is applied to all elements in the selection. The default is false.", "type": "boolean" }, "offset": { "description": "The outline offset. The default is -2px.", "type": "string" }, "styles": { "description": "The CSS styles to apply to the DOM element. Use any valid CSS styles.", "examples": [ [ "background-color: yellow", "outline: dashed", "outline-offset: +3px" ] ] }, "width": { "description": "Overwrite the width of the highlighted element. If smaller than 1, the value is used as percentage of the element width.", "type": "number" } }, "type": "object" }, { "additionalProperties": false, "properties": { "border": { "description": "The border style. Use any valid CSS border style. If provided an object, keys override the default border style.", "examples": [ "1px solid red" ] }, "clear": { "default": false, "description": "If true, existing highlights will be cleared before highlighting. The default is false.", "type": "boolean" }, "height": { "description": "Overwrite the height of the highlighted element. If smaller than 1, the value is used as percentage of the element height.", "type": "number" }, "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] }, "multiple": { "default": false, "description": "If true, the highlight is applied to all elements in the selection. The default is false.", "type": "boolean" }, "offset": { "description": "The outline offset. The default is -2px.", "type": "string" }, "styles": { "description": "The CSS styles to apply to the DOM element. Use any valid CSS styles.", "examples": [ [ "background-color: yellow", "outline: dashed", "outline-offset: +3px" ] ] }, "width": { "description": "Overwrite the width of the highlighted element. If smaller than 1, the value is used as percentage of the element width.", "type": "number" } }, "type": "object" }, { "additionalProperties": false, "properties": { "border": { "description": "The border style. Use any valid CSS border style. If provided an object, keys override the default border style.", "examples": [ "1px solid red" ] }, "clear": { "default": false, "description": "If true, existing highlights will be cleared before highlighting. The default is false.", "type": "boolean" }, "height": { "description": "Overwrite the height of the highlighted element. If smaller than 1, the value is used as percentage of the element height.", "type": "number" }, "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" }, "multiple": { "default": false, "description": "If true, the highlight is applied to all elements in the selection. The default is false.", "type": "boolean" }, "offset": { "description": "The outline offset. The default is -2px.", "type": "string" }, "styles": { "description": "The CSS styles to apply to the DOM element. Use any valid CSS styles.", "examples": [ [ "background-color: yellow", "outline: dashed", "outline-offset: +3px" ] ] }, "width": { "description": "Overwrite the width of the highlighted element. If smaller than 1, the value is used as percentage of the element width.", "type": "number" } }, "type": "object" }, { "type": "string" } ] }, "type": "array" }, { "type": "string" } ], "description": "Use highlight action to visually highlight a selected DOM element in the screenshot. By default, the element is highlighted with an orange border. Use any valid CSS styles to highlight the element.\nTo clear existing highlights, set the clear property to true." }, "screenshot": { "anyOf": [ { "additionalProperties": false, "properties": { "clip": { "$ref": "#/definitions/ScreenshotClipArea", "description": "The clip area within the screenshot image. The clip area is defined by the top-left corner (x, y) and the width and height of the clip area." }, "padding": { "anyOf": [ { "items": [ { "type": "number" }, { "type": "number" } ], "maxItems": 2, "minItems": 2, "type": "array" }, { "items": [ { "type": "number" } ], "maxItems": 1, "minItems": 1, "type": "array" }, { "items": [ { "type": "number" }, { "type": "number" }, { "type": "number" } ], "maxItems": 3, "minItems": 3, "type": "array" }, { "items": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "maxItems": 4, "minItems": 4, "type": "array" }, { "type": "number" } ], "description": "The padding applied to the screenshots of elements in px. If an array of numbers is provided, the padding is applied as defined by CSS shorthand property." }, "path": { "description": "The path to store the screenshot. This is the relative path used within the screenshot folder.", "type": "string" }, "selector": { "anyOf": [ { "additionalProperties": false, "properties": { "data-cy": { "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" } }, "type": "object" }, { "type": "string" } ], "description": "The selector to use to select the DOM element. The selector can be defined as string or an object with properties to select the element." } }, "type": "object" }, { "additionalProperties": false, "properties": { "clip": { "$ref": "#/definitions/ScreenshotClipArea", "description": "The clip area within the screenshot image. The clip area is defined by the top-left corner (x, y) and the width and height of the clip area." }, "data-cy": { "type": "string" }, "padding": { "anyOf": [ { "items": [ { "type": "number" }, { "type": "number" } ], "maxItems": 2, "minItems": 2, "type": "array" }, { "items": [ { "type": "number" } ], "maxItems": 1, "minItems": 1, "type": "array" }, { "items": [ { "type": "number" }, { "type": "number" }, { "type": "number" } ], "maxItems": 3, "minItems": 3, "type": "array" }, { "items": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "maxItems": 4, "minItems": 4, "type": "array" }, { "type": "number" } ], "description": "The padding applied to the screenshots of elements in px. If an array of numbers is provided, the padding is applied as defined by CSS shorthand property." }, "path": { "description": "The path to store the screenshot. This is the relative path used within the screenshot folder.", "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "clip": { "$ref": "#/definitions/ScreenshotClipArea", "description": "The clip area within the screenshot image. The clip area is defined by the top-left corner (x, y) and the width and height of the clip area." }, "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] }, "padding": { "anyOf": [ { "items": [ { "type": "number" }, { "type": "number" } ], "maxItems": 2, "minItems": 2, "type": "array" }, { "items": [ { "type": "number" } ], "maxItems": 1, "minItems": 1, "type": "array" }, { "items": [ { "type": "number" }, { "type": "number" }, { "type": "number" } ], "maxItems": 3, "minItems": 3, "type": "array" }, { "items": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "maxItems": 4, "minItems": 4, "type": "array" }, { "type": "number" } ], "description": "The padding applied to the screenshots of elements in px. If an array of numbers is provided, the padding is applied as defined by CSS shorthand property." }, "path": { "description": "The path to store the screenshot. This is the relative path used within the screenshot folder.", "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "clip": { "$ref": "#/definitions/ScreenshotClipArea", "description": "The clip area within the screenshot image. The clip area is defined by the top-left corner (x, y) and the width and height of the clip area." }, "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" }, "padding": { "anyOf": [ { "items": [ { "type": "number" }, { "type": "number" } ], "maxItems": 2, "minItems": 2, "type": "array" }, { "items": [ { "type": "number" } ], "maxItems": 1, "minItems": 1, "type": "array" }, { "items": [ { "type": "number" }, { "type": "number" }, { "type": "number" } ], "maxItems": 3, "minItems": 3, "type": "array" }, { "items": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "maxItems": 4, "minItems": 4, "type": "array" }, { "type": "number" } ], "description": "The padding applied to the screenshots of elements in px. If an array of numbers is provided, the padding is applied as defined by CSS shorthand property." }, "path": { "description": "The path to store the screenshot. This is the relative path used within the screenshot folder.", "type": "string" } }, "type": "object" }, { "type": "string" } ], "description": "The screenshot action triggers a screenshot of the current state of the application." }, "scrollTo": { "anyOf": [ { "$ref": "#/definitions/ScrollToAction" }, { "additionalProperties": false, "properties": { "selector": { "anyOf": [ { "additionalProperties": false, "properties": { "data-cy": { "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" } }, "type": "object" }, { "type": "string" } ], "description": "The selector to use to select the DOM element. The selector can be defined as string or an object with properties to select the element." } }, "required": [ "selector" ], "type": "object" }, { "additionalProperties": false, "properties": { "data-cy": { "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" } }, "type": "object" }, { "type": "string" } ], "description": "A scroll action scrolls the page to a specific position or element. Use the position property to scroll to a specific position or the element property to scroll to a selected DOM element." }, "text": { "anyOf": [ { "additionalProperties": false, "properties": { "selector": { "anyOf": [ { "additionalProperties": false, "properties": { "data-cy": { "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" } }, "type": "object" }, { "type": "string" } ], "description": "The selector to use to select the DOM element. The selector can be defined as string or an object with properties to select the element." }, "value": { "description": "The value to set", "type": "string" } }, "required": [ "selector", "value" ], "type": "object" }, { "additionalProperties": false, "properties": { "data-cy": { "type": "string" }, "value": { "description": "The value to set", "type": "string" } }, "required": [ "value" ], "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] }, "value": { "description": "The value to set", "type": "string" } }, "required": [ "value" ], "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" }, "value": { "description": "The value to set", "type": "string" } }, "required": [ "value" ], "type": "object" } ], "description": "A text action modifies the text value of selected DOM element." }, "type": { "anyOf": [ { "additionalProperties": false, "properties": { "blur": { "default": false, "description": "If true, the element is blurred after typing to remove the focus. The default is false.", "type": "boolean" }, "clear": { "default": false, "description": "If true, the text input is cleared before typing. The default is false.", "type": "boolean" }, "selector": { "anyOf": [ { "additionalProperties": false, "properties": { "data-cy": { "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" } }, "type": "object" }, { "type": "string" } ], "description": "The selector to use to select the DOM element. The selector can be defined as string or an object with properties to select the element." }, "submit": { "anyOf": [ { "additionalProperties": false, "properties": { "selector": { "anyOf": [ { "additionalProperties": false, "properties": { "data-cy": { "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" } }, "type": "object" }, { "type": "string" } ], "description": "The selector to use to select the DOM element. The selector can be defined as string or an object with properties to select the element." } }, "required": [ "selector" ], "type": "object" }, { "additionalProperties": false, "properties": { "data-cy": { "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" } }, "type": "object" }, { "type": "string" } ], "description": "The submit selector is triggered for every entry value. Use to go over multistep forms. If the submit selector is not found, the form is not automatically continued and multistep finishes." }, "value": { "anyOf": [ { "items": { "type": [ "null", "string" ] }, "type": "array" }, { "items": { "items": { "type": [ "null", "string" ] }, "type": "array" }, "type": "array" }, { "type": "string" } ], "description": "The value to type into the selected DOM element. The value can be a string or an array of strings. If an array is provided, textfields within the selector are filled with the values in the array.\n\nFor multistep forms, the value can be an array of strings. Each array represents a step in the form. The first value in the array is typed into the first textfield, the second value in the second textfield, and so on. Configure submit selector to continue to the next step of the form." } }, "required": [ "selector", "value" ], "type": "object" }, { "additionalProperties": false, "properties": { "blur": { "default": false, "description": "If true, the element is blurred after typing to remove the focus. The default is false.", "type": "boolean" }, "clear": { "default": false, "description": "If true, the text input is cleared before typing. The default is false.", "type": "boolean" }, "data-cy": { "type": "string" }, "submit": { "anyOf": [ { "additionalProperties": false, "properties": { "selector": { "anyOf": [ { "additionalProperties": false, "properties": { "data-cy": { "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" } }, "type": "object" }, { "type": "string" } ], "description": "The selector to use to select the DOM element. The selector can be defined as string or an object with properties to select the element." } }, "required": [ "selector" ], "type": "object" }, { "additionalProperties": false, "properties": { "data-cy": { "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" } }, "type": "object" }, { "type": "string" } ], "description": "The submit selector is triggered for every entry value. Use to go over multistep forms. If the submit selector is not found, the form is not automatically continued and multistep finishes." }, "value": { "anyOf": [ { "items": { "type": [ "null", "string" ] }, "type": "array" }, { "items": { "items": { "type": [ "null", "string" ] }, "type": "array" }, "type": "array" }, { "type": "string" } ], "description": "The value to type into the selected DOM element. The value can be a string or an array of strings. If an array is provided, textfields within the selector are filled with the values in the array.\n\nFor multistep forms, the value can be an array of strings. Each array represents a step in the form. The first value in the array is typed into the first textfield, the second value in the second textfield, and so on. Configure submit selector to continue to the next step of the form." } }, "required": [ "value" ], "type": "object" }, { "additionalProperties": false, "properties": { "blur": { "default": false, "description": "If true, the element is blurred after typing to remove the focus. The default is false.", "type": "boolean" }, "clear": { "default": false, "description": "If true, the text input is cleared before typing. The default is false.", "type": "boolean" }, "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] }, "submit": { "anyOf": [ { "additionalProperties": false, "properties": { "selector": { "anyOf": [ { "additionalProperties": false, "properties": { "data-cy": { "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" } }, "type": "object" }, { "type": "string" } ], "description": "The selector to use to select the DOM element. The selector can be defined as string or an object with properties to select the element." } }, "required": [ "selector" ], "type": "object" }, { "additionalProperties": false, "properties": { "data-cy": { "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" } }, "type": "object" }, { "type": "string" } ], "description": "The submit selector is triggered for every entry value. Use to go over multistep forms. If the submit selector is not found, the form is not automatically continued and multistep finishes." }, "value": { "anyOf": [ { "items": { "type": [ "null", "string" ] }, "type": "array" }, { "items": { "items": { "type": [ "null", "string" ] }, "type": "array" }, "type": "array" }, { "type": "string" } ], "description": "The value to type into the selected DOM element. The value can be a string or an array of strings. If an array is provided, textfields within the selector are filled with the values in the array.\n\nFor multistep forms, the value can be an array of strings. Each array represents a step in the form. The first value in the array is typed into the first textfield, the second value in the second textfield, and so on. Configure submit selector to continue to the next step of the form." } }, "required": [ "value" ], "type": "object" }, { "additionalProperties": false, "properties": { "blur": { "default": false, "description": "If true, the element is blurred after typing to remove the focus. The default is false.", "type": "boolean" }, "clear": { "default": false, "description": "If true, the text input is cleared before typing. The default is false.", "type": "boolean" }, "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" }, "submit": { "anyOf": [ { "additionalProperties": false, "properties": { "selector": { "anyOf": [ { "additionalProperties": false, "properties": { "data-cy": { "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" } }, "type": "object" }, { "type": "string" } ], "description": "The selector to use to select the DOM element. The selector can be defined as string or an object with properties to select the element." } }, "required": [ "selector" ], "type": "object" }, { "additionalProperties": false, "properties": { "data-cy": { "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" } }, "type": "object" }, { "type": "string" } ], "description": "The submit selector is triggered for every entry value. Use to go over multistep forms. If the submit selector is not found, the form is not automatically continued and multistep finishes." }, "value": { "anyOf": [ { "items": { "type": [ "null", "string" ] }, "type": "array" }, { "items": { "items": { "type": [ "null", "string" ] }, "type": "array" }, "type": "array" }, { "type": "string" } ], "description": "The value to type into the selected DOM element. The value can be a string or an array of strings. If an array is provided, textfields within the selector are filled with the values in the array.\n\nFor multistep forms, the value can be an array of strings. Each array represents a step in the form. The first value in the array is typed into the first textfield, the second value in the second textfield, and so on. Configure submit selector to continue to the next step of the form." } }, "required": [ "value" ], "type": "object" } ], "description": "A type action triggers a type event on the selected DOM element. Use to simulate typing in an input field." }, "wait": { "anyOf": [ { "$ref": "#/definitions/WaitAction" }, { "type": "number" } ], "description": "A wait action waits for the given time in ms or for a given chainer assertion.", "examples": [ 1000, 10000 ] } }, "type": "object" }, "ForwardedOdiffOptions": { "additionalProperties": false, "properties": { "antialiasing": { "description": "If this is true, antialiased pixels are not counted to the diff of an image", "type": "boolean" }, "diffColor": { "description": "Color used to highlight different pixels in the output (in hex format e.g. #cd2cc9).", "type": "string" }, "ignoreRegions": { "description": "An array of regions to ignore in the diff.", "items": { "additionalProperties": false, "properties": { "x1": { "type": "number" }, "x2": { "type": "number" }, "y1": { "type": "number" }, "y2": { "type": "number" } }, "required": [ "x1", "x2", "y1", "y2" ], "type": "object" }, "type": "array" }, "outputDiffMask": { "description": "Output full diff image.", "type": "boolean" }, "threshold": { "description": "Color difference threshold (from 0 to 1). Less more precise.", "type": "number" } }, "type": "object" }, "Partial>": { "additionalProperties": false, "properties": { "displayName": { "description": "The display name", "type": "string" }, "email": { "description": "User email address.", "type": "string" }, "firstName": { "description": "User first name.", "type": "string" }, "id": { "description": "Uniquely identifies a user", "type": "string" }, "lastName": { "description": "User last name.", "type": "string" }, "phone": { "description": "User phone number.", "type": "string" }, "userName": { "description": "User name, unique for a given domain.\nMax: 1000 characters. Whitespaces, slashes, +$: characters not allowed", "type": "string" } }, "type": "object" }, "ScreenshotClipArea": { "additionalProperties": false, "properties": { "height": { "description": "The height of the clip area. If negative, the height is subtracted from the viewport height.", "type": "integer" }, "width": { "description": "The width of the clip area. If negative, the width is subtracted from the viewport width.", "type": "integer" }, "x": { "description": "The x-coordinate of the top-left corner of the clip area", "minimum": 0, "type": "integer" }, "y": { "description": "The y-coordinate of the top-left corner of the clip area", "minimum": 0, "type": "integer" } }, "required": [ "height", "width", "x", "y" ], "type": "object" }, "ScreenshotSettings": { "additionalProperties": false, "properties": { "capture": { "default": "viewport", "description": "The capturing type for the screenshot. When 'fullPage' is used, the application is captured in its entirety from top to bottom. Setting is ignored when screenshots are taken for a selected DOM element. The default is 'viewport'.\nNote that 'fullPage' screenshots will have a different height than specified in 'viewportHeight'.", "enum": [ "fullPage", "viewport" ], "examples": [ [ "viewport", "fullPage" ] ], "type": "string" }, "diff": { "$ref": "#/definitions/ForwardedOdiffOptions", "description": "Options to configure the diffing of screenshots." }, "disableTimersAndAnimations": { "description": "When true, prevents JavaScript timers (setTimeout, setInterval, etc) and CSS animations from running while the screenshot is taken.", "type": "boolean" }, "overwrite": { "description": "Overwrite existing screenshots. By enabling this setting, existing screenshots might be deleted before running the screenshot workflow.", "type": "boolean" }, "padding": { "description": "The padding in px used to alter the dimensions of a screenshot of an element.", "minimum": 0, "type": "integer" }, "scale": { "description": "Whether to scale the app to fit into the browser viewport.", "type": "boolean" }, "timeouts": { "additionalProperties": false, "description": "The timeouts supported by Cypress.", "properties": { "default": { "default": 4000, "description": "The time, in milliseconds, to wait until most DOM based commands are considered timed out.", "examples": [ 10000 ], "type": "integer" }, "pageLoad": { "default": 60000, "description": "The time, in milliseconds, to wait for the page to load. This is used for visit actions.", "examples": [ 30000 ], "type": "integer" }, "screenshot": { "default": 30000, "description": "The time, in milliseconds, to wait for a response from a network request. Also applies to screenshot action.", "examples": [ 60000 ], "type": "integer" } }, "type": "object" }, "viewportHeight": { "default": 900, "description": "The height in px to use for the browser window", "minimum": 0, "type": "integer" }, "viewportWidth": { "default": 1440, "description": "The width in px to use for the browser window", "minimum": 0, "type": "integer" } }, "type": "object" }, "ScrollToAction": { "additionalProperties": false, "properties": { "element": { "anyOf": [ { "additionalProperties": false, "properties": { "offset": { "items": [ { "type": "number" }, { "type": "number" } ], "maxItems": 2, "minItems": 2, "type": "array" }, "selector": { "anyOf": [ { "additionalProperties": false, "properties": { "data-cy": { "type": "string" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" } }, "type": "object" }, { "type": "string" } ], "description": "The selector to use to select the DOM element. The selector can be defined as string or an object with properties to select the element." } }, "required": [ "selector" ], "type": "object" }, { "additionalProperties": false, "properties": { "data-cy": { "type": "string" }, "offset": { "items": [ { "type": "number" }, { "type": "number" } ], "maxItems": 2, "minItems": 2, "type": "array" } }, "type": "object" }, { "additionalProperties": false, "properties": { "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The language(s) this selector is valid for. If the language of the application matches the language of the selector, the selector is used to select the element.\nIf language is not supported by the selector, the selector is ignored.", "examples": [ "en", "de", [ "en", "de" ] ] }, "offset": { "items": [ { "type": "number" }, { "type": "number" } ], "maxItems": 2, "minItems": 2, "type": "array" } }, "type": "object" }, { "additionalProperties": false, "properties": { "localized": { "additionalProperties": { "type": "string" }, "description": "Language key and localized selector mapping. Use for example to select elements based on the language of the application.", "examples": [ { "de": "span.label-info:not(:contains('Objekt'))", "en": "span.label-info:not(:contains('Object'))" } ], "type": "object" }, "offset": { "items": [ { "type": "number" }, { "type": "number" } ], "maxItems": 2, "minItems": 2, "type": "array" } }, "type": "object" }, { "type": "string" } ], "description": "The element to scroll to. Requires a selector or a DOM element. If the element is not visible, the page is scrolled to make the element visible.\nThe offset is applied when the element has been scrolled into view. The offset represents left and right pixel to scroll." }, "position": { "anyOf": [ { "items": [ { "type": "number" }, { "type": "number" } ], "maxItems": 2, "minItems": 2, "type": "array" }, { "items": [ { "type": "string" }, { "type": "string" } ], "maxItems": 2, "minItems": 2, "type": "array" }, { "enum": [ "bottom", "bottomLeft", "bottomRight", "center", "left", "right", "top", "topLeft", "topRight" ], "type": "string" } ], "description": "The position to scroll to. The default is 'top'. Provide a string, an array of strings, or a number to scroll to a specific position.", "examples": [ "top", "bottom", [ "top", "100px" ], [ 0, 100 ], [ "0%", "25%" ] ] } }, "type": "object" }, "Visit": { "additionalProperties": false, "properties": { "selector": { "description": "The selector to wait for before taking the screenshot.", "examples": [ "c8y-drawer-outlet c8y-app-icon .c8y-icon" ], "type": "string" }, "timeout": { "description": "The timeout in ms to wait for the page to load.", "examples": [ 30000 ], "type": "integer" }, "url": { "description": "The URL to visit. Currently only an URI relative to the base URL is supported.", "format": "uri-reference", "type": "string" } }, "required": [ "url" ], "type": "object" }, "WaitAction": { "additionalProperties": false, "properties": { "assert": { "anyOf": [ { "additionalProperties": false, "properties": { "chainer": { "description": "The chainer assertion to. Could be any valid Cypress chainer. The chainer is not validated and may or may not have a value to assert.", "examples": [ "have.length", "eq", "be.visible" ], "type": "string" }, "value": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The value to assert. The value is optional and may not be required by the chainer assertion." } }, "required": [ "chainer" ], "type": "object" }, { "type": "string" } ], "description": "The chainer assertion to wait for. This translates to a Cypress get().should().\nSee https://docs.cypress.io/api/commands/should" }, "timeout": { "default": 4000, "description": "The timeout in ms to wait for", "type": "integer" } }, "type": "object" } }, "properties": { "baseUrl": { "description": "The base URL used for all relative requests.", "format": "uri", "type": "string" }, "global": { "additionalProperties": false, "description": "The global settings for all screenshots", "properties": { "capture": { "default": "viewport", "description": "The capturing type for the screenshot. When 'fullPage' is used, the application is captured in its entirety from top to bottom. Setting is ignored when screenshots are taken for a selected DOM element. The default is 'viewport'.\nNote that 'fullPage' screenshots will have a different height than specified in 'viewportHeight'.", "enum": [ "fullPage", "viewport" ], "examples": [ [ "viewport", "fullPage" ] ], "type": "string" }, "date": { "description": "The date to simulate when running the screenshot workflows", "examples": [ "2024-09-26T19:17:35+02:00" ], "format": "date-time", "type": "string" }, "diff": { "$ref": "#/definitions/ForwardedOdiffOptions", "description": "Options to configure the diffing of screenshots." }, "disableTimersAndAnimations": { "description": "When true, prevents JavaScript timers (setTimeout, setInterval, etc) and CSS animations from running while the screenshot is taken.", "type": "boolean" }, "highlightStyle": { "description": "The defaulft style to highlight elements. By default, an organge border of 2px width is used to highlight elements.", "examples": [ { "outline": "2px", "outline-color": "#FF9300", "outline-offset": "-2px", "outline-style": "solid" }, { "border": "2px solid red" } ] }, "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "Load Cumulocity with the given language" }, "login": { "anyOf": [ { "enum": [ false ], "type": "boolean" }, { "type": "string" } ], "description": "The alias referencing the username and password to login. Configure the username and password using *login*_username and *login*_password env variables. If set to false, login is disabled and visit is performed unauthenticated.", "examples": [ [ "admin", false ] ] }, "overwrite": { "description": "Overwrite existing screenshots. By enabling this setting, existing screenshots might be deleted before running the screenshot workflow.", "type": "boolean" }, "padding": { "description": "The padding in px used to alter the dimensions of a screenshot of an element.", "minimum": 0, "type": "integer" }, "requires": { "description": "Requires the shell application to have the a version in the given range. The range must be a valid semver range. If requires is configured and shell version does not fullfill the version requirement, the screenshot workflow will be skipped.", "examples": [ "1.x, ^1.0.0, >=1.0.0 <2.0.0" ], "format": "semver-range", "type": "string" }, "scale": { "description": "Whether to scale the app to fit into the browser viewport.", "type": "boolean" }, "scrollBehavior": { "default": false, "description": "Viewport position to which an element should be scrolled before executing commands. The default is false.", "enum": [ "bottom", "center", false, "nearest", "top" ] }, "shell": { "description": "The shell is used to dermine the version of the application used by \"requires\" (optional)", "examples": [ "cockpit, devicemanagement, oee" ], "type": "string" }, "tags": { "description": "Tags allow grouping and filtering of screenshots (optional)", "items": { "type": "string" }, "type": "array" }, "timeouts": { "additionalProperties": false, "description": "The timeouts supported by Cypress.", "properties": { "default": { "default": 4000, "description": "The time, in milliseconds, to wait until most DOM based commands are considered timed out.", "examples": [ 10000 ], "type": "integer" }, "pageLoad": { "default": 60000, "description": "The time, in milliseconds, to wait for the page to load. This is used for visit actions.", "examples": [ 30000 ], "type": "integer" }, "screenshot": { "default": 30000, "description": "The time, in milliseconds, to wait for a response from a network request. Also applies to screenshot action.", "examples": [ 60000 ], "type": "integer" } }, "type": "object" }, "user": { "anyOf": [ { "$ref": "#/definitions/Partial>" }, { "type": "string" } ], "description": "A user object with properties used to mock the user information in Cumulocity. This is useful to anonymize the user information in the screenshots." }, "viewportHeight": { "default": 900, "description": "The height in px to use for the browser window", "minimum": 0, "type": "integer" }, "viewportWidth": { "default": 1440, "description": "The width in px to use for the browser window", "minimum": 0, "type": "integer" }, "visitWaitSelector": { "default": "c8y-drawer-outlet c8y-app-icon .c8y-icon", "description": "The selector to wait for when visiting a page", "examples": [ "c8y-drawer-outlet c8y-app-icon .c8y-icon" ], "type": "string" } }, "type": "object" }, "screenshots": { "description": "The screenshot workflows", "items": { "additionalProperties": false, "properties": { "actions": { "anyOf": [ { "$ref": "#/definitions/Action" }, { "items": { "$ref": "#/definitions/Action" }, "type": "array" } ], "description": "The actions to perform in the screenshot workflow. The last actioncis always a screenshot action. If no actions are defined or last actions is not a screenshot action, a screenshot is taken of the current state of the application." }, "date": { "description": "The date to simulate when running the screenshot workflows", "examples": [ "2024-09-26T19:17:35+02:00" ], "format": "date-time", "type": "string" }, "image": { "description": "The name of the screenshot image as relative path", "examples": [ "/images/cockpit/dashboard.png" ], "type": "string" }, "language": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "Load Cumulocity with the given language" }, "login": { "anyOf": [ { "enum": [ false ], "type": "boolean" }, { "type": "string" } ], "description": "The alias referencing the username and password to login. Configure the username and password using *login*_username and *login*_password env variables. If set to false, login is disabled and visit is performed unauthenticated.", "examples": [ [ "admin", false ] ] }, "only": { "description": "Run only this screenshot workflow and all other workflows that have only setting enabled", "type": "boolean" }, "requires": { "description": "Requires the shell application to have the a version in the given range. The range must be a valid semver range. If requires is configured and shell version does not fullfill the version requirement, the screenshot workflow will be skipped.", "examples": [ "1.x, ^1.0.0, >=1.0.0 <2.0.0" ], "format": "semver-range", "type": "string" }, "scrollBehavior": { "default": false, "description": "Viewport position to which an element should be scrolled before executing commands. The default is false.", "enum": [ "bottom", "center", false, "nearest", "top" ] }, "settings": { "$ref": "#/definitions/ScreenshotSettings", "description": "The configuration and settings of the screenshot" }, "shell": { "description": "The shell is used to dermine the version of the application used by \"requires\" (optional)", "examples": [ "cockpit, devicemanagement, oee" ], "type": "string" }, "skip": { "description": "Skip this screenshot workflow", "type": "boolean" }, "tags": { "description": "Tags allow grouping and filtering of screenshots (optional)", "items": { "type": "string" }, "type": "array" }, "title": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string" } ], "description": "The title of the screenshot workflow. The title is used to group the screenshots. To provide a hierarchy of titles, use an array of strings." }, "user": { "anyOf": [ { "$ref": "#/definitions/Partial>" }, { "type": "string" } ], "description": "A user object with properties used to mock the user information in Cumulocity. This is useful to anonymize the user information in the screenshots." }, "visit": { "anyOf": [ { "$ref": "#/definitions/Visit" }, { "type": "string" } ], "description": "The URI to visit. This typically a relative path to the baseUrl.", "examples": [ "/apps/cockpit/index.html#/" ] } }, "required": [ "image", "visit" ], "type": "object" }, "type": "array" }, "selectors": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" } ], "description": "Definition of shared selectors to use in the screenshot workflows" }, "title": { "description": "The title used for root group of screenshot workflows", "type": "string" } }, "required": [ "screenshots" ], "type": "object" }