schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
schema-app.json
type
Type of the app.
{"type": "string", "enum": ["static", "function", "service"]}
schema-app.json
env
Environment variables common for all operations.
{"type": "object", "additionalProperties": {"type": "string"}}
schema-app.json
dir
Working directory of the app where all commands will be run. Defaults to location of this yaml. All other dirs will be relative to this one.
{"type": "string"}
schema-app.json
url
External URL of the app.
{"type": "string"}
schema-app.json
path_redirect
Path redirect rewrites URL to specified path. URL path from 'url' field will be stripped and replaced with value below.
{"type": "string"}
schema-app.json
needs
Application dependencies to inject.
{}
schema-app.json
run
Run config used for dev builds during run.
{}
schema-app.json
cdn
CDN settings.
{}
schema-app.json
routing
Routing type. Defaults to 'react'.
{"type": "string", "enum": ["react", "gatsby", "disabled"]}
schema-app.json
remove_trailing_slash
Remove trailing slash with permanent redirect. Currently used only for deployments. Defaults to 'true' when gatsby routing is used, 'false' otherwise.
{"type": "boolean"}
schema-app.json
basic_auth
Static application basic authentication config. Currently used only for deployments.
{}
schema-app.json
build
Static application build config used for deployment builds.
{}
schema-app.json
deploy
Static deploy config.
{}
schema-app.json
private
Marks app as private - won't allow unauthenticated access.
{"type": "boolean"}
schema-app.json
build
Service application build config used for deployment builds.
{}
schema-app.json
container
Service application container config used for docker based deployments/runs.
{}
schema-app.json
deploy
Service deploy config.
{}
schema-app.json
scheduler
Service scheduler config.
{}
schema-app.json
private
Marks app as private - won't allow unauthenticated access.
{"type": "boolean"}
schema-app.json
runtime
The runtime in which the function is going to run, refer to cloud provider docs for possible options.
{"type": "string"}
schema-app.json
entrypoint
Name of the function that will be executed when the function is triggered. Not all deployment plugins support it. Defaults to application name.
{"type": "string"}
schema-app.json
build
Function application build config used for deployment builds.
{}
schema-app.json
deploy
Function deploy config.
{}
schema-app.json
package
Function package config.
{}
schema-app.json
scheduler
Function scheduler config.
{}
schema-app.json
plugin
Run plugin override. Defaults to first supported plugin available.
{"type": "string"}
schema-app.json
command
Command to be run to for dev mode.
{"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}
schema-app.json
port
Port override, by default just assigns next port starting from listen-port.
{"type": "integer"}
schema-app.json
env
Additional environment variables available local run.
{"type": "object", "additionalProperties": {"type": "string"}}
schema-app.json
plugin
Deploy plugin override. Defaults to first supported plugin available.
{"type": "string"}
schema-app.json
min_scale
Minimum scale of container deployment (used if deployment uses a container).
{"type": "integer"}
schema-app.json
max_scale
Maximum scale of container deployment (used if deployment uses a container).
{"type": "integer"}
schema-app.json
timeout
Execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period.
{"type": "integer"}
schema-app.json
patterns
File/dir patterns to exclude (or force include if starts with '!').
{"type": "array", "items": {"type": "string"}}
schema-app.json
plugin
Deploy plugin override. Defaults to first supported plugin available.
{"type": "string"}
schema-app.json
env
Additional environment variables.
{"type": "object", "additionalProperties": {"type": "string"}}
schema-app.json
cpu_limit
CPU limit of container deployment. 1.0 means 1 full core of CPU will be used.
{"type": "number"}
schema-app.json
memory_limit
Memory limit in MiB of container deployment.
{"type": "integer"}
schema-app.json
min_scale
Minimum scale of container deployment.
{"type": "integer"}
schema-app.json
max_scale
Maximum scale of container deployment.
{"type": "integer"}
schema-app.json
timeout
Execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period.
{"type": "integer"}
schema-app.json
container
Service application container config used for docker based deployments.
{}
schema-app.json
cron
Scheduler cron, e.g. */30 * * * * runs every 30 minutes.
{"type": "string"}
schema-app.json
name
Name of cron (just for information purpose).
{"type": "string"}
schema-app.json
method
HTTP method to use. Defaults to 'GET'.
{"type": "string", "enum": ["GET", "POST", "HEAD", "PUT", "DELETE", "PATCH", "OPTIONS"]}
schema-app.json
path
Path to call in current app url.
{"type": "string"}
schema-app.json
headers
Additional headers to use for this call.
{"type": "object", "additionalProperties": {"type": "string"}}
schema-app.json
plugin
Deploy plugin override. Defaults to first supported plugin available.
{"type": "string"}
schema-app.json
env
Additional environment variables.
{"type": "object", "additionalProperties": {"type": "string"}}
schema-app.json
memory_limit
Memory limit in MiB of function deployment.
{"type": "integer"}
schema-app.json
min_scale
Minimum scale of container deployment (used if deployment uses a container).
{"type": "integer"}
schema-app.json
max_scale
Maximum scale of container deployment (used if deployment uses a container).
{"type": "integer"}
schema-app.json
timeout
Execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period.
{"type": "integer"}
schema-app.json
patterns
Package patterns to exclude (or force include if starts with '!').
{"type": "array", "items": {"type": "string"}}
schema-app.json
realm
Basic auth realm name, defaults to 'restricted'.
{"type": "string"}
schema-app.json
users
Basic auth users in form of `user: password` where password is either in plain text or in a form of apr1 hash (used by htpasswd).
{"type": "object", "additionalProperties": {"type": "string"}}
schema-app.json
env
Additional environment variables available during build.
{"type": "object", "additionalProperties": {"type": "string"}}
schema-app.json
command
Command to be run to generate output files.
{"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}
schema-app.json
dir
Output dir to where static files end up.
{"type": "string"}
schema-app.json
image
Docker image to use. If specified, will try to pull this image if skip-build is enabled.
{"type": "string"}
schema-app.json
skip_build
Skip this image build phase. If enabled, requires image to be either present on docker host or custom image to be possible to pull.
{"type": "boolean"}
schema-app.json
skip_pull
Skip this image dependencies pull phase. As a result, doesn't check for newer versions of tagged dependencies. Useful if dependencies do not exist outside of local docker.
{"type": "boolean"}
schema-app.json
build_args
Docker build-args.
{"type": "object", "additionalProperties": {"type": "string"}}
schema-app.json
context
Docker context directory, relative to application dir.
{"type": "string"}
schema-app.json
dockerfile
Dockerfile to use, relative to context path. Defaults to 'Dockerfile'.
{"type": "string"}
schema-app.json
env
Additional environment variables available during build.
{"type": "object", "additionalProperties": {"type": "string"}}
schema-app.json
command
Command to be run to generate output files.
{"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}
schema-app.json
dir
Output dir to where built files end up.
{"type": "string"}
schema-app.json
port
Docker container port to use.
{"type": "integer"}
schema-app.json
command
Docker command (CMD) to override.
{"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}
schema-app.json
entrypoint
Docker entrypoint (ENTRYPOINT) to override.
{"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}
powerpages-web-template-manifest.json
examples
renders the gallery card
{"type": "functional", "displayName": "Card Template", "params": [{"id": "name", "displayName": "Display name"}, {"id": "count", "displayName": "Items per row"}, {"id": "paramTable", "type": "table", "displayName": "Select table"}]}
powerpages-web-template-manifest.json
params
Main heading of the web template
{"id": "name", "displayName": "Display name"}
powerpages-web-template-manifest.json
params
No of items to be displayed per row
{"id": "count", "displayName": "Items per row"}
powerpages-web-template-manifest.json
type
The web template type. Use 'functional' for custom site components and 'layout' for custom layouts.
{"type": "string", "enum": ["functional", "layout"]}
powerpages-web-template-manifest.json
displayName
The display name of the web template
{"type": "string", "examples": ["Card Template"]}
powerpages-web-template-manifest.json
description
The description of the web template
{"type": "string", "examples": ["renders the gallery card"]}
powerpages-web-template-manifest.json
tables
An array of table logical names that are used in the web template
{"type": "array", "items": {"type": "string"}}
powerpages-web-template-manifest.json
params
The editable properties of the web template. These will be customizable in Studio
{"type": "array", "items": {"type": "object", "required": ["id"], "properties": {"id": {"type": "string", "examples": ["name", "count", "specifiedTable"]}, "displayName": {"type": "string", "examples": ["Display name", "Items per row", "Selected table"]}, "type": {"type": "string", "enum": ["table"]}}, "examples": [{"id": "name", "displayName": "Display name"}, {"id": "count", "displayName": "Items per row"}, {"id": "specifiedTable", "type": "table", "displayName": "Select table"}]}, "examples": [[{"id": "name", "displayName": "Display name"}, {"id": "count", "displayName": "Items per row"}, {"id": "specifiedTable", "type": "table", "displayName": "Select table"}]]}
powerpages-web-template-manifest.json
id
The id of the param. This correlates with the liquid tag's key for this property
{"type": "string", "examples": ["name", "count", "specifiedTable"]}
powerpages-web-template-manifest.json
displayName
The label displayed when editing a property in Studio. If no displayName is given, the label will fallback on the id
{"type": "string", "examples": ["Display name", "Items per row", "Selected table"]}
powerpages-web-template-manifest.json
description
The description to be displayed in the tooltip when editing a property in Studio. If no description is given, no tooltip will be displayed
{"type": "string", "examples": ["Main heading of the web template", "No of items to be displayed per row"]}
powerpages-web-template-manifest.json
type
Used to specify a property that correlates to a table's logical name
{"type": "string", "enum": ["table"]}
powerpages-web-template-manifest.json
examples
Main heading of the web template
{"id": "name", "displayName": "Display name"}
powerpages-web-template-manifest.json
examples
Main heading of the web template
{"id": "name", "displayName": "Display name"}
powerpages-web-template-manifest.json
examples
No of items to be displayed per row
{"id": "count", "displayName": "Items per row"}
httpmockrc.json
A tool for mock local requests or proxy remote requests.
{"$schema": "http://json-schema.org/draft-07/schema#", "properties": {"mockFileName": {"default": "mocks", "type": "string"}, "requestHeaders": {"type": "object"}, "responseHeaders": {"type": "object"}, "parseBody": {"type": "boolean"}, "routes": {"type": "object", "patternProperties": {"^.*$": {"type": "object", "properties": {"path": {"type": "string"}, "ignore": {"type": "boolean"}, "delay": {"type": "number"}, "validate": {"type": "object"}}, "required": ["path"]}}}}, "required": ["mockFileName", "routes"], "type": "object"}
httpmockrc.json
mockFileName
Root of mock files
{"default": "mocks", "type": "string"}
httpmockrc.json
requestHeaders
Custom request header
{"type": "object"}
httpmockrc.json
responseHeaders
Custom response header
{"type": "object"}
httpmockrc.json
parseBody
Parse post body by express.json()
{"type": "boolean"}
httpmockrc.json
routes
Rules for proxy and mock
{"type": "object", "patternProperties": {"^.*$": {"type": "object", "properties": {"path": {"type": "string"}, "ignore": {"type": "boolean"}, "delay": {"type": "number"}, "validate": {"type": "object"}}, "required": ["path"]}}}
httpmockrc.json
^.*$
Rule of Matching route
{"type": "object", "properties": {"path": {"type": "string"}, "ignore": {"type": "boolean"}, "delay": {"type": "number"}, "validate": {"type": "object"}}, "required": ["path"]}
httpmockrc.json
path
Where Mock result file located
{"type": "string"}
httpmockrc.json
ignore
Whether to ignore this rule, generally used for remote interfaces instead of mock in the local
{"type": "boolean"}
httpmockrc.json
delay
How many milliseconds are delayed to return a request, general used for control the request sequence
{"type": "number"}
httpmockrc.json
validate
Validate params in body by key and typeof value
{"type": "object"}
minecraft-loot-table.json
Configuration file defining a loot table for a data pack for Minecraft.
{"$schema": "http://json-schema.org/draft-07/schema#", "definitions": {"numberProvider": {"properties": {"type": {"type": "string", "enum": ["minecraft:constant", "minecraft:uniform", "minecraft:binomial", "minecraft:score"]}}, "allOf": [{"if": {"properties": {"type": {"const": "minecraft:constant"}}}, "then": {"properties": {"value": {"type": "number"}}}}, {"if": {"properties": {"type": {"const": "minecraft:uniform"}}}, "then": {"properties": {"min": {"type": ["number", "object"]}, "max": {"type": ["number", "object"]}}}}, {"if": {"properties": {"type": {"const": "minecraft:binomial"}}}, "then": {"properties": {"n": {"type": ["integer", "object"]}, "p": {}}}}, {"if": {"properties": {"type": {"const": "minecraft:score"}}}, "then": {"properties": {"target": {"type": ["string", "object"], "enum": ["this", "killer", "direct_killer", "player_killer"], "properties": {"type": {"type": "string", "enum": ["fixed", "context"]}}, "allOf": [{"if": {"properties": {"type": {"const": "fixed"}}}, "then": {"properties": {"name": {"type": "string"}}}}, {"if": {"properties": {"type": {"const": "context"}}}, "then": {"properties": {"target": {"type": "string", "enum": ["this", "killer", "direct_killer", "player_killer"]}}}}]}, "score": {"type": "string"}, "scale": {"type": "number"}}}}]}}, "properties": {"type": {"type": "string", "enum": ["minecraft:empty", "empty", "minecraft:entity", "entity", "minecraft:block", "block", "minecraft:chest", "chest", "minecraft:fishing", "fishing", "minecraft:gift", "gift", "minecraft:advancement_reward", "advancement_reward", "minecraft:barter", "barter", "minecraft:command", "command", "minecraft:selector", "selector", "minecraft:advancement_entity", "advancement_entity", "minecraft:generic", "generic"]}, "functions": {"type": "array", "items": {"type": "object", "additionalProperties": {"type": "object", "properties": {"function": {"type": "string"}, "conditions": {"type": "array", "items": {"type": "object", "additionalProperties": {"type": "object", "properties": {"condition": {"type": "string"}}}}}}}}}, "pools": {"type": "array", "items": {"type": "object", "properties": {"conditions": {"type": "array", "items": {"type": "object", "additionalProperties": {"properties": {"condition": {"type": "string"}}}}}, "functions": {"type": "array", "items": {"type": "object", "additionalProperties": {"properties": {"function": {"type": "string"}, "conditions": {"type": "array", "items": {"type": "object", "properties": {"condition": {"type": "string"}}}}}}}}, "rolls": {"type": ["integer", "object"]}, "bonus_rolls": {"type": ["number", "object"]}, "entries": {"type": "array", "items": {"type": "object", "properties": {"conditions": {"type": "array", "items": {"type": "object", "additionalProperties": {"properties": {"condition": {"type": "string"}}}}}, "functions": {"type": "array", "items": {"type": "object", "additionalProperties": {"properties": {"function": {"type": "string"}, "conditions": {"type": "array", "items": {"type": "object", "properties": {"condition": {"type": "string"}}}}}}}}, "type": {"type": "string", "enum": ["minecraft:item", "minecraft:tag", "minecraft:loot_table", "minecraft:group", "minecraft:alternatives", "minecraft:sequence", "minecraft:dynamic", "minecraft:empty"]}, "name": {"type": "string"}, "children": {"type": "array"}, "expand": {"type": "boolean"}, "weight": {"type": "integer"}, "quality": {"type": "integer"}}}}}}}}}
minecraft-loot-table.json
type
The number provider type.
{"type": "string", "enum": ["minecraft:constant", "minecraft:uniform", "minecraft:binomial", "minecraft:score"]}
minecraft-loot-table.json
then
A constant value.
{"properties": {"value": {"type": "number"}}}