schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
samcli.json
output
Output the results from the command in a given output format (json or table).
{"type": "string", "default": "table", "enum": ["json", "table"]}
samcli.json
profile
Select a specific profile from your credential file to get AWS credentials.
{"type": "string"}
samcli.json
region
Set the AWS Region of the service. (e.g. us-east-1)
{"type": "string"}
samcli.json
beta_features
Enable/Disable beta features.
{"type": "boolean"}
samcli.json
debug
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
{"type": "boolean"}
samcli.json
list_endpoints
Get a summary of the cloud endpoints in the stack. This command will show both the cloud and local endpoints that can be used with sam local and sam sync. Currently the endpoint resources are Lambda functions and API Gateway API resources.
{"properties": {"parameters": {"type": "object", "properties": {"parameter_overrides": {"type": ["array", "string"], "items": {"type": "string"}}, "stack_name": {"type": "string"}, "output": {"type": "string", "default": "table", "enum": ["json", "table"]}, "template_file": {"type": "string", "default": "template.[yaml|yml|json]"}, "profile": {"type": "string"}, "region": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}}}}, "required": ["parameters"]}
samcli.json
parameters
Available parameters for the list endpoints command: * parameter_overrides: String that contains AWS CloudFormation parameter overrides encoded as key=value pairs. * stack_name: Name of corresponding deployed stack.(Not including a stack name will only show local resources defined in the template.) * output: Output the results from the command in a given output format (json or table). * template_file: AWS SAM template file. * profile: Select a specific profile from your credential file to get AWS credentials. * region: Set the AWS Region of the service. (e.g. us-east-1) * beta_features: Enable/Disable beta features. * debug: Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
{"type": "object", "properties": {"parameter_overrides": {"type": ["array", "string"], "items": {"type": "string"}}, "stack_name": {"type": "string"}, "output": {"type": "string", "default": "table", "enum": ["json", "table"]}, "template_file": {"type": "string", "default": "template.[yaml|yml|json]"}, "profile": {"type": "string"}, "region": {"type": "string"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}}}
samcli.json
parameter_overrides
String that contains AWS CloudFormation parameter overrides encoded as key=value pairs.
{"type": ["array", "string"], "items": {"type": "string"}}
samcli.json
stack_name
Name of corresponding deployed stack.(Not including a stack name will only show local resources defined in the template.)
{"type": "string"}
samcli.json
output
Output the results from the command in a given output format (json or table).
{"type": "string", "default": "table", "enum": ["json", "table"]}
samcli.json
template_file
AWS SAM template file.
{"type": "string", "default": "template.[yaml|yml|json]"}
samcli.json
profile
Select a specific profile from your credential file to get AWS credentials.
{"type": "string"}
samcli.json
region
Set the AWS Region of the service. (e.g. us-east-1)
{"type": "string"}
samcli.json
beta_features
Enable/Disable beta features.
{"type": "boolean"}
samcli.json
debug
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
{"type": "boolean"}
samcli.json
docs
NEW! Open the documentation in a browser.
{"properties": {"parameters": {"type": "object", "properties": {}}}, "required": ["parameters"]}
samcli.json
parameters
Available parameters for the docs command: *
{"type": "object", "properties": {}}
samcli.json
remote_invoke
Invoke or send an event to resources in the cloud.
{"properties": {"parameters": {"type": "object", "properties": {"stack_name": {"type": "string"}, "event": {"type": "string"}, "event_file": {"type": "string"}, "output": {"type": "string", "default": "text", "enum": ["json", "text"]}, "parameter": {"type": "array", "items": {"type": "string"}}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}, "profile": {"type": "string"}, "region": {"type": "string"}}}}, "required": ["parameters"]}
samcli.json
parameters
Available parameters for the remote invoke command: * stack_name: Name of the stack to get the resource information from * event: The event that will be sent to the resource. The target parameter will depend on the resource type. For instance: 'Payload' for Lambda which can be passed as a JSON string * event_file: The file that contains the event that will be sent to the resource. * output: Output the results from the command in a given output format. The text format prints a readable AWS API response. The json format prints the full AWS API response. * parameter: Additional parameters that can be passed to invoke the resource. The following additional parameters can be used to invoke a lambda resource and get a buffered response: InvocationType='Event'|'RequestResponse'|'DryRun', LogType='None'|'Tail', ClientContext='base64-encoded string' Qualifier='string'. The following additional parameters can be used to invoke a lambda resource with response streaming: InvocationType='RequestResponse'|'DryRun', LogType='None'|'Tail', ClientContext='base64-encoded string', Qualifier='string'. * beta_features: Enable/Disable beta features. * debug: Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps. * profile: Select a specific profile from your credential file to get AWS credentials. * region: Set the AWS Region of the service. (e.g. us-east-1)
{"type": "object", "properties": {"stack_name": {"type": "string"}, "event": {"type": "string"}, "event_file": {"type": "string"}, "output": {"type": "string", "default": "text", "enum": ["json", "text"]}, "parameter": {"type": "array", "items": {"type": "string"}}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}, "profile": {"type": "string"}, "region": {"type": "string"}}}
samcli.json
stack_name
Name of the stack to get the resource information from
{"type": "string"}
samcli.json
event
The event that will be sent to the resource. The target parameter will depend on the resource type. For instance: 'Payload' for Lambda which can be passed as a JSON string
{"type": "string"}
samcli.json
event_file
The file that contains the event that will be sent to the resource.
{"type": "string"}
samcli.json
output
Output the results from the command in a given output format. The text format prints a readable AWS API response. The json format prints the full AWS API response.
{"type": "string", "default": "text", "enum": ["json", "text"]}
samcli.json
parameter
Additional parameters that can be passed to invoke the resource. The following additional parameters can be used to invoke a lambda resource and get a buffered response: InvocationType='Event'|'RequestResponse'|'DryRun', LogType='None'|'Tail', ClientContext='base64-encoded string' Qualifier='string'. The following additional parameters can be used to invoke a lambda resource with response streaming: InvocationType='RequestResponse'|'DryRun', LogType='None'|'Tail', ClientContext='base64-encoded string', Qualifier='string'.
{"type": "array", "items": {"type": "string"}}
samcli.json
beta_features
Enable/Disable beta features.
{"type": "boolean"}
samcli.json
debug
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps.
{"type": "boolean"}
samcli.json
profile
Select a specific profile from your credential file to get AWS credentials.
{"type": "string"}
samcli.json
region
Set the AWS Region of the service. (e.g. us-east-1)
{"type": "string"}
statamic.blueprint.schema.json
tabs
At its most basic, a blueprint has tabs. A tab has a handle, a display name, and an array of sections. Since Statamic 4
{"type": "object", "additionalProperties": false, "patternProperties": {"^[A-Za-z_]+?$": {"type": "object", "properties": {"display": {"type": "string"}, "sections": {"type": "array", "items": {"type": "object", "properties": {"display": {"type": "string"}, "instructions": {"type": "string"}, "fields": {}}}, "additionalItems": false}}}}}
statamic.blueprint.schema.json
^[A-Za-z_]+?$
The handle (name) of a section. This one is on you.
{"type": "object", "properties": {"display": {"type": "string"}, "sections": {"type": "array", "items": {"type": "object", "properties": {"display": {"type": "string"}, "instructions": {"type": "string"}, "fields": {}}}, "additionalItems": false}}}
statamic.blueprint.schema.json
display
The displayed text.
{"type": "string"}
statamic.blueprint.schema.json
sections
The Sections of the Tab
{"type": "array", "items": {"type": "object", "properties": {"display": {"type": "string"}, "instructions": {"type": "string"}, "fields": {}}}, "additionalItems": false}
statamic.blueprint.schema.json
display
The displayed text.
{"type": "string"}
statamic.blueprint.schema.json
instructions
Some instructions
{"type": "string"}
statamic.blueprint.schema.json
sections
At its most basic, a blueprint has sections. A section has a handle, a display name, and an array of fields. Until Statamic 3
{"type": "object", "additionalProperties": false, "patternProperties": {"^[A-Za-z]+?$": {"type": "object", "properties": {"display": {"type": "string"}, "fields": {}}}}}
statamic.blueprint.schema.json
^[A-Za-z]+?$
The handle (name) of a section. This one is on you.
{"type": "object", "properties": {"display": {"type": "string"}, "fields": {}}}
statamic.blueprint.schema.json
display
The displayed text.
{"type": "string"}
statamic.blueprint.schema.json
fields
Here you define the fields of this section.
{"type": "array", "uniqueItems": true, "uniqueItemProperties": ["handle"], "items": {"type": "object", "properties": {"handle": {"type": "string"}, "config": {"type": "object", "properties": {"display": {"type": "string"}}}, "import": {"type": "string"}, "prefix": {"type": "string"}, "field": {"type": ["object", "string"], "anyOf": [{"type": "string"}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}], "required": ["type"]}}, "dependentRequired": {"field": ["handle"]}}}
statamic.blueprint.schema.json
handle
The field's template variable.
{"type": "string"}
statamic.blueprint.schema.json
field
The definition of a single field.
{"type": ["object", "string"], "anyOf": [{"type": "string"}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}], "required": ["type"]}
statamic.blueprint.schema.json
array
This fieldtype is used to manage key: value array data in the right situation.
{"type": "object", "properties": {"display": {}, "icon": {}, "instructions": {}, "instructions_position": {}, "listable": {}, "required": {}, "localizable": {}, "validate": {}, "type": {"const": "array"}, "mode": {"type": "string", "enum": ["dynamic", "keyed"]}, "keys": {"type": ["object", "array"]}, "value_header": {"type": "string"}, "key_header": {"type": "string"}}, "additionalProperties": true}
statamic.blueprint.schema.json
assets
The assets fieldtype is used to manage and relate files with your entries.
{"type": "object", "properties": {"type": {"const": "assets"}, "mode": {"type": "string", "enum": ["grid", "list"], "default": "list"}, "container": {"type": "string"}, "folder": {"type": "string"}, "restrict": {"type": "boolean", "default": false}, "allow_uploads": {"type": "boolean", "default": true}, "show_filename": {"type": "boolean", "default": true}, "max_files": {"type": "integer"}}, "additionalProperties": true}
statamic.blueprint.schema.json
bard
Bard is our recommended fieldtype for creating long form content from the control panel.
{"type": "object", "properties": {"type": {"const": "bard"}, "always_show_set_button": {"type": "boolean", "default": false}, "sets": {"type": "object"}, "buttons": {"type": "array", "items": {"type": "string", "uniqueItems": true, "enum": ["h2", "h3", "bold", "italic", "unorderedlist", "orderedlist", "removeformat", "quote", "anchor", "image", "table"]}}, "container": {"type": "string"}, "save_html": {"type": "boolean", "default": false}, "toolbar_mode": {"type": "string", "enum": ["fixed", "floating"], "default": "fixed"}, "link_noopener": {"type": "boolean", "default": false}, "link_noreferrer": {"type": "boolean", "default": false}, "target_blank": {"type": "boolean", "default": false}, "link_collections": {"type": "array", "items": {"type": "string"}}, "reading_time": {"type": "boolean", "default": false}, "fullscreen": {"type": "boolean", "default": true}, "allow_source": {"type": "boolean", "default": true}, "enable_input_rules": {"type": "boolean", "default": true}, "enable_paste_rules": {"type": "boolean", "default": true}, "display": {}, "instructions": {}, "instructions_position": {}, "listable": {}, "required": {}, "localizable": {}, "validate": {}}, "additionalProperties": true}
statamic.blueprint.schema.json
always_show_set_button
Enable to always show the "Add Set" button.
{"type": "boolean", "default": false}
statamic.blueprint.schema.json
sets
Sets are configurable blocks of fields that can be inserted anywhere in your Bard content.
{"type": "object"}
statamic.blueprint.schema.json
buttons
Choose which buttons to show in the toolbar.
{"type": "array", "items": {"type": "string", "uniqueItems": true, "enum": ["h2", "h3", "bold", "italic", "unorderedlist", "orderedlist", "removeformat", "quote", "anchor", "image", "table"]}}
statamic.blueprint.schema.json
container
Choose which asset container to use for this field.
{"type": "string"}
statamic.blueprint.schema.json
save_html
Save HTML instead of structured data. This simplifies but limits control of your template markup.
{"type": "boolean", "default": false}
statamic.blueprint.schema.json
toolbar_mode
Choose which style of toolbar you prefer.
{"type": "string", "enum": ["fixed", "floating"], "default": "fixed"}
statamic.blueprint.schema.json
link_noopener
Set rel="noopener" on all links.
{"type": "boolean", "default": false}
statamic.blueprint.schema.json
link_noreferrer
Set rel="noreferrer" on all links.
{"type": "boolean", "default": false}
statamic.blueprint.schema.json
target_blank
Set target="_blank" on all links.
{"type": "boolean", "default": false}
statamic.blueprint.schema.json
link_collections
Entries from these collections will be available in the link selector. Leaving this empty will make all entries available.
{"type": "array", "items": {"type": "string"}}
statamic.blueprint.schema.json
reading_time
Show estimated reading time at the bottom of the field.
{"type": "boolean", "default": false}
statamic.blueprint.schema.json
fullscreen
Enable to toggle into fullscreen mode.
{"type": "boolean", "default": true}
statamic.blueprint.schema.json
allow_source
Allow Source Mode
{"type": "boolean", "default": true}
statamic.blueprint.schema.json
enable_input_rules
Enable Input Rules
{"type": "boolean", "default": true}
statamic.blueprint.schema.json
enable_paste_rules
Enables Markdown-style shortcuts when typing content.
{"type": "boolean", "default": true}
statamic.blueprint.schema.json
button_group
The button group fieldtype is a multiple choice input where you only get one choice.
{"type": "object", "properties": {"type": {"const": "button_group"}, "options": {"type": ["object", "array"]}, "default": {"type": "string"}}, "additionalProperties": true}
statamic.blueprint.schema.json
options
Set the array keys and their optional labels.
{"type": ["object", "array"]}
statamic.blueprint.schema.json
default
Set the default value.
{"type": "string"}
statamic.blueprint.schema.json
checkboxes
The checkboxes fieldtype is a multiple choice input.
{"type": "object", "properties": {"type": {"const": "checkboxes"}, "inline": {"type": "boolean", "default": "false"}, "options": {"type": ["object", "array"]}, "default": {"type": "string"}}, "additionalProperties": true}
statamic.blueprint.schema.json
code
If your content involves code snippets, this is the fieldtype for you.
{"type": "object", "properties": {"type": {"const": "code"}, "theme": {"type": "string", "enum": ["light", "material"]}, "mode": {"type": "string", "enum": ["clike", "css", "diff", "go", "haml", "handlebars", "htmlmixed", "less", "markdown", "gfm", "nginx", "text/x-java", "javascript", "jsx", "text/x-objectivec", "php", "python", "ruby", "scss", "shell", "sql", "twig", "vue", "xml", "yaml-frontmatter"]}, "indent_type": {"type": "string", "enum": ["tabs", "spaces"]}, "indent_size": {"type": "integer", "default": 4}, "key_map": {"type": "string", "default": "default", "enum": ["default", "sublime", "vim"]}, "line_numbers": {"type": "boolean", "default": true}, "line_wrapping": {"type": "boolean", "default": true}}, "additionalProperties": true}
statamic.blueprint.schema.json
theme
Choose your preferred theme.
{"type": "string", "enum": ["light", "material"]}
statamic.blueprint.schema.json
mode
Choose language for syntax highlighting.
{"type": "string", "enum": ["clike", "css", "diff", "go", "haml", "handlebars", "htmlmixed", "less", "markdown", "gfm", "nginx", "text/x-java", "javascript", "jsx", "text/x-objectivec", "php", "python", "ruby", "scss", "shell", "sql", "twig", "vue", "xml", "yaml-frontmatter"]}
statamic.blueprint.schema.json
indent_type
Set your preferred type of indentation.
{"type": "string", "enum": ["tabs", "spaces"]}
statamic.blueprint.schema.json
indent_size
Set your preferred indentation size (in spaces).
{"type": "integer", "default": 4}
statamic.blueprint.schema.json
key_map
Choose preferred set of keyboard shortcuts.
{"type": "string", "default": "default", "enum": ["default", "sublime", "vim"]}
statamic.blueprint.schema.json
line_numbers
Show Line Numbers
{"type": "boolean", "default": true}
statamic.blueprint.schema.json
line_wrapping
Enable Line Wrapping
{"type": "boolean", "default": true}
statamic.blueprint.schema.json
collections
This fieldtype is used to view and select from a list of Collections.
{"type": "object", "properties": {"type": {"const": "collections"}, "max_items": {"type": "integer"}, "mode": {}}, "additionalProperties": true}
statamic.blueprint.schema.json
max_items
Set a maximum number of selectable items.
{"type": "integer"}
statamic.blueprint.schema.json
mode
Choose your preferred UI style.
{}
statamic.blueprint.schema.json
color
This fieldtype is a highly configurable color picker with simple and advanced UI modes, support for alpha channel, rgba, hsla, hsva, and more.
{"type": "object", "properties": {"type": {"const": "color"}, "swatches": {"type": "array", "uniqueItems": true}, "theme": {"type": "string", "enum": ["classic", "nano"]}, "lock_opacity": {"type": "boolean", "default": false}, "default_color_mode": {"type": "string", "default": "HEXA", "enum": ["HEXA", "RGBA", "HSLA", "HSVA", "CMYK"]}, "color_modes": {"type": "array", "uniqueItems": true, "default": "hex", "items": {"type": "string", "enum": ["hex", "rgba", "hsla", "hsva", "cmyk"]}}}, "additionalProperties": true}
statamic.blueprint.schema.json
swatches
Pre-define colors that can be selected from a list. Supports all color mode formats.
{"type": "array", "uniqueItems": true}
statamic.blueprint.schema.json
theme
Choose between a classic and a simpler nano (mini) theme. Default: classic.
{"type": "string", "enum": ["classic", "nano"]}
statamic.blueprint.schema.json
lock_opacity
Disables the alpha slider, preventing adjustments to opacity.
{"type": "boolean", "default": false}
statamic.blueprint.schema.json
default_color_mode
Set which color mode you wish to be the default. Default: hex.
{"type": "string", "default": "HEXA", "enum": ["HEXA", "RGBA", "HSLA", "HSVA", "CMYK"]}
statamic.blueprint.schema.json
color_modes
Choose which color modes you want to enable in the UI. Available choices: hex, rgba, hsla, hsva, and cmyk. Default: hex.
{"type": "array", "uniqueItems": true, "default": "hex", "items": {"type": "string", "enum": ["hex", "rgba", "hsla", "hsva", "cmyk"]}}
statamic.blueprint.schema.json
date
Work with dates, times, and ranges with a variety of user interface options that make you really enjoy basically just picking numbers from a table.
{"type": "object", "properties": {"columns": {"type": "integer", "minimum": 1, "default": 1}, "earliest_date": {"oneOf": [{"format": "date"}, {"format": "date-time"}], "type": "string", "default": "1900-01-01"}, "format": {"type": "string", "default": "'Y-m-d'"}, "full_width": {"type": "boolean", "default": false}, "icon": {"type": "string"}, "inline": {"type": "boolean", "default": false}, "mode": {"type": "string", "enum": ["single", "range"], "default": "single"}, "rows": {"type": "integer", "minimum": 1, "default": 1}, "time_enabled": {"type": "boolean", "default": false}, "time_required": {"type": "boolean", "default": false}, "type": {"type": "string", "const": "date"}}, "additionalProperties": true}
statamic.blueprint.schema.json
columns
Show multiple months at one time, in columns and rows. Default: 1.
{"type": "integer", "minimum": 1, "default": 1}
statamic.blueprint.schema.json
earliest_date
Set the earliest selectable date in YYYY-MM-DD format.
{"oneOf": [{"format": "date"}, {"format": "date-time"}], "type": "string", "default": "1900-01-01"}
statamic.blueprint.schema.json
format
How the date should be stored, using the PHP date format. Default: 'Y-m-d' or 'Y-m-d H:m'
{"type": "string", "default": "'Y-m-d'"}
statamic.blueprint.schema.json
full_width
Enable to stretch the calendar out like Stretch Armstrong, using the maximum amount of available horizontal space. Default: false
{"type": "boolean", "default": false}
statamic.blueprint.schema.json
inline
Always show the calendar instead of the text input and dropdown UI. Default: false.
{"type": "boolean", "default": false}
statamic.blueprint.schema.json
mode
Choose between single or range. Range mode disables the time picker. Default: single.
{"type": "string", "enum": ["single", "range"], "default": "single"}
statamic.blueprint.schema.json
rows
Show multiple months at one time, in columns and rows. Default: 1.
{"type": "integer", "minimum": 1, "default": 1}
statamic.blueprint.schema.json
time_enabled
Enable/disable the timepicker. Default: false.
{"type": "boolean", "default": false}
statamic.blueprint.schema.json
time_required
Makes the time field visible and non-dismissible. Default: false.
{"type": "boolean", "default": false}
statamic.blueprint.schema.json
entries
{"type": "object", "properties": {"type": {"const": "entries"}, "max_items": {}, "mode": {}, "create": {"type": "boolean", "default": true}, "collections": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}}, "additionalProperties": true}
statamic.blueprint.schema.json
form
The Form fieldtype is gives your users a way to pick a form to include along with the current entry.
{"type": "object", "properties": {"type": {"const": "form"}, "placeholder": {}, "max_items": {"type": "integer", "default": 1}}, "additionalProperties": true}
statamic.blueprint.schema.json
grid
The grid fieldtype is a meta fieldtype, a fieldtype that serves as a container for more fieldtypes.
{"type": "object", "properties": {"type": {"const": "grid"}, "fields": {"type": "array", "items": {"type": "object"}}, "mode": {"type": "string", "enum": ["table", "stacked"]}, "min_rows": {"type": "integer", "minimum": 0}, "max_rows": {"type": "integer", "minimum": 1}, "add_row": {"type": "string", "minimum": 1}, "reorderable": {"type": "boolean", "default": true}}, "additionalProperties": true}
statamic.blueprint.schema.json
fields
A list of fields, each of which create their own column.
{"type": "array", "items": {"type": "object"}}
statamic.blueprint.schema.json
mode
The Grid is displayed as a table by default. If you have a large number of columns it can get pretty crowded. Choose stacked mode to group rows similar to Replicator. When Sneak Peek is enabled, Grids automatically toggle into stacked mode.
{"type": "string", "enum": ["table", "stacked"]}
statamic.blueprint.schema.json
min_rows
The minimum number of required rows.
{"type": "integer", "minimum": 0}
statamic.blueprint.schema.json
max_rows
The maximum number of rows allowed. Once reached the Add Row button will disappear.
{"type": "integer", "minimum": 1}
statamic.blueprint.schema.json
add_row
The Add Row button's label.
{"type": "string", "minimum": 1}
statamic.blueprint.schema.json
reorderable
The minimum number of required rows.
{"type": "boolean", "default": true}
statamic.blueprint.schema.json
hidden
The hidden field is perfect for setting default data when creating new entries.
{"type": "object", "properties": {"type": {"const": "hidden"}, "default": {"type": "string"}}, "additionalProperties": true}
statamic.blueprint.schema.json
html
If you've ever wanted to add a little HTML to your blueprint, this is the way to do it.
{"type": "object", "properties": {"type": {"const": "html"}, "html": {"type": ["string"]}}, "additionalProperties": true}