schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
embrace-config-schema-1.0.0.json
capture_coordinates
Set to false to disable capturing tap coordinates. Defaults to true.
{"type": "boolean"}
embrace-config-schema-1.0.0.json
capture_query_params
Set to false to disable capturing of web view query parameters. Defaults to true. If webview:enable is set to false, this setting has no effect since all capture of web view information is disabled.
{"type": "boolean"}
embrace-config-schema-1.0.0.json
enable
Set to false to disable capturing of web views. Defaults to true.
{"type": "boolean"}
github-action.json
pre-if
Allows you to define conditions for the `pre:` action execution. The `pre:` action will only run if the conditions in `pre-if` are met. If not set, then `pre-if` defaults to `always()`. Note that the `step` context is unavailable, as no steps have run yet.
{"type": "string"}
github-action.json
post-if
Allows you to define conditions for the `post:` action execution. The `post:` action will only run if the conditions in `post-if` are met. If not set, then `post-if` defaults to `always()`.
{"type": "string"}
github-action.json
runs-javascript
Configures the path to the action's code and the application used to execute the code.
{"type": "object", "properties": {"using": {"enum": ["node12", "node16"]}, "main": {"type": "string"}, "pre": {"type": "string"}, "pre-if": {}, "post": {"type": "string"}, "post-if": {}}, "required": ["using", "main"], "additionalProperties": false}
github-action.json
using
The application used to execute the code specified in `main`.
{"enum": ["node12", "node16"]}
github-action.json
main
The file that contains your action code. The application specified in `using` executes this file.
{"type": "string"}
github-action.json
pre
Allows you to run a script at the start of a job, before the `main:` action begins. For example, you can use `pre:` to run a prerequisite setup script. The application specified with the `using` syntax will execute this file. The `pre:` action always runs by default but you can override this using `pre-if`.
{"type": "string"}
github-action.json
post
Allows you to run a script at the end of a job, once the `main:` action has completed. For example, you can use `post:` to terminate certain processes or remove unneeded files. The application specified with the `using` syntax will execute this file. The `post:` action always runs by default but you can override this u...
{"type": "string"}
github-action.json
runs-composite
Configures the path to the composite action, and the application used to execute the code.
{"type": "object", "properties": {"using": {"const": "composite"}, "steps": {"type": "array", "items": {"type": "object", "properties": {"run": {"type": "string"}, "shell": {"type": "string", "anyOf": [{}, {"enum": ["bash", "pwsh", "python", "sh", "cmd", "powershell"]}]}, "uses": {"type": "string"}, "with": {"type": "o...
github-action.json
using
To use a composite run steps action, set this to 'composite'.
{"const": "composite"}
github-action.json
steps
The run steps that you plan to run in this action.
{"type": "array", "items": {"type": "object", "properties": {"run": {"type": "string"}, "shell": {"type": "string", "anyOf": [{}, {"enum": ["bash", "pwsh", "python", "sh", "cmd", "powershell"]}]}, "uses": {"type": "string"}, "with": {"type": "object"}, "name": {"type": "string"}, "id": {"type": "string"}, "if": {"type"...
github-action.json
run
The command you want to run. This can be inline or a script in your action repository.
{"type": "string"}
github-action.json
shell
The shell where you want to run the command.
{"type": "string", "anyOf": [{}, {"enum": ["bash", "pwsh", "python", "sh", "cmd", "powershell"]}]}
github-action.json
uses
Selects an action to run as part of a step in your job.
{"type": "string"}
github-action.json
with
A map of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case.
{"type": "object"}
github-action.json
name
The name of the composite run step.
{"type": "string"}
github-action.json
id
A unique identifier for the step. You can use the `id` to reference the step in contexts.
{"type": "string"}
github-action.json
if
You can use the if conditional to prevent a step from running unless a condition is met. You can use any supported context and expression to create a conditional. Expressions in an if conditional do not require the ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-synt...
{"type": "string"}
github-action.json
env
Sets a map of environment variables for only that step.
{"type": "object", "additionalProperties": {"type": "string"}}
github-action.json
continue-on-error
Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails.
{"oneOf": [{"type": "boolean"}, {}], "default": false}
github-action.json
working-directory
Specifies the working directory where the command is run.
{"type": "string"}
github-action.json
runs-docker
Configures the image used for the Docker action.
{"type": "object", "properties": {"using": {"const": "docker"}, "image": {"type": "string"}, "env": {"oneOf": [{"type": "object", "additionalProperties": {"oneOf": [{"type": "string"}, {"type": "number"}, {"type": "boolean"}]}}, {}]}, "entrypoint": {"type": "string"}, "pre-entrypoint": {"type": "string"}, "pre-if": {},...
github-action.json
using
You must set this value to 'docker'.
{"const": "docker"}
github-action.json
image
The Docker image to use as the container to run the action. The value can be the Docker base image name, a local `Dockerfile` in your repository, or a public image in Docker Hub or another registry. To reference a `Dockerfile` local to your repository, use a path relative to your action metadata file. The `docker` appl...
{"type": "string"}
github-action.json
env
Specifies a key/value map of environment variables to set in the container environment.
{"oneOf": [{"type": "object", "additionalProperties": {"oneOf": [{"type": "string"}, {"type": "number"}, {"type": "boolean"}]}}, {}]}
github-action.json
entrypoint
Overrides the Docker `ENTRYPOINT` in the `Dockerfile`, or sets it if one wasn't already specified. Use `entrypoint` when the `Dockerfile` does not specify an `ENTRYPOINT` or you want to override the `ENTRYPOINT` instruction. If you omit `entrypoint`, the commands you specify in the Docker `ENTRYPOINT` instruction will ...
{"type": "string"}
github-action.json
pre-entrypoint
Allows you to run a script before the `entrypoint` action begins. For example, you can use `pre-entrypoint:` to run a prerequisite setup script. GitHub Actions uses `docker run` to launch this action, and runs the script inside a new container that uses the same base image. This means that the runtime state is differen...
{"type": "string"}
github-action.json
post-entrypoint
Allows you to run a cleanup script once the `runs.entrypoint` action has completed. GitHub Actions uses `docker run` to launch this action. Because GitHub Actions runs the script inside a new container using the same base image, the runtime state is different from the main `entrypoint` container. You can access any sta...
{"type": "string"}
github-action.json
args
An array of strings that define the inputs for a Docker container. Inputs can include hardcoded strings. GitHub passes the `args` to the container's `ENTRYPOINT` when the container starts up. The `args` are used in place of the `CMD` instruction in a `Dockerfile`. If you use `CMD` in your `Dockerfile`, use the guidelin...
{"type": "array", "items": {"type": "string"}}
github-action.json
outputs
Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input. ...
{"type": "object", "patternProperties": {"^[_a-zA-Z][a-zA-Z0-9_-]*$": {"type": "object", "properties": {}, "required": ["description"], "additionalProperties": false}}, "additionalProperties": false}
github-action.json
^[_a-zA-Z][a-zA-Z0-9_-]*$
A string identifier to associate with the output. The value of `<output_id>` is a map of the output's metadata. The `<output_id>` must be a unique identifier within the outputs object. The `<output_id>` must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`.
{"type": "object", "properties": {}, "required": ["description"], "additionalProperties": false}
github-action.json
description
A string description of the output parameter.
{"type": "string"}
github-action.json
outputs-composite
Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input. ...
{"type": "object", "patternProperties": {"^[_a-zA-Z][a-zA-Z0-9_-]*$": {"type": "object", "properties": {"value": {"type": "string"}}, "required": ["description", "value"], "additionalProperties": false}}, "additionalProperties": false}
github-action.json
^[_a-zA-Z][a-zA-Z0-9_-]*$
A string identifier to associate with the output. The value of `<output_id>` is a map of the output's metadata. The `<output_id>` must be a unique identifier within the outputs object. The `<output_id>` must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`.
{"type": "object", "properties": {"value": {"type": "string"}}, "required": ["description", "value"], "additionalProperties": false}
github-action.json
description
A string description of the output parameter.
{"type": "string"}
github-action.json
value
The value that the output parameter will be mapped to. You can set this to a string or an expression with context. For example, you can use the steps context to set the value of an output to the output value of a step.
{"type": "string"}
github-action.json
name
The name of your action. GitHub displays the `name` in the Actions tab to help visually identify actions in each job.
{"type": "string"}
github-action.json
author
The name of the action's author.
{"type": "string"}
github-action.json
description
A short description of the action.
{"type": "string"}
github-action.json
inputs
Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids.
{"type": "object", "patternProperties": {"^[_a-zA-Z][a-zA-Z0-9_-]*$": {"type": "object", "properties": {"deprecationMessage": {"type": "string"}, "required": {"type": "boolean"}, "default": {"type": "string"}}, "required": ["description"], "additionalProperties": false}}, "additionalProperties": false}
github-action.json
^[_a-zA-Z][a-zA-Z0-9_-]*$
A string identifier to associate with the input. The value of `<input_id>` is a map of the input's metadata. The `<input_id>` must be a unique identifier within the inputs object. The `<input_id>` must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`.
{"type": "object", "properties": {"deprecationMessage": {"type": "string"}, "required": {"type": "boolean"}, "default": {"type": "string"}}, "required": ["description"], "additionalProperties": false}
github-action.json
description
A string description of the input parameter.
{"type": "string"}
github-action.json
deprecationMessage
A string shown to users using the deprecated input.
{"type": "string"}
github-action.json
required
A boolean to indicate whether the action requires the input parameter. Set to `true` when the parameter is required.
{"type": "boolean"}
github-action.json
default
A string representing the default value. The default value is used when an input parameter isn't specified in a workflow file.
{"type": "string"}
github-action.json
branding
You can use a color and Feather icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in GitHub Marketplace.
{"type": "object", "properties": {"color": {"type": "string", "enum": ["white", "yellow", "blue", "green", "orange", "red", "purple", "gray-dark"]}, "icon": {"type": "string", "enum": ["activity", "airplay", "alert-circle", "alert-octagon", "alert-triangle", "align-center", "align-justify", "align-left", "align-right",...
github-action.json
color
The background color of the badge.
{"type": "string", "enum": ["white", "yellow", "blue", "green", "orange", "red", "purple", "gray-dark"]}
github-action.json
icon
The name of the Feather icon to use.
{"type": "string", "enum": ["activity", "airplay", "alert-circle", "alert-octagon", "alert-triangle", "align-center", "align-justify", "align-left", "align-right", "anchor", "aperture", "archive", "arrow-down-circle", "arrow-down-left", "arrow-down-right", "arrow-down", "arrow-left-circle", "arrow-left", "arrow-right-c...
jsonConfig.json
type
Control type
{"type": "string", "enum": ["tabs", "panel"]}
jsonConfig.json
$schema
Specify a JSON schema
{"type": "string"}
jsonConfig.json
i18n
If translations will be provided via files, e.g. in admin/i18n/de/translations.json or provide the path to the i18n folder if it's custom or provide the translations inside this attribute as an object
{"oneOf": [{"type": "string"}, {"type": "boolean"}, {"type": "object", "patternProperties": {"^.+": {}}}]}
jsonConfig.json
items
Consists of objects representing e.g. a single tab
{"type": "object", "patternProperties": {"^.+": {"type": "object", "allOf": [{"if": {"properties": {"type": {"const": "language"}}}, "then": {"properties": {"system": {"type": "boolean"}, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": tru...
jsonConfig.json
^.+
Object representing e.g. a tab
{"type": "object", "allOf": [{"if": {"properties": {"type": {"const": "language"}}}, "then": {"properties": {"system": {"type": "boolean"}, "label": true, "type": true, "sm": true, "md": true, "lg": true, "xs": true, "newLine": true, "hidden": true, "hideOnlyControl": true, "disabled": true, "helpLink": true, "help": t...
jsonConfig.json
system
Allow the usage of the system language from system.config as default
{"type": "boolean"}
jsonConfig.json
command
Command to be sent.
{"type": "string"}
jsonConfig.json
jsonData
Data to be sent as parsable string, can contain special placeholder. E. g. '{"subject1": "${data.subject}", "options1": {"host": "${data.host}"}}'
{"type": "string"}
jsonConfig.json
data
Data to be sent as JSON.
{"type": "object"}
jsonConfig.json
freeSolo
Set freeSolo to true so the textbox can contain any arbitrary value.
{"type": "boolean"}
jsonConfig.json
placeholder
Placeholder (for text control)
{"type": "string"}
jsonConfig.json
command
Command to be sent.
{"type": "string"}
jsonConfig.json
jsonData
Data to be sent as parsable string, can contain special placeholder. E. g. '{"subject1": "${data.subject}", "options1": {"host": "${data.host}"}}'
{"type": "string"}
jsonConfig.json
data
Data to be sent as JSON.
{"type": "object"}
jsonConfig.json
manual
Allow manual editing. Without Dropdown
{"type": "boolean"}
jsonConfig.json
container
div, text
{"type": "string"}
jsonConfig.json
copyToClipboard
If true, show button
{"type": "boolean"}
jsonConfig.json
alsoDependsOn
Depends on other attributes and will be re-calculated when other attributes changed
{"type": "array", "items": {"type": "string"}}
jsonConfig.json
command
Command to be sent.
{"type": "string"}
jsonConfig.json
jsonData
Data to be sent as parsable string, can contain special placeholder. E. g. '{"subject1": "${data.subject}", "options1": {"host": "${data.host}"}}'
{"type": "string"}
jsonConfig.json
data
Data to be sent as JSON.
{"type": "object"}
jsonConfig.json
size
Size of the header: h1-h5
{"type": "number", "minimum": 1, "maximum": 5}
jsonConfig.json
text
Header text
{"oneOf": [{"type": "string"}, {}]}
jsonConfig.json
color
Optional color
{"type": "string", "enum": ["primary", "secondary"]}
jsonConfig.json
height
Optional height
{"type": "number"}
jsonConfig.json
crop
If true, allow user to crop the image (only for non svg)
{"type": "boolean"}
jsonConfig.json
square
Width must be equal to height or crop must allow only square as shape
{"type": "boolean"}
jsonConfig.json
maxWidth
Maximum width
{"type": "number"}
jsonConfig.json
maxHeight
Maximum height
{"type": "number"}
jsonConfig.json
maxSize
Maximum size
{"type": "number"}
jsonConfig.json
icon
Panel can have icon (base64)
{"type": "string"}
jsonConfig.json
accept
HTML accept attribute, like 'image/*,.pdf'
{"type": "string"}
jsonConfig.json
crop
If true, allow user to crop the image (only for non svg)
{"type": "boolean"}
jsonConfig.json
square
Width must be equal to height or crop must allow only square as shape
{"type": "boolean"}
jsonConfig.json
maxWidth
'Maximum width
{"type": "number"}
jsonConfig.json
maxHeight
'Maximum height
{"type": "number"}
jsonConfig.json
maxSize
'Maximum size
{"type": "number"}
jsonConfig.json
filename
Name of the file
{"type": "string"}
jsonConfig.json
command
Command to be sent.
{"type": "string"}
jsonConfig.json
color
Optional color
{"type": "string", "enum": ["primary", "secondary"]}
jsonConfig.json
icon
sendTo can have icon (base64)
{"type": "string"}
jsonConfig.json
jsonData
Data to be sent as parsable string, can contain special placeholder. E. g. '{"subject1": "${data.subject}", "options1": {"host": "${data.host}"}}'
{"type": "string"}
jsonConfig.json
data
Data to be sent as JSON.
{"type": "object"}
jsonConfig.json
result
{result1: {en: 'A'}, result2: {en: 'B'}}
{"type": "object"}
jsonConfig.json
error
{error1: {en: 'E'}, error2: {en: 'E2'}}
{"type": "object"}
jsonConfig.json
variant
If outlined or contained
{"type": "string", "enum": ["contained", "outlined"]}
jsonConfig.json
placeholder
Placeholder (for text control)
{"type": "string"}
jsonConfig.json
useNative
if adapter returns result with `native` attribute it will be used for configuration. If `saveConfig` is true, the user will be requested to save the configuration
{"type": "boolean"}
jsonConfig.json
showProcess
Show spinner while request is in progress
{"type": "boolean"}
jsonConfig.json
encrypted
Is value encrypted or not (of course only for texts)
{"type": "boolean"}