schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
bowerrc.json
postinstall
A script to run after install
{"type": "string"}
bowerrc.json
preuninstall
A script to run before uninstall
{"type": "string"}
bowerrc.json
ignoredDependencies
Bower will ignore these dependencies when resolving packages
{"type": "array", "items": {"type": "string"}}
first-timers.json
A bot that helps onboarding new open-source contributors.
{"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "properties": {"labels": {"type": "array", "items": {"type": "string"}}, "template": {"type": "string"}, "repository": {"type": "string"}}, "type": "object"}
first-timers.json
labels
Sets the labels if "first-timers-only" is not what you are looking for.
{"type": "array", "items": {"type": "string"}}
first-timers.json
template
The path to your template, relative from the repository root.
{"type": "string"}
first-timers.json
repository
Specify a different repository than where the problem is. The bot must be installed on the configured repository.
{"type": "string"}
tye-schema.json
Configuration file schema for Tye.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {"name": {"type": "string"}, "registry": {"type": "string"}, "containerEngine": {"type": "string", "enum": ["docker", "podman"]}, "namespace": {"type": "string"}, "network": {"type": "string"}, "dashboardPort": {"type": "integer"}, "ingress": {"type": "array", "minItems": 1, "items": {}}, "extensions": {"type": "array", "items": {}}, "solution": {"type": "string"}, "services": {"type": "array", "minItems": 1, "items": {"type": "object", "oneOf": [{}, {}, {}, {}, {}, {}, {}, {}]}}}, "required": ["services"], "definitions": {"binding": {"type": "object", "properties": {"name": {"type": "string"}, "port": {"type": "integer"}, "containerPort": {"type": "integer"}, "host": {"type": "string"}, "protocol": {"type": "string"}, "autoAssignPort": {"type": "boolean", "default": false}, "connectionString": {"type": "string"}}, "additionalProperties": false}, "env-var": {"type": "object", "properties": {"name": {"type": "string"}, "value": {"type": "string"}}, "required": ["name", "value"], "additionalProperties": false}, "build-property": {"type": "object", "properties": {"name": {"type": "string"}, "value": {"type": "string"}}, "required": ["name", "value"], "additionalProperties": false}, "volume": {"type": "object", "properties": {"name": {"type": "string"}, "source": {"type": "string"}, "target": {"type": "string"}}, "required": ["target"], "additionalProperties": false}, "azureFunction": {"type": "object", "properties": {"name": {"type": "string"}, "azureFunction": {"type": "string"}, "env": {"type": "array", "items": {}}, "args": {"type": "string"}, "replicas": {"type": "integer"}, "bindings": {"type": "array", "items": {}}, "pathToFunc": {"type": "string"}}, "required": ["name", "azureFunction"]}, "executable": {"type": "object", "properties": {"name": {"type": "string"}, "executable": {"type": "string"}, "workingDirectory": {"type": "string"}, "env": {"type": "array", "items": {}}, "args": {"type": "string"}, "replicas": {"type": "integer"}, "bindings": {"type": "array", "items": {}}}, "required": ["name", "executable"]}, "external": {"properties": {"name": {"type": "string"}, "external": {"type": "boolean", "const": true}, "bindings": {"type": "array", "items": {}}}, "additionalProperties": false}, "repository": {"properties": {"name": {"type": "string"}, "repository": {"type": "string"}, "cloneDirectory": {"type": "string"}}, "required": ["name", "repository"]}, "include": {"properties": {"name": {"type": "string"}, "include": {"type": "string"}}, "required": ["name", "include"]}, "image": {"type": "object", "properties": {"name": {"type": "string"}, "volumes": {"type": "array", "items": {}}, "image": {"type": "string"}, "env": {"type": "array", "items": {}}, "args": {"type": "string"}, "replicas": {"type": "integer"}, "bindings": {"type": "array", "items": {}}}, "required": ["name", "image"]}, "dockerFile": {"type": "object", "properties": {"name": {"type": "string"}, "volumes": {"type": "array", "items": {}}, "dockerFile": {"type": "string"}, "dockerFileArgs": {"type": "array", "items": {"type": "object"}}, "dockerFileContext": {"type": "string"}, "env": {"type": "array", "items": {}}, "args": {"type": "string"}, "replicas": {"type": "integer"}, "bindings": {"type": "array", "items": {}}}, "required": ["name", "dockerFile"]}, "ingress": {"type": "object", "properties": {"name": {"type": "string"}, "bindings": {"type": "array", "items": {}}, "rules": {"type": "array", "items": {}}}}, "ingress-binding": {"type": "object", "properties": {"name": {"type": "string"}, "port": {"type": "integer"}, "protocol": {"type": "string"}, "ip": {"type": "string"}}}, "ingress-rule": {"type": "object", "properties": {"service": {"type": "string"}, "path": {"type": "string"}, "host": {"type": "string"}, "preservePath": {"type": "boolean"}}, "required": ["service"]}, "project": {"type": "object", "properties": {"name": {"type": "string"}, "project": {"type": "string"}, "env": {"type": "array", "items": {}}, "buildProperties": {"type": "array", "items": {}}, "args": {"type": "string"}, "build": {"type": "boolean"}, "replicas": {"type": "integer"}, "bindings": {"type": "array", "items": {}}}, "required": ["name", "project"]}, "extension": {"type": "object", "properties": {"name": {"type": "string"}}, "required": ["name"]}}}
tye-schema.json
name
The application name.
{"type": "string"}
tye-schema.json
registry
Dockerhub username or hostname of remote registry. Used for tagging images.
{"type": "string"}
tye-schema.json
containerEngine
Container engine.
{"type": "string", "enum": ["docker", "podman"]}
tye-schema.json
namespace
The Kubernetes namespace to use.
{"type": "string"}
tye-schema.json
network
The Docker network to use.
{"type": "string"}
tye-schema.json
dashboardPort
Configure the dashboard port used for `tye run`. Can be overridden using the `--port` CLI argument, and falls back to port 8000 if free, or a random port if 8000 is in use.
{"type": "integer"}
tye-schema.json
ingress
The application's ingresses.
{"type": "array", "minItems": 1, "items": {}}
tye-schema.json
extensions
Extensions to be added to tye.
{"type": "array", "items": {}}
tye-schema.json
solution
Indicates the solution file (.sln) or filter (.slnf) to use when building project-based services in watch mode. If omitted, those services will be built individually. Specifying the solution [filter] can help reduce repeated builds of shared libraries when in watch mode.
{"type": "string"}
tye-schema.json
services
The application's services.
{"type": "array", "minItems": 1, "items": {"type": "object", "oneOf": [{}, {}, {}, {}, {}, {}, {}, {}]}}
tye-schema.json
name
The binding name.
{"type": "string"}
tye-schema.json
port
The binding port.
{"type": "integer"}
tye-schema.json
containerPort
The port used when running inside a container.
{"type": "integer"}
tye-schema.json
host
The hostname for the binding.
{"type": "string"}
tye-schema.json
protocol
The protocol used by the binding
{"type": "string"}
tye-schema.json
autoAssignPort
Whether to auto-assign a port value.
{"type": "boolean", "default": false}
tye-schema.json
connectionString
The connection string.
{"type": "string"}
tye-schema.json
name
Environment variable name.
{"type": "string"}
tye-schema.json
value
Environment variable value.
{"type": "string"}
tye-schema.json
name
Build property name.
{"type": "string"}
tye-schema.json
value
Build property name.
{"type": "string"}
tye-schema.json
name
A named volume.
{"type": "string"}
tye-schema.json
source
The local path.
{"type": "string"}
tye-schema.json
target
The destination path within the container.
{"type": "string"}
tye-schema.json
name
The service name. Must be unique per-application.
{"type": "string"}
tye-schema.json
azureFunction
The directory path to the azure function.
{"type": "string"}
tye-schema.json
env
Environment variables to use when launching.
{"type": "array", "items": {}}
tye-schema.json
args
Command-line arguments to use when launching.
{"type": "string"}
tye-schema.json
replicas
Number of service replicas to create.
{"type": "integer"}
tye-schema.json
bindings
The bindings provided by the service.
{"type": "array", "items": {}}
tye-schema.json
pathToFunc
Optional path to the function host to be used when launching functions. Can point to either func.dll or the binary.
{"type": "string"}
tye-schema.json
name
The service name. Must be unique per-application.
{"type": "string"}
tye-schema.json
executable
The file path (or file name if on the system path) of an executable.
{"type": "string"}
tye-schema.json
workingDirectory
The working directory to use when launching.
{"type": "string"}
tye-schema.json
env
Environment variables to use when launching.
{"type": "array", "items": {}}
tye-schema.json
args
Command-line arguments to use when launching.
{"type": "string"}
tye-schema.json
replicas
Number of service replicas to create.
{"type": "integer"}
tye-schema.json
bindings
The bindings provided by the service.
{"type": "array", "items": {}}
tye-schema.json
name
The service name. Must be unique per-application.
{"type": "string"}
tye-schema.json
external
Designates as service as external. External services will not be launched and can only provide bindings.
{"type": "boolean", "const": true}
tye-schema.json
bindings
The bindings provided by the service.
{"type": "array", "items": {}}
tye-schema.json
name
The service name. Must be unique per-application.
{"type": "string"}
tye-schema.json
repository
The repository url which will be cloned.
{"type": "string"}
tye-schema.json
cloneDirectory
The directory to clone the repository into.
{"type": "string"}
tye-schema.json
name
The service name. Must be unique per-application.
{"type": "string"}
tye-schema.json
include
Path to tye.yaml file which will be used in the application.
{"type": "string"}
tye-schema.json
name
The service name. Must be unique per-application.
{"type": "string"}
tye-schema.json
volumes
Volumes to mount to the container.
{"type": "array", "items": {}}
tye-schema.json
image
The name of a Docker image.
{"type": "string"}
tye-schema.json
env
Environment variables to use when launching.
{"type": "array", "items": {}}
tye-schema.json
args
Command-line arguments to use when launching.
{"type": "string"}
tye-schema.json
replicas
Number of service replicas to create.
{"type": "integer"}
tye-schema.json
bindings
The bindings provided by the service.
{"type": "array", "items": {}}
tye-schema.json
name
The service name. Must be unique per-application.
{"type": "string"}
tye-schema.json
volumes
Volumes to mount to the container.
{"type": "array", "items": {}}
tye-schema.json
dockerFile
The Dockerfile to use.
{"type": "string"}
tye-schema.json
dockerFileArgs
Build arguments to use when building the image.
{"type": "array", "items": {"type": "object"}}
tye-schema.json
dockerFileContext
The Dockerfile context to run docker build on.
{"type": "string"}
tye-schema.json
env
Environment variables to use when launching.
{"type": "array", "items": {}}
tye-schema.json
args
Command-line arguments to use when launching.
{"type": "string"}
tye-schema.json
replicas
Number of service replicas to create.
{"type": "integer"}
tye-schema.json
bindings
The bindings provided by the service.
{"type": "array", "items": {}}
tye-schema.json
name
The ingress name.
{"type": "string"}
tye-schema.json
bindings
Bindings for the ingress in local development.
{"type": "array", "items": {}}
tye-schema.json
rules
Rules for ingress routing.
{"type": "array", "items": {}}
tye-schema.json
name
The binding name.
{"type": "string"}
tye-schema.json
port
The binding port.
{"type": "integer"}
tye-schema.json
protocol
The protocol used by the binding
{"type": "string"}
tye-schema.json
ip
The ip address the ingress listens on.
{"type": "string"}
tye-schema.json
service
The service to route traffic when the rule matches.
{"type": "string"}
tye-schema.json
path
The path prefix to match.
{"type": "string"}
tye-schema.json
host
The hostname to match.
{"type": "string"}
tye-schema.json
preservePath
Whether to keep the path that was originally present or not after a prefix match.
{"type": "boolean"}
tye-schema.json
name
The service name. Must be unique per-application.
{"type": "string"}
tye-schema.json
project
The relative path to a .NET project file.
{"type": "string"}
tye-schema.json
env
Environment variables to use when launching.
{"type": "array", "items": {}}
tye-schema.json
buildProperties
Build properties to use when launching or building a project.
{"type": "array", "items": {}}
tye-schema.json
args
Command-line arguments to use when launching.
{"type": "string"}
tye-schema.json
build
Whether to build the project.
{"type": "boolean"}
tye-schema.json
replicas
Number of service replicas to create.
{"type": "integer"}
tye-schema.json
bindings
The bindings provided by the service.
{"type": "array", "items": {}}
tye-schema.json
name
Extension name.
{"type": "string"}
sdf-schema-1.1.json
workspace
A workspace definition
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
profile
A profile definition
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
table
A table definition
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
classifier
A classifier definition
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
function
A function definition
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
plugin
A plugin definition
{"anyOf": [{}, {"type": "null"}]}
sdf-schema-1.1.json
Workspace
A workspace is a collection of one or more catalogs, schemas, tables, and resources, called workspace members, that are managed together.
{"type": "object", "required": ["edition", "name"], "properties": {"edition": {"type": "string"}, "name": {"type": "string"}, "repository": {"type": ["string", "null"]}, "remote-location": {"type": ["string", "null"]}, "includes": {"type": ["array", "null"], "items": {}}, "excludes": {"type": ["array", "null"], "items": {}}, "references": {"writeOnly": true, "type": ["array", "null"], "items": {}}, "dialect": {"anyOf": [{}, {"type": "null"}]}, "resources": {"type": ["array", "null"], "items": {}}, "default-catalog": {"type": ["string", "null"]}, "default-schema": {"type": ["string", "null"]}, "default-profile": {"type": ["string", "null"]}, "source-locations": {"anyOf": [{}, {"type": "null"}]}, "variables": {"type": ["array", "null"], "items": {}}, "code-reports": {"type": ["array", "null"], "items": {}}, "code-checks": {"type": ["array", "null"], "items": {}}, "access-control": {"type": ["array", "null"], "items": {}}}, "additionalProperties": false}
sdf-schema-1.1.json
edition
The SDF edition, should always be 1 (for now)
{"type": "string"}
sdf-schema-1.1.json
name
The name of this workspace (defaults to the workspace directory name if not given) Name must be set for deployment.
{"type": "string"}
sdf-schema-1.1.json
description
A description of this workspace
{"type": ["string", "null"]}