schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
ci.json | parallel | Splits up a single job into multiple that run in parallel. Provides `CI_NODE_INDEX` and `CI_NODE_TOTAL` environment variables to the jobs. | {"oneOf": [{"type": "integer", "default": 0, "minimum": 2, "maximum": 200}, {"type": "object", "properties": {"matrix": {"type": "array", "items": {"type": "object", "additionalProperties": {"type": ["string", "number", "array"]}}, "maxItems": 200}}, "additionalProperties": false, "required": ["matrix"]}]} |
ci.json | parallel | Creates N instances of the job that run in parallel. | {"type": "integer", "default": 0, "minimum": 2, "maximum": 200} |
ci.json | matrix | Defines different variables for jobs that are running in parallel. | {"type": "array", "items": {"type": "object", "additionalProperties": {"type": ["string", "number", "array"]}}, "maxItems": 200} |
ci.json | items | Defines the variables for a specific job. | {"type": "object", "additionalProperties": {"type": ["string", "number", "array"]}} |
ci.json | parallel_matrix | Use the `needs:parallel:matrix` keyword to specify parallelized jobs needed to be completed for the job to run. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#needsparallelmatrix) | {"oneOf": [{"type": "object", "properties": {"matrix": {"type": "array", "items": {"type": "object", "additionalProperties": {"type": ["string", "number", "array"]}}, "maxItems": 200}}, "additionalProperties": false, "required": ["matrix"]}]} |
ci.json | matrix | Defines different variables for jobs that are running in parallel. | {"type": "array", "items": {"type": "object", "additionalProperties": {"type": ["string", "number", "array"]}}, "maxItems": 200} |
ci.json | items | Defines the variables for a specific job. | {"type": "object", "additionalProperties": {"type": ["string", "number", "array"]}} |
ci.json | filter_refs | Filter job by different keywords that determine origin or state, or by supplying string/regex to check against branch/tag names. | {"type": "array", "items": {"anyOf": [{"oneOf": [{"enum": ["branches"]}, {"enum": ["tags"]}, {"enum": ["api"]}, {"enum": ["external"]}, {"enum": ["pipelines"]}, {"enum": ["pushes"]}, {"enum": ["schedules"]}, {"enum": ["triggers"]}, {"enum": ["web"]}]}, {"type": "string"}]}} |
ci.json | items | When a branch is pushed. | {"enum": ["branches"]} |
ci.json | items | When a tag is pushed. | {"enum": ["tags"]} |
ci.json | items | When a pipeline has been triggered by a second pipelines API (not triggers API). | {"enum": ["api"]} |
ci.json | items | When using CI services other than Gitlab | {"enum": ["external"]} |
ci.json | items | For multi-project triggers, created using the API with 'CI_JOB_TOKEN'. | {"enum": ["pipelines"]} |
ci.json | items | Pipeline is triggered by a `git push` by the user | {"enum": ["pushes"]} |
ci.json | items | For scheduled pipelines. | {"enum": ["schedules"]} |
ci.json | items | For pipelines created using a trigger token. | {"enum": ["triggers"]} |
ci.json | items | For pipelines created using *Run pipeline* button in Gitlab UI (under your project's *Pipelines*). | {"enum": ["web"]} |
ci.json | items | String or regular expression to match against tag or branch names. | {"type": "string"} |
ci.json | kubernetes | Filter job based on if Kubernetes integration is active. | {"enum": ["active"]} |
ci.json | changes | Filter job creation based on files that were modified in a git push. | {"type": "array", "items": {"type": "string"}} |
ci.json | retry_max | The number of times the job will be retried if it fails. Defaults to 0 and can max be retried 2 times (3 times total). | {"type": "integer", "default": 0, "minimum": 0, "maximum": 2} |
ci.json | retry_errors | Retry on any failure (default). | {"const": "always"} |
ci.json | retry_errors | Retry when the failure reason is unknown. | {"const": "unknown_failure"} |
ci.json | retry_errors | Retry when the script failed. | {"const": "script_failure"} |
ci.json | retry_errors | Retry on API failure. | {"const": "api_failure"} |
ci.json | retry_errors | Retry when the job got stuck or timed out. | {"const": "stuck_or_timeout_failure"} |
ci.json | retry_errors | Retry if there is a runner system failure (for example, job setup failed). | {"const": "runner_system_failure"} |
ci.json | retry_errors | Retry if the runner is unsupported. | {"const": "runner_unsupported"} |
ci.json | retry_errors | Retry if a delayed job could not be executed. | {"const": "stale_schedule"} |
ci.json | retry_errors | Retry if the script exceeded the maximum execution time set for the job. | {"const": "job_execution_timeout"} |
ci.json | retry_errors | Retry if the job is archived and can’t be run. | {"const": "archived_failure"} |
ci.json | retry_errors | Retry if the job failed to complete prerequisite tasks. | {"const": "unmet_prerequisites"} |
ci.json | retry_errors | Retry if the scheduler failed to assign the job to a runner. | {"const": "scheduler_failure"} |
ci.json | retry_errors | Retry if there is a structural integrity problem detected. | {"const": "data_integrity_failure"} |
ci.json | stage | Define what stage the job will run in. | {"anyOf": [{"type": "string", "minLength": 1}, {"type": "array", "minLength": 1, "items": {"type": "string"}}]} |
ci.json | only | Job will run *only* when these filtering options match. | {} |
ci.json | extends | The name of one or more jobs to inherit configuration from. | {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}, "minItems": 1}]} |
ci.json | needs | The list of jobs in previous stages whose sole completion is needed to start the current job. | {"type": "array", "items": {"oneOf": [{"type": "string"}, {"type": "object", "additionalProperties": false, "properties": {"job": {"type": "string"}, "artifacts": {"type": "boolean"}, "optional": {"type": "boolean"}, "parallel": {}}, "required": ["job"]}, {"type": "object", "additionalProperties": false, "properties": {"pipeline": {"type": "string"}, "job": {"type": "string"}, "artifacts": {"type": "boolean"}, "parallel": {}}, "required": ["job", "pipeline"]}, {"type": "object", "additionalProperties": false, "properties": {"job": {"type": "string"}, "project": {"type": "string"}, "ref": {"type": "string"}, "artifacts": {"type": "boolean"}, "parallel": {}}, "required": ["job", "project", "ref"]}]}} |
ci.json | except | Job will run *except* for when these filtering options match. | {} |
ci.json | dependencies | Specify a list of job names from earlier stages from which artifacts should be loaded. By default, all previous artifacts are passed. Use an empty array to skip downloading artifacts. | {"type": "array", "items": {"type": "string"}} |
ci.json | environment | Used to associate environment metadata with a deploy. Environment can have a name and URL attached to it, and will be displayed under /environments under the project. | {"oneOf": [{"type": "string"}, {"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string", "minLength": 1}, "url": {"type": "string", "format": "uri", "pattern": "^(https?://.+|\\$[A-Za-z]+)"}, "on_stop": {"type": "string"}, "action": {"enum": ["start", "prepare", "stop", "verify", "access"], "default": "start"}, "auto_stop_in": {"type": "string"}, "kubernetes": {"type": "object", "properties": {"namespace": {"type": "string", "minLength": 1}}}, "deployment_tier": {"type": "string", "enum": ["production", "staging", "testing", "development", "other"]}}, "required": ["name"]}]} |
ci.json | name | The name of the environment, e.g. 'qa', 'staging', 'production'. | {"type": "string", "minLength": 1} |
ci.json | url | When set, this will expose buttons in various places for the current environment in Gitlab, that will take you to the defined URL. | {"type": "string", "format": "uri", "pattern": "^(https?://.+|\\$[A-Za-z]+)"} |
ci.json | on_stop | The name of a job to execute when the environment is about to be stopped. | {"type": "string"} |
ci.json | action | Specifies what this job will do. 'start' (default) indicates the job will start the deployment. 'prepare'/'verify'/'access' indicates this will not affect the deployment. 'stop' indicates this will stop the deployment. | {"enum": ["start", "prepare", "stop", "verify", "access"], "default": "start"} |
ci.json | auto_stop_in | The amount of time it should take before Gitlab will automatically stop the environment. Supports a wide variety of formats, e.g. '1 week', '3 mins 4 sec', '2 hrs 20 min', '2h20min', '6 mos 1 day', '47 yrs 6 mos and 4d', '3 weeks and 2 days'. | {"type": "string"} |
ci.json | kubernetes | Used to configure the kubernetes deployment for this environment. This is currently not supported for kubernetes clusters that are managed by Gitlab. | {"type": "object", "properties": {"namespace": {"type": "string", "minLength": 1}}} |
ci.json | namespace | The kubernetes namespace where this environment should be deployed to. | {"type": "string", "minLength": 1} |
ci.json | deployment_tier | Explicitly specifies the tier of the deployment environment if non-standard environment name is used. | {"type": "string", "enum": ["production", "staging", "testing", "development", "other"]} |
ci.json | release | Indicates that the job creates a Release. | {"type": "object", "additionalProperties": false, "properties": {"tag_name": {"type": "string", "minLength": 1}, "tag_message": {"type": "string"}, "name": {"type": "string"}, "ref": {"type": "string"}, "milestones": {"type": "array", "items": {"type": "string"}}, "released_at": {"type": "string", "format": "date-time", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:Z|[+-][01]\\d:[0-5]\\d)$"}, "assets": {"type": "object", "additionalProperties": false, "properties": {"links": {"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string", "minLength": 1}, "url": {"type": "string", "minLength": 1}, "filepath": {"type": "string"}, "link_type": {"type": "string", "enum": ["runbook", "package", "image", "other"]}}, "required": ["name", "url"]}, "minItems": 1}}, "required": ["links"]}}, "required": ["tag_name", "description"]} |
ci.json | tag_name | The tag_name must be specified. It can refer to an existing Git tag or can be specified by the user. | {"type": "string", "minLength": 1} |
ci.json | tag_message | Message to use if creating a new annotated tag. | {"type": "string"} |
ci.json | description | Specifies the longer description of the Release. | {"type": "string", "minLength": 1} |
ci.json | name | The Release name. If omitted, it is populated with the value of release: tag_name. | {"type": "string"} |
ci.json | ref | If the release: tag_name doesn’t exist yet, the release is created from ref. ref can be a commit SHA, another tag name, or a branch name. | {"type": "string"} |
ci.json | milestones | The title of each milestone the release is associated with. | {"type": "array", "items": {"type": "string"}} |
ci.json | released_at | The date and time when the release is ready. Defaults to the current date and time if not defined. Should be enclosed in quotes and expressed in ISO 8601 format. | {"type": "string", "format": "date-time", "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:Z|[+-][01]\\d:[0-5]\\d)$"} |
ci.json | links | Include asset links in the release. | {"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string", "minLength": 1}, "url": {"type": "string", "minLength": 1}, "filepath": {"type": "string"}, "link_type": {"type": "string", "enum": ["runbook", "package", "image", "other"]}}, "required": ["name", "url"]}, "minItems": 1} |
ci.json | name | The name of the link. | {"type": "string", "minLength": 1} |
ci.json | url | The URL to download a file. | {"type": "string", "minLength": 1} |
ci.json | filepath | The redirect link to the url. | {"type": "string"} |
ci.json | link_type | The content kind of what users can download via url. | {"type": "string", "enum": ["runbook", "package", "image", "other"]} |
ci.json | coverage | Must be a regular expression, optionally but recommended to be quoted, and must be surrounded with '/'. Example: '/Code coverage: \d+\.\d+/' | {"type": "string", "format": "regex", "pattern": "^/.+/$"} |
ci.json | resource_group | Limit job concurrency. Can be used to ensure that the Runner will not run certain jobs simultaneously. | {"type": "string"} |
ci.json | project | Path to the project, e.g. `group/project`, or `group/sub-group/project`. | {"type": "string", "pattern": "(?:\\S/\\S|\\$\\S+)"} |
ci.json | branch | The branch name that a downstream pipeline will use | {"type": "string"} |
ci.json | strategy | You can mirror the pipeline status from the triggered pipeline to the source bridge job by using strategy: depend | {"type": "string", "enum": ["depend"]} |
ci.json | forward | Specify what to forward to the downstream pipeline. | {"type": "object", "additionalProperties": false, "properties": {"yaml_variables": {"type": "boolean", "default": true}, "pipeline_variables": {"type": "boolean", "default": false}}} |
ci.json | yaml_variables | Variables defined in the trigger job are passed to downstream pipelines. | {"type": "boolean", "default": true} |
ci.json | pipeline_variables | Variables added for manual pipeline runs and scheduled pipelines are passed to downstream pipelines. | {"type": "boolean", "default": false} |
ci.json | trigger | Trigger a child pipeline. [Learn More](https://docs.gitlab.com/ee/ci/pipelines/parent_child_pipelines.html). | {"type": "object", "additionalProperties": false, "properties": {"include": {"oneOf": [{"type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$"}, {"type": "array", "maxItems": 3, "items": {"oneOf": [{"type": "object", "additionalProperties": false, "properties": {"local": {"type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$"}}}, {"type": "object", "additionalProperties": false, "properties": {"template": {"type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$"}}}, {"type": "object", "additionalProperties": false, "properties": {"artifact": {"type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$"}, "job": {"type": "string"}}, "required": ["artifact", "job"]}, {"type": "object", "additionalProperties": false, "properties": {"project": {"type": "string", "pattern": "(?:\\S/\\S|\\$\\S+)"}, "ref": {"minLength": 1, "type": "string"}, "file": {"type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$"}}, "required": ["project", "file"]}]}}]}, "strategy": {"type": "string", "enum": ["depend"]}, "forward": {"type": "object", "additionalProperties": false, "properties": {"yaml_variables": {"type": "boolean", "default": true}, "pipeline_variables": {"type": "boolean", "default": false}}}}} |
ci.json | include | Relative path from local repository root (`/`) to the local YAML file to define the pipeline configuration. | {"type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$"} |
ci.json | include | References a local file or an artifact from another job to define the pipeline configuration. | {"type": "array", "maxItems": 3, "items": {"oneOf": [{"type": "object", "additionalProperties": false, "properties": {"local": {"type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$"}}}, {"type": "object", "additionalProperties": false, "properties": {"template": {"type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$"}}}, {"type": "object", "additionalProperties": false, "properties": {"artifact": {"type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$"}, "job": {"type": "string"}}, "required": ["artifact", "job"]}, {"type": "object", "additionalProperties": false, "properties": {"project": {"type": "string", "pattern": "(?:\\S/\\S|\\$\\S+)"}, "ref": {"minLength": 1, "type": "string"}, "file": {"type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$"}}, "required": ["project", "file"]}]}} |
ci.json | local | Relative path from local repository root (`/`) to the local YAML file to define the pipeline configuration. | {"type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$"} |
ci.json | template | Name of the template YAML file to use in the pipeline configuration. | {"type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$"} |
ci.json | artifact | Relative path to the generated YAML file which is extracted from the artifacts and used as the configuration for triggering the child pipeline. | {"type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$"} |
ci.json | job | Job name which generates the artifact | {"type": "string"} |
ci.json | project | Path to another private project under the same GitLab instance, like `group/project` or `group/sub-group/project`. | {"type": "string", "pattern": "(?:\\S/\\S|\\$\\S+)"} |
ci.json | ref | Branch/Tag/Commit hash for the target project. | {"minLength": 1, "type": "string"} |
ci.json | file | Relative path from repository root (`/`) to the pipeline configuration YAML file. | {"type": "string", "format": "uri-reference", "pattern": "\\.ya?ml$"} |
ci.json | strategy | You can mirror the pipeline status from the triggered pipeline to the source bridge job by using strategy: depend | {"type": "string", "enum": ["depend"]} |
ci.json | forward | Specify what to forward to the downstream pipeline. | {"type": "object", "additionalProperties": false, "properties": {"yaml_variables": {"type": "boolean", "default": true}, "pipeline_variables": {"type": "boolean", "default": false}}} |
ci.json | yaml_variables | Variables defined in the trigger job are passed to downstream pipelines. | {"type": "boolean", "default": true} |
ci.json | pipeline_variables | Variables added for manual pipeline runs and scheduled pipelines are passed to downstream pipelines. | {"type": "boolean", "default": false} |
ci.json | publish | A path to a directory that contains the files to be published with Pages | {"type": "string"} |
mocharc.json | A JSON schema describing a .mocharc.[json|yml|yaml] file | {"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": true, "definitions": {"bool": {"type": "boolean"}, "int": {"type": "integer", "minimum": 0}, "string": {"type": "string"}, "string-array": {"anyOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}}, "properties": {"allow-uncaught": {}, "async-only": {}, "bail": {}, "check-leaks": {}, "delay": {}, "exit": {}, "forbid-only": {}, "forbid-pending": {}, "global": {}, "jobs": {}, "parallel": {}, "retries": {}, "slow": {}, "timeout": {}, "ui": {}, "color": {}, "diff": {}, "full-trace": {}, "growl": {}, "inline-diffs": {}, "reporter": {}, "reporter-option": {}, "config": {}, "package": {}, "extension": {}, "file": {}, "ignore": {}, "recursive": {}, "require": {}, "sort": {}, "watch": {}, "watch-files": {}, "watch-ignore": {}, "fgrep": {}, "grep": {}, "invert": {}, "spec": {}, "enable-source-maps": {}}, "type": "object"} |
|
embrace-config-schema-1.0.0.json | JSON Schema definition for the Embrace configuration file. | {"$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": true, "id": "https://json.schemastore.org/embrace-config-schema-1.0.0.json", "properties": {"app_id": {"type": "string", "maxLength": 5, "minLength": 5}, "api_token": {"type": "string", "maxLength": 32, "minLength": 32}, "ndk_enabled": {"type": "boolean"}, "sdk_config": {"type": "object", "additionalProperties": true, "properties": {"app": {"type": "object", "additionalProperties": true, "properties": {"report_disk_usage": {"type": "boolean"}}, "minProperties": 1}, "crash_handler": {"type": "object", "additionalProperties": true, "properties": {"enabled": {"type": "boolean"}}, "minProperties": 1}, "networking": {"type": "object", "additionalProperties": true, "properties": {"capture_request_content_length": {"type": "boolean"}, "disabled_url_patterns": {"type": "array", "items": {"type": "string"}, "minItems": 1, "uniqueItems": true}, "enable_native_monitoring": {"type": "boolean"}, "trace_id_header": {"type": "string"}}, "minProperties": 1}, "session": {"type": "object", "additionalProperties": true, "properties": {"async_end": {"type": "boolean"}, "max_session_seconds": {"type": "integer"}}, "minProperties": 1}, "startup_moment": {"type": "object", "additionalProperties": true, "properties": {"automatically_end": {"type": "boolean"}, "take_screenshot": {"type": "boolean"}}, "minProperties": 1}, "taps": {"type": "object", "additionalProperties": true, "properties": {"capture_coordinates": {"type": "boolean"}}, "minProperties": 1}, "webview": {"type": "object", "additionalProperties": true, "properties": {"capture_query_params": {"type": "boolean"}, "enable": {"type": "boolean"}}, "minProperties": 1}}, "minProperties": 1}}, "required": ["app_id", "api_token"], "type": "object"} |
|
embrace-config-schema-1.0.0.json | app_id | Your 5 character app ID. | {"type": "string", "maxLength": 5, "minLength": 5} |
embrace-config-schema-1.0.0.json | api_token | Your API 32-hexdigit token. | {"type": "string", "maxLength": 32, "minLength": 32} |
embrace-config-schema-1.0.0.json | ndk_enabled | Enables NDK crash capture. Defaults to false. | {"type": "boolean"} |
embrace-config-schema-1.0.0.json | report_disk_usage | The SDK collects the disk usage for the app. You can disable this if your app has a large number of local files to prevent excessive resource usage, especially on lower-end devices. Defaults to true. | {"type": "boolean"} |
embrace-config-schema-1.0.0.json | enabled | Set to false to prevent the SDK from connecting to the uncaught exception handler. Defaults to true. | {"type": "boolean"} |
embrace-config-schema-1.0.0.json | capture_request_content_length | Disable capture of network length which can interfere with certain streaming network requests. Defaults to true. | {"type": "boolean"} |
embrace-config-schema-1.0.0.json | disabled_url_patterns | Specify one or more regular expressions to exclude network request with URLs matching one of the regular expressions from being captured. | {"type": "array", "items": {"type": "string"}, "minItems": 1, "uniqueItems": true} |
embrace-config-schema-1.0.0.json | enable_native_monitoring | Enable capture of network requests made using the native Java network API. Defaults to true. | {"type": "boolean"} |
embrace-config-schema-1.0.0.json | trace_id_header | Set the name of the header used for the trace ID. Defaults to 'x-emb-trace-id'. | {"type": "string"} |
embrace-config-schema-1.0.0.json | async_end | Send the session end message asynchronously. Defaults to false. | {"type": "boolean"} |
embrace-config-schema-1.0.0.json | max_session_seconds | Enable automatic ending of sessions every N seconds. This is only recommended for applications, such as kiosks, where the app is never expected to go to the background. This value must be 60 seconds or greater if set. | {"type": "integer"} |
embrace-config-schema-1.0.0.json | automatically_end | Control whether the startup moment is automatically ended. Defaults to true. | {"type": "boolean"} |
embrace-config-schema-1.0.0.json | take_screenshot | Control whether screenshots are taken during the startup moment. Defaults to false. | {"type": "boolean"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.