Datasets:
dataunitylab
/
json-schema-descriptions

Dataset card Data Studio Files Community
1
schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
cryproj.52.schema.json
path
Required plugin's name
{"type": "string", "examples": ["CryDefaultEntities", "CrySensorSystem", "CryPerceptionSystem", "CryUserAnalytics", "CryOSVR", "CryOculusVR", "CryOpenVR", "CryLobby"]}
cryproj.52.schema.json
type
EPluginType::Native if it's a C++ plugin, EPluginType::Managed if it's a C# one
{"type": "string", "default": "", "examples": ["EPluginType::Native", "EPluginType::Managed"], "enum": ["EPluginType::Native", "EPluginType::Managed"]}
cryproj.52.schema.json
value
Arguments that has to be passed to the command. Leave empty if it has not parameters
{"type": "string", "default": ""}
bitbucket-pipelines.schema.json
image_name
Name of the Docker image which may or may not include registry URL, tag, and digest value
{"type": "string", "default": "atlassian/default-image:latest", "minLength": 1}
bitbucket-pipelines.schema.json
run_as_user
Overrides image's default user, specified user UID must be an existing user in the image with a valid home directory
{"type": "number"}
bitbucket-pipelines.schema.json
username
Username to use to fetch the Docker image
{"type": "string", "minLength": 1}
bitbucket-pipelines.schema.json
password
Password to use to fetch the Docker image
{"type": "string", "minLength": 1}
bitbucket-pipelines.schema.json
email
Email to use to fetch the Docker image
{"type": "string", "minLength": 1}
bitbucket-pipelines.schema.json
access-key
AWS access key for Amazon Elastic Container Registry (AWS ECR)
{"type": "string", "minLength": 1}
bitbucket-pipelines.schema.json
secret-key
AWS secret key for Amazon Elastic Container Registry (AWS ECR)
{"type": "string", "minLength": 1}
bitbucket-pipelines.schema.json
oidc-role
Provides Pipeline with access to private Docker images hosted in an Amazon Elastic Container Registry (AWS ECR)
{"type": "string", "minLength": 1}
bitbucket-pipelines.schema.json
max_time
Maximum amount of minutes a step can execute
{"type": "number", "exclusiveMinimum": 0, "maximum": 120, "default": 120}
bitbucket-pipelines.schema.json
size
Multiplier of the resources allocated to a pipeline step
{"type": "string", "enum": ["1x", "2x"], "default": "1x"}
bitbucket-pipelines.schema.json
clone_properties
Contains settings to clone the repository into a container
{"type": "object", "properties": {"enabled": {"type": "boolean", "default": true}, "lfs": {"type": "boolean", "default": false}, "depth": {"oneOf": [{"type": "number", "exclusiveMinimum": 0}, {"const": "full"}], "default": 50}, "skip-ssl-verify": {"type": "boolean", "default": false}}}
bitbucket-pipelines.schema.json
enabled
Enables cloning of the repository before a step in a pipeline
{"type": "boolean", "default": true}
bitbucket-pipelines.schema.json
lfs
Enables the download of LFS files in the clone (supported only for Git repositories)
{"type": "boolean", "default": false}
bitbucket-pipelines.schema.json
depth
Depth of Git clone (supported only for Git repositories)
{"oneOf": [{"type": "number", "exclusiveMinimum": 0}, {"const": "full"}], "default": 50}
bitbucket-pipelines.schema.json
skip-ssl-verify
Disables SSL verification during git clone, allowing the use of self-signed certificates
{"type": "boolean", "default": false}
bitbucket-pipelines.schema.json
artifact_list
Files produced by a step to share with a following step
{"type": "array", "items": {"type": "string"}, "minItems": 1}
bitbucket-pipelines.schema.json
items
Glob pattern for the path to the artifacts
{"type": "string"}
bitbucket-pipelines.schema.json
download
Enables downloading of all available artifacts at the start of a step
{"type": "boolean", "default": true}
bitbucket-pipelines.schema.json
runner_label
Any label assigned to a self-hosted repository or workspace Pipeline runner
{"type": "string", "minLength": 1, "maxLength": 50}
bitbucket-pipelines.schema.json
changesets
Condition on the changesets involved in a pipeline
{"type": "object", "properties": {"includePaths": {"type": "array", "items": {"type": "string", "minLength": 1}, "minItems": 1}}, "required": ["includePaths"], "additionalProperties": false}
bitbucket-pipelines.schema.json
includePaths
Condition which holds only if any of the modified files match any of the defined patterns
{"type": "array", "items": {"type": "string", "minLength": 1}, "minItems": 1}
bitbucket-pipelines.schema.json
items
Glob pattern to match the file path
{"type": "string", "minLength": 1}
bitbucket-pipelines.schema.json
step
Build execution unit
{"type": "object", "properties": {"after-script": {}, "artifacts": {"anyOf": [{}, {}]}, "caches": {"type": "array", "items": {"type": "string"}, "minItems": 1}, "clone": {}, "condition": {}, "deployment": {"type": "string", "minLength": 1}, "fail-fast": {}, "image": {}, "max-time": {}, "name": {"type": "string", "minLength": 1}, "oidc": {"type": "boolean"}, "runs-on": {"oneOf": [{}, {"type": "array", "items": {}, "minItems": 1}]}, "script": {}, "services": {"type": "array", "items": {"type": "string"}, "minItems": 1, "maxItems": 5}, "size": {}, "trigger": {}}, "required": ["script"]}
bitbucket-pipelines.schema.json
after-script
Commands to execute after the step succeeds or fails
{}
bitbucket-pipelines.schema.json
caches
Caches enabled for the step
{"type": "array", "items": {"type": "string"}, "minItems": 1}
bitbucket-pipelines.schema.json
items
Name of the cache
{"type": "string"}
bitbucket-pipelines.schema.json
condition
Condition to execute the step
{}
bitbucket-pipelines.schema.json
deployment
Type of environment for the deployment step, used in the Deployments dashboard
{"type": "string", "minLength": 1}
bitbucket-pipelines.schema.json
fail-fast
A flag reflecting whether other steps in a parallel group should be force stopped if this step fails
{}
bitbucket-pipelines.schema.json
name
Name of the step
{"type": "string", "minLength": 1}
bitbucket-pipelines.schema.json
oidc
Enable the use of OpenID Connect to connect a pipeline step to a resource server
{"type": "boolean"}
bitbucket-pipelines.schema.json
runs-on
List of labels assigned to Pipeline runner
{"type": "array", "items": {}, "minItems": 1}
bitbucket-pipelines.schema.json
script
Commands to execute in the step
{}
bitbucket-pipelines.schema.json
services
Services enabled for the step
{"type": "array", "items": {"type": "string"}, "minItems": 1, "maxItems": 5}
bitbucket-pipelines.schema.json
items
Name of the service
{"type": "string"}
bitbucket-pipelines.schema.json
trigger
Specifies if a step runs automatically or only when manually triggered by a user
{}
bitbucket-pipelines.schema.json
condition
Condition to execute the stage
{}
bitbucket-pipelines.schema.json
deployment
Type of environment for the deployment stage, used in the Deployments dashboard
{"type": "string", "minLength": 1}
bitbucket-pipelines.schema.json
name
Name of the stage
{"type": "string", "minLength": 1}
bitbucket-pipelines.schema.json
steps
List of steps in a stage
{"type": "array", "items": {}, "minItems": 1}
bitbucket-pipelines.schema.json
trigger
Specifies if the stage runs automatically or only when manually triggered by a user
{}
bitbucket-pipelines.schema.json
parallel_steps
Set of steps to run concurrently
{"type": "array", "items": {}, "minItems": 2}
bitbucket-pipelines.schema.json
fail-fast
A flag reflecting whether all steps in a parallel group should be force stopped if any of its steps fails.
{}
bitbucket-pipelines.schema.json
items
Command to execute
{"type": "string"}
bitbucket-pipelines.schema.json
pipe
Pipe to execute
{"type": "object", "properties": {"pipe": {"type": "string"}, "variables": {"type": "object", "patternProperties": {"^.*$": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}, "minItems": 1}]}}, "minProperties": 1}}, "required": ["pipe"]}
bitbucket-pipelines.schema.json
pipe
Pipe identifier
{"type": "string"}
bitbucket-pipelines.schema.json
variables
Environment variables passed to the pipe
{"type": "object", "patternProperties": {"^.*$": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}, "minItems": 1}]}}, "minProperties": 1}
bitbucket-pipelines.schema.json
^.*$
Variable value
{"type": "string"}
bitbucket-pipelines.schema.json
items
Array variable item value
{"type": "string"}
bitbucket-pipelines.schema.json
cache_path
Path to the directory to be cached, can be absolute or relative to the clone directory
{"type": "string"}
bitbucket-pipelines.schema.json
cache_with_key
Cache definition declaring a set of files as a key and path to the directory to be cached
{"type": "object", "properties": {"key": {"type": "object", "properties": {"files": {"type": "array", "items": {"type": "string"}, "minItems": 1}}, "required": ["files"], "additionalProperties": false}, "path": {}}, "required": ["key", "path"], "additionalProperties": false}
bitbucket-pipelines.schema.json
key
Cache key definition
{"type": "object", "properties": {"files": {"type": "array", "items": {"type": "string"}, "minItems": 1}}, "required": ["files"], "additionalProperties": false}
bitbucket-pipelines.schema.json
items
Path to a file or glob pattern of files in the repository which form the cache key
{"type": "string"}
bitbucket-pipelines.schema.json
definitions
Defines resources used elsewhere in the pipeline configuration
{"type": "object", "properties": {"caches": {"type": "object", "patternProperties": {"^[a-z0-9]([-a-z0-9]{0,48}[a-z0-9])?$": {"oneOf": [{}, {}]}}, "not": {"required": ["docker"]}, "additionalProperties": false}, "services": {"type": "object", "patternProperties": {"^.*$": {"type": "object", "properties": {"image": {}, "memory": {"type": "number", "minimum": 128, "default": 1024}, "variables": {"type": "object", "patternProperties": {"^.*$": {"type": "string"}}, "minProperties": 1}}}}, "additionalProperties": false}}}
bitbucket-pipelines.schema.json
caches
Defines custom caches to be used by pipelines
{"type": "object", "patternProperties": {"^[a-z0-9]([-a-z0-9]{0,48}[a-z0-9])?$": {"oneOf": [{}, {}]}}, "not": {"required": ["docker"]}, "additionalProperties": false}
bitbucket-pipelines.schema.json
services
Defines services that run in separate Docker containers
{"type": "object", "patternProperties": {"^.*$": {"type": "object", "properties": {"image": {}, "memory": {"type": "number", "minimum": 128, "default": 1024}, "variables": {"type": "object", "patternProperties": {"^.*$": {"type": "string"}}, "minProperties": 1}}}}, "additionalProperties": false}
bitbucket-pipelines.schema.json
memory
Memory limit for the service container, in megabytes
{"type": "number", "minimum": 128, "default": 1024}
bitbucket-pipelines.schema.json
variables
Environment variables passed to the service container
{"type": "object", "patternProperties": {"^.*$": {"type": "string"}}, "minProperties": 1}
bitbucket-pipelines.schema.json
docker
A flag to add Docker to all build steps in all pipelines
{"type": "boolean"}
bitbucket-pipelines.schema.json
branches
Branch-specific build pipelines
{}
bitbucket-pipelines.schema.json
custom
Pipelines that can only be triggered manually or scheduled from the Bitbucket Cloud interface
{"type": "object", "patternProperties": {"^.*$": {"type": "array", "items": {"oneOf": [{"type": "object", "properties": {"variables": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string", "minLength": 1}, "default": {"type": "string"}, "allowed-values": {"type": "array", "items": {"type": "string"}, "minItems": 1}}, "required": ["name"], "additionalProperties": false}, "minItems": 1}}, "additionalProperties": false}, {}]}, "minItems": 1}}}
bitbucket-pipelines.schema.json
variables
List of variables for the custom pipeline
{"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string", "minLength": 1}, "default": {"type": "string"}, "allowed-values": {"type": "array", "items": {"type": "string"}, "minItems": 1}}, "required": ["name"], "additionalProperties": false}, "minItems": 1}
bitbucket-pipelines.schema.json
name
Name of a variable for the custom pipeline
{"type": "string", "minLength": 1}
bitbucket-pipelines.schema.json
default
Default value for the variable, used unless the value is manually set when the pipeline is run
{"type": "string"}
bitbucket-pipelines.schema.json
allowed-values
A list of values that are allowed for the variable
{"type": "array", "items": {"type": "string"}, "minItems": 1}
bitbucket-pipelines.schema.json
items
Allowed value for the variable
{"type": "string"}
bitbucket-pipelines.schema.json
description
Description of the variable
{"type": "string", "minLength": 1}
bitbucket-pipelines.schema.json
pull-requests
Pull-request-specific build pipelines
{}
bitbucket-pipelines.schema.json
tags
Tag-specific build pipelines
{}
bettercodehub.json
Configuration file for Better Code Hub to override the default configuration.
{"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": {"supportedProgrammingLanguage": {"type": "string", "enum": ["csharp", "cpp", "go", "groovy", "java", "javascript", "objectivec", "perl", "php", "python", "ruby", "scala", "script", "solidity", "swift", "typescript", "kotlin"]}, "excludeFileFilter": {"type": "array", "items": {"type": "string"}}, "fileFilter": {"type": "object", "additionalProperties": false, "properties": {"include": {"type": "array", "items": {"type": "string"}}, "exclude": {}}}}, "properties": {"component_depth": {"type": "integer", "default": 1}, "languages": {"type": "array", "items": {"anyOf": [{}, {"type": "object", "additionalProperties": false, "properties": {"name": {}, "production": {}, "test": {}}}]}}, "exclude": {}}, "type": "object"}
bettercodehub.json
items
A regular expression for the path(s) to exclude.
{"type": "string"}
bettercodehub.json
items
A regular expression for the path(s) to include.
{"type": "string"}
netlify.json
Config file for Netlify CMS
{"$schema": "http://json-schema.org/draft-07/schema#", "definitions": {"collectionItems": {"properties": {"fields": {}, "label": {"type": "string"}, "label_singular": {}, "folder": {"type": "string"}, "files": {}, "path": {"type": "string"}, "format": {"type": "string", "enum": ["yml", "yaml", "toml", "json", "frontmatter", "yaml-frontmatter", "toml-frontmatter", "json-frontmatter"]}, "slug": {"type": "string"}, "create": {"type": "boolean", "default": false}, "hide": {"type": "boolean", "default": false}, "delete": {"type": "boolean", "default": true}, "name": {"type": "string"}, "filter": {}, "extension": {"type": "string"}}, "required": ["name"], "oneOf": [{"required": ["files"]}, {"required": ["folder"]}]}, "fields": {"type": "array", "items": {"properties": {"name": {"type": "string"}, "label": {"type": "string"}, "widget": {}, "default": {}, "required": {"type": "boolean", "default": true}, "pattern": {"type": "array"}, "fields": {}}, "required": ["name"]}}, "widget": {"properties": {"required": {"type": "boolean"}, "hint": {"type": "string"}, "pattern": {"type": "array"}}}, "files": {"type": "array", "items": {"properties": {"name": {"type": "string"}, "label": {"type": "string"}, "file": {"type": "string"}, "fields": {}}}}}, "dependencies": {}, "properties": {"backend": {"type": "object"}, "local_backend": {"type": "boolean"}, "publish_mode": {}, "media_folder": {"type": "string"}, "public_folder": {"type": "string"}, "media_library": {"type": "object", "properties": {"name": {"type": "string"}, "config": {"type": "object"}}, "required": ["name"]}, "site_url": {"type": "string"}, "display_url": {"type": "string"}, "logo_url": {"type": "string"}, "locale": {"type": "string", "default": "en"}, "show_preview_links": {"type": "boolean"}, "slug": {"type": "object", "properties": {"encoding": {"enum": ["unicode", "ascii"], "default": "unicode"}, "clean_accents": {"type": "boolean"}, "sanitize_replacement": {"type": "string"}}}, "collections": {"type": "array", "items": {}}, "editor": {"type": "object", "properties": {"preview": {"type": "boolean", "default": true}}}, "summary": {"type": "string"}, "sortableFields": {"type": "array"}, "view_filters": {"type": "array"}}, "required": ["backend", "media_folder", "collections"], "type": "object"}
netlify.json
label
label for the collection in the editor UI; defaults to the value of name
{"type": "string"}
netlify.json
label_singular
singular label for certain elements in the editor; defaults to the value of label
{}
netlify.json
folder
Folder collections represent one or more files with the same format, fields, and configuration options, all stored within the same folder in the repository. Note: Folder collections must have at least one field with the name title for creating new entry slugs. That field should use the default string widget. The label for the field can be any string value. If you wish to use a different field as your identifier, set identifier_field to the field name. See the Collections reference doc for details on how collections and fields are configured. If you forget to add this field, you will get an error that your collection "must have a field that is a valid entry identifier".
{"type": "string"}
netlify.json
path
Path
{"type": "string"}
netlify.json
format
determines how collection files are parsed and saved. It will be inferred if the extension field or existing collection file extensions match one of the supported extensions.
{"type": "string", "enum": ["yml", "yaml", "toml", "json", "frontmatter", "yaml-frontmatter", "toml-frontmatter", "json-frontmatter"]}
netlify.json
slug
For folder collections where users can create new items, the slug option specifies a template for generating new filenames based on a file's creation date and title field. (This means that all collections with create: true must have a title field (a different field can be used via identifier_field)). Any field can be referenced by wrapping the field name in double curly braces, eg. {{author}} {{slug}}: a url-safe version of the title field (or identifier field) for the file {{year}}: 4-digit year of the file creation date {{month}}: 2-digit month of the file creation date {{day}}: 2-digit day of the month of the file creation date {{hour}}: 2-digit hour of the file creation date {{minute}}: 2-digit minute of the file creation date {{second}}: 2-digit second of the file creation date
{"type": "string"}
netlify.json
create
for folder collections only; allows users to create new items in the collection
{"type": "boolean", "default": false}
netlify.json
hide
hides a collection in the CMS UI; defaults to false. Useful when using the relation widget to hide referenced collections.
{"type": "boolean", "default": false}
netlify.json
delete
prevents users from deleting items in a collection; defaults to true
{"type": "boolean", "default": true}
netlify.json
name
unique identifier for the collection, used as the key when referenced in other contexts
{"type": "string"}
netlify.json
filter
optional filter for folder collections
{}
netlify.json
description
optional text, displayed below the label when viewing a collection
{"type": "string"}
netlify.json
extension
the file extension searched for when finding existing entries in a folder collection and it determines the file extension used to save new collection items
{"type": "string"}
netlify.json
fields
The fields option maps editor UI widgets to field-value pairs in the saved file. The order of the fields in your Netlify CMS config.yml file determines their order in the editor UI and in the saved file.
{"type": "array", "items": {"properties": {"name": {"type": "string"}, "label": {"type": "string"}, "widget": {}, "default": {}, "required": {"type": "boolean", "default": true}, "pattern": {"type": "array"}, "fields": {}}, "required": ["name"]}}
netlify.json
name
unique identifier for the field, used as the key when referenced in other contexts (like the relation widget)
{"type": "string"}
netlify.json
label
label for the field in the editor UI; defaults to the value of name
{"type": "string"}
netlify.json
default
specify a default value for a field; available for most widget types. Please note that field default value only works for folder collection type.
{}
netlify.json
required
makes a field required; defaults to true
{"type": "boolean", "default": true}
netlify.json
pattern
add field validation by specifying a list with a regex pattern and an error message (first entry in array is regex pattern, second is the error message)
{"type": "array"}
netlify.json
required
Defaults to True
{"type": "boolean"}
netlify.json
hint
optionally add helper text directly below a widget.
{"type": "string"}
netlify.json
pattern
add field validation by specifying a list with a regex pattern and an error message; more extensive validation can be achieved with custom widgets
{"type": "array"}
netlify.json
name
unique identifier for the file
{"type": "string"}
netlify.json
label
file label
{"type": "string"}