schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
schema-org-place.json
logo
An associated logo.
{"oneOf": [{"type": "object"}, {"type": "string", "format": "uri"}]}
schema-org-place.json
logo
ImageObject
{"type": "object"}
schema-org-place.json
openingHoursSpecification
OpeningHoursSpecification
{"type": "object"}
schema-org-place.json
photo
A photograph of this place. Supersedes photos.
{"anyOf": [{"type": "array", "items": {"type": "object"}}, {"type": "array", "items": {"type": "object"}}]}
schema-org-place.json
items
ImageObject
{"type": "object"}
schema-org-place.json
items
Photograph
{"type": "object"}
schema-org-place.json
review
A review of the item. Supersedes reviews.
{"type": "array", "items": {"type": "object"}}
schema-org-place.json
items
Review
{"type": "object"}
schema-org-place.json
smokingAllowed
Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room.
{"type": "boolean"}
schema-org-place.json
specialOpeningHoursSpecification
The special opening hours of a certain place. Use this to explicitly override general opening hours brought in scope by openingHoursSpecification or openingHours.
{"type": "array", "items": {"type": "object"}}
schema-org-place.json
items
OpeningHoursSpecification
{"type": "object"}
schema-org-place.json
telephone
The telephone number.
{"type": "string"}
img-catapult-psp-1.0.0.json
Used to validate Catapult Platform Support Pack (PSP) contents.yaml file, which provides an index of the files within the PSP
{"$defs": {"supportPackFile": {"type": "object", "additionalProperties": false, "required": ["builtin", "path"], "properties": {"builtin": {"type": "boolean"}, "path": {"type": "string"}}}, "supportPackDirectory": {"type": "object", "additionalProperties": false, "required": ["path"], "properties": {"path": {"type": "string"}}}}, "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "properties": {"platform": {"type": "object", "additionalProperties": false, "required": ["vendor", "name", "description", "buildConfig", "version", "license", "documentationFile", "coreDescriptionFile", "launchConfig"], "properties": {"vendor": {"type": "string"}, "name": {"type": "string", "maxLength": 30}, "buildConfig": {"type": "string", "pattern": "^([A-Z]|[0-9]|_)+$"}, "version": {"type": "string"}, "license": {"type": "string"}, "documentationFile": {}, "coreDescriptionFile": {}, "peripheralRegisterDescriptionFile": {}, "openOCDConfigurationFile": {}, "launchConfig": {"type": "string", "pattern": "^(Alpine Model|Catapult Model|OpenOCD|Whisper|RemoteLinux)$"}, "gdbAutoRunCommandString": {"type": "string"}, "networkPortNumberForOCDConnections": {"type": "string"}, "isPlatformFPGA": {"type": "boolean"}, "fpgaBitFile": {}, "fpgaProgConfigFile": {}, "traceSettingsString": {"type": "string"}, "libsDirectory": {}, "headersDirectory": {}, "remoteHost": {"type": "string"}, "remoteUsername": {"type": "string"}}}}, "required": ["platform"], "type": "object"}
img-catapult-psp-1.0.0.json
supportPackFile
File within support pack
{"type": "object", "additionalProperties": false, "required": ["builtin", "path"], "properties": {"builtin": {"type": "boolean"}, "path": {"type": "string"}}}
img-catapult-psp-1.0.0.json
builtin
builtin="true" means that a file path is relative to the platform directory within the SDK installation.builtin="false" means the file path is relative to the top level of the unzipped package
{"type": "boolean"}
img-catapult-psp-1.0.0.json
path
file path within zip file
{"type": "string"}
img-catapult-psp-1.0.0.json
supportPackDirectory
Directory within support pack
{"type": "object", "additionalProperties": false, "required": ["path"], "properties": {"path": {"type": "string"}}}
img-catapult-psp-1.0.0.json
path
directory path within zip file
{"type": "string"}
img-catapult-psp-1.0.0.json
platform
Catapult platform support file contents
{"type": "object", "additionalProperties": false, "required": ["vendor", "name", "description", "buildConfig", "version", "license", "documentationFile", "coreDescriptionFile", "launchConfig"], "properties": {"vendor": {"type": "string"}, "name": {"type": "string", "maxLength": 30}, "buildConfig": {"type": "string", "pattern": "^([A-Z]|[0-9]|_)+$"}, "version": {"type": "string"}, "license": {"type": "string"}, "documentationFile": {}, "coreDescriptionFile": {}, "peripheralRegisterDescriptionFile": {}, "openOCDConfigurationFile": {}, "launchConfig": {"type": "string", "pattern": "^(Alpine Model|Catapult Model|OpenOCD|Whisper|RemoteLinux)$"}, "gdbAutoRunCommandString": {"type": "string"}, "networkPortNumberForOCDConnections": {"type": "string"}, "isPlatformFPGA": {"type": "boolean"}, "fpgaBitFile": {}, "fpgaProgConfigFile": {}, "traceSettingsString": {"type": "string"}, "libsDirectory": {}, "headersDirectory": {}, "remoteHost": {"type": "string"}, "remoteUsername": {"type": "string"}}}
img-catapult-psp-1.0.0.json
vendor
Platform/device vendor name
{"type": "string"}
img-catapult-psp-1.0.0.json
name
Name of platform - used to identify platform in IDE
{"type": "string", "maxLength": 30}
img-catapult-psp-1.0.0.json
description
Full description of support pack
{"type": "string"}
img-catapult-psp-1.0.0.json
buildConfig
Value of the PLATFORM macro definition used during build
{"type": "string", "pattern": "^([A-Z]|[0-9]|_)+$"}
img-catapult-psp-1.0.0.json
version
Support pack version
{"type": "string"}
img-catapult-psp-1.0.0.json
license
License text
{"type": "string"}
img-catapult-psp-1.0.0.json
documentationFile
Documentation file(s) - can be HTML or PDF
{}
img-catapult-psp-1.0.0.json
coreDescriptionFile
File containing description of core using IMG proprietary YAML format
{}
img-catapult-psp-1.0.0.json
peripheralRegisterDescriptionFile
File containing peripheral register information using CMSIS SVD XML format (see https://www.keil.com/pack/doc/CMSIS/SVD/html/svd_Format_pg.html)
{}
img-catapult-psp-1.0.0.json
openOCDConfigurationFile
File containing OpenOCD configuration (see https://openocd.org/doc-release/html/Config-File-Guidelines.html#Config-File-Guidelines)
{}
img-catapult-psp-1.0.0.json
launchConfig
Launch configuration for platform
{"type": "string", "pattern": "^(Alpine Model|Catapult Model|OpenOCD|Whisper|RemoteLinux)$"}
img-catapult-psp-1.0.0.json
gdbAutoRunCommandString
String with additional gdb commands to run to initiate connection to target
{"type": "string"}
img-catapult-psp-1.0.0.json
networkPortNumberForOCDConnections
TCP/IP port number for OpenOCD connections. Set to "auto" to automatically use any free port
{"type": "string"}
img-catapult-psp-1.0.0.json
isPlatformFPGA
True only for FPGA platforms
{"type": "boolean"}
img-catapult-psp-1.0.0.json
fpgaBitFile
Bitfile for programming FPGA
{}
img-catapult-psp-1.0.0.json
fpgaProgConfigFile
OpenOCD config file for programming FPGA
{}
img-catapult-psp-1.0.0.json
traceSettingsString
String with processor trace encoder settings required by the decoder
{"type": "string"}
img-catapult-psp-1.0.0.json
libsDirectory
Directory containing library files for use with the platform
{}
img-catapult-psp-1.0.0.json
headersDirectory
Directory containing header files for use with the platform
{}
img-catapult-psp-1.0.0.json
remoteHost
Hostname or IP address for debug connection to remote machines
{"type": "string"}
img-catapult-psp-1.0.0.json
remoteUsername
Username for debug connection to remote machines
{"type": "string"}
clasp.json
scriptId
An ID of the current Google Apps Script project https://github.com/google/clasp#scriptid-required
{"type": "string", "minLength": 57, "maxLength": 57}
clasp.json
rootDir
A root directory path of the current Google Apps Script project https://github.com/google/clasp#rootdir-optional
{}
clasp.json
projectId
An ID for a Google Cloud Platform project linked to the current Google Apps Script project https://github.com/google/clasp#projectid-optional
{"default": "project-id-xxxxxxxxxxxxxxxxxxx", "type": "string", "minLength": 4, "maxLength": 30}
clasp.json
fileExtension
An extension for local files of the current Google Apps Script project https://github.com/google/clasp#filepushorder-optional
{"type": "string", "minLength": 1}
clasp.json
filePushOrder
Files pushed first of the current Google Apps Script project https://github.com/google/clasp#filepushorder-optional
{"type": "array", "uniqueItems": true, "items": {}}
clasp.json
items
A file https://github.com/google/clasp#filepushorder-optional
{}
configSchema.json
project_name
The name of your project. Used to label any images built.
{"type": "string", "minLength": 1}
configSchema.json
forbid_telemetry
Forbid reporting telemetry information for this project, even if the user has previously consented to telemetry.
{"type": "boolean"}
configSchema.json
containers
Definitions for each of the containers that make up your various environments
{"type": "object", "additionalProperties": {}}
configSchema.json
image
Image name (in standard Docker image reference format) to use for this container
{"type": "string", "minLength": 1}
configSchema.json
build_directory
Path (relative to the configuration file's directory) to a directory containing a Dockerfile to build and use as an image for this container
{"type": "string", "minLength": 1}
configSchema.json
build_args
List of build args to use when building the image in build_directory
{}
configSchema.json
build_target
Dockerfile stage name to build and use for this container
{"type": "string", "minLength": 1}
configSchema.json
build_ssh
List of SSH agents to forward to the image build process when building the image in build_directory
{}
configSchema.json
build_secrets
Secrets to expose to the image build process when building the image in build_directory
{}
configSchema.json
dockerfile
Dockerfile (relative to build_directory) to use when building the image. Defaults to Dockerfile if not set.
{"type": "string", "minLength": 1}
configSchema.json
command
Command to run when the container starts
{"type": "string", "minLength": 1}
configSchema.json
entrypoint
Entrypoint to use to run the command
{"type": "string", "minLength": 1}
configSchema.json
environment
List of environment variables for the container
{}
configSchema.json
working_directory
Working directory to start the container in
{"type": "string", "minLength": 1}
configSchema.json
volumes
List of volume mounts to create for the container
{}
configSchema.json
ports
List of ports to make available to the host machine
{}
configSchema.json
dependencies
List of other containers that should be started and healthy before starting this container
{}
configSchema.json
health_check
Overrides health check configuration specified in the image or Dockerfile
{}
configSchema.json
privileged
Enable privileged mode for the container
{"type": "boolean"}
configSchema.json
enable_init_process
Set to `true` to run an init process inside the container that forwards signals and reaps processes
{"type": "boolean"}
configSchema.json
capabilities_to_add
List of additional capabilities to add to the container
{}
configSchema.json
capabilities_to_drop
List of additional capabilities to remove from the container
{}
configSchema.json
additional_hostnames
Hostnames to associate with this container in addition to the default hostname
{}
configSchema.json
additional_hosts
Additional hostnames to add to /etc/hosts in the container
{"type": "object", "additionalProperties": {"type": "string"}}
configSchema.json
setup_commands
Commands to run after the container reports as healthy but before dependency containers start
{}
configSchema.json
log_driver
Docker log driver to use
{"type": "string"}
configSchema.json
log_options
Additional options to pass to Docker log driver
{"type": "object", "additionalProperties": {"type": "string"}}
configSchema.json
image_pull_policy
Whether or not to pull image (including base image for containers that use a built image), even if it has already been pulled
{"type": "string", "enum": ["Always", "IfNotPresent"]}
configSchema.json
shm_size
Size of /dev/shm (shared memory for IPC) for the container
{"type": "string", "pattern": "^\\d+\\s*[mkg]?b?$"}
configSchema.json
labels
Labels to apply to the container
{"type": "object", "additionalProperties": {"type": "string"}}
configSchema.json
tasks
Definitions for each of your tasks, the actions you launch through Batect
{"type": "object", "additionalProperties": {}}
configSchema.json
task
Definition of a single task
{"type": "object", "additionalProperties": false, "properties": {"run": {}, "group": {"type": "string", "minLength": 1}, "dependencies": {}, "prerequisites": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "customise": {"type": "object", "additionalProperties": {}}}, "anyOf": [{"required": ["run"]}, {"required": ["prerequisites"], "not": {"required": ["dependencies", "run"]}}]}
configSchema.json
description
Description shown when running `batect --list-tasks`
{"type": "string", "minLength": 1}
configSchema.json
group
Name used to group tasks when running `batect --list-tasks`
{"type": "string", "minLength": 1}
configSchema.json
dependencies
List of other containers that should be started and healthy before starting the task container given in `run`
{}
configSchema.json
prerequisites
List of other tasks that should be run before running this task
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
configSchema.json
customise
Customisations for dependency containers run as part of this task
{"type": "object", "additionalProperties": {}}
configSchema.json
taskRunOptions
Specifies what to do when this task starts
{"type": "object", "additionalProperties": false, "properties": {"container": {"type": "string", "minLength": 1}, "command": {"type": "string", "minLength": 1}, "entrypoint": {"type": "string", "minLength": 1}, "environment": {}, "ports": {}, "working_directory": {"type": "string", "minLength": 1}}, "required": ["container"]}
configSchema.json
container
Container to run for this task
{"type": "string", "minLength": 1}
configSchema.json
command
Command to run for this task
{"type": "string", "minLength": 1}
configSchema.json
entrypoint
Entrypoint to use to run the command for this task
{"type": "string", "minLength": 1}
configSchema.json
environment
List of environment variables to pass to the container, in addition to those defined on the container itself
{}
configSchema.json
ports
List of port mappings to create for the container, in addition to those defined on the container itself
{}
configSchema.json
working_directory
Working directory to start the container in
{"type": "string", "minLength": 1}
configSchema.json
environment
List of environment variables to pass to the container, in addition to those defined on the container itself
{}
configSchema.json
ports
List of port mappings to create for the container, in addition to those defined on the container itself
{}
configSchema.json
working_directory
Working directory to start the container in
{"type": "string", "minLength": 1}
configSchema.json
id
ID used to refer to agent from Dockerfile
{"type": "string", "minimum": 1}
configSchema.json
paths
Paths to keys or SSH agent sockets to expose to image build process
{"type": "array", "items": {"type": "string"}}
configSchema.json
environment
Name of the environment variable to expose as a secret
{"type": "string", "minLength": 1}
configSchema.json
path
Path to the file to expose as a secret
{"type": "string", "minLength": 1}
configSchema.json
local
Port on the host machine to map
{"type": "integer", "minimum": 1}
configSchema.json
container
Port inside the container to map
{"type": "integer", "minimum": 1}
configSchema.json
protocol
Protocol to use (eg. TCP or UDP)
{"type": "string", "minLength": 1}