schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
api.json | type | The email action can be used to send emails via the Appsemble server.
If `to`, `cc`, and `bcc` all end up being empty, no emails will be sent but the action will still continue as normal.
| {"enum": ["email"]} |
api.json | to | The address the email should be sent to. Can be either in the format of `test@example.com`, or `John Doe <test@example.com>` | {} |
api.json | from | The name of the sender of the email. | {} |
api.json | cc | The list of additional email addresses email should be sent to. Uses the same format as `to`. Every email address in the CC is visible to all recipients. | {} |
api.json | bcc | The list of additional email addresses email should be sent to. Uses the same format as `to`. Email addresses in the BCC are hidden from other recipients. | {} |
api.json | subject | The subject of the email. | {} |
api.json | body | The body of the email. The content of the body is converted to HTML using the Markdown syntax. | {} |
api.json | attachments | The attachments to include in the email.
The remapper must resolve to an object containing the following properties:
- `target`: The asset ID or link to download contents from to add as an attachment. This is mutually exclusive with `content`.
- `content`: The raw content to include as the file content. This is mutua... | {} |
api.json | Error | The generic error object returned by any expected API errors. | {"type": "object", "readOnly": true, "additionalProperties": false, "properties": {"statusCode": {"type": "number", "example": 404}, "error": {"type": "string", "example": "Not Found"}, "message": {"type": "string", "example": "Entity not found"}}} |
api.json | statusCode | Matches the HTTP response status code. | {"type": "number", "example": 404} |
api.json | error | Matches the HTTP response status description. | {"type": "string", "example": "Not Found"} |
api.json | message | A message describing the error. | {"type": "string", "example": "Entity not found"} |
api.json | type | This action allows for other blocks to emit data upon triggering the action.
This can be used to make blocks interact with each other, such as triggering the `data-loader`
block to refresh itself by sending an event action that matches the name of what the block is
listening to.
| {"enum": ["event"]} |
api.json | event | The name of the event to emit. | {"type": "string"} |
api.json | waitFor | If specified, the action will wait for this event to have been emitted and respond with its data. | {"type": "string"} |
api.json | EventsDefinition | An object describing the names of the events the block can listen and emit to. | {"type": "object", "additionalProperties": false, "minProperties": 1, "properties": {"listen": {"type": "object", "minProperties": 1, "additionalProperties": {"type": "string"}}, "emit": {"type": "object", "minProperties": 1, "additionalProperties": {"type": "string"}}}} |
api.json | listen | This property defines the events this block will listen on.
The key is the name of the event will listen on. The value is a user defined event name which should
match the name of an emitted event on the same page.
| {"type": "object", "minProperties": 1, "additionalProperties": {"type": "string"}} |
api.json | emit | This property defines the events this block will emit.
The key is the name of the event will emit. The value is a user defined event name which should
match the name of a event on the same page that’s being listened on.
| {"type": "object", "minProperties": 1, "additionalProperties": {"type": "string"}} |
api.json | type | On [flow pages](#flow-page-definition-sub-pages), return to the previous page if
it is present. If this is called on the first page, nothing happens.
| {"enum": ["flow.back"]} |
api.json | type | On [flow pages](#flow-page-definition-sub-pages), triggers the
[`onFlowFinish`](#flow-page-actions-definition-on-flow-finish) action on the page.
| {"enum": ["flow.finish"]} |
api.json | type | On [flow pages](#flow-page-definition-sub-pages), proceed to the next page if it
is present. Otherwise, the flow is considered to be complete and [`flow.finish`](#flowfinish) will
be called instead.
| {"enum": ["flow.next"]} |
api.json | FlowPageActionsDefinition | These actions are fired on a flow page. | {"type": "object", "additionalProperties": false, "properties": {"onFlowCancel": {}, "onFlowFinish": {}}} |
api.json | onFlowCancel | This action gets triggered when `flow.cancel` gets called. | {} |
api.json | onFlowFinish | This action gets triggered when a flow is finished.
A flow is finished when `flow.finish` gets called, or when `flow.next` gets called on the final
subpage. This action has a special property in which the cumulative input data from each previous subpage gets sent, instead of the individual block that triggered this ac... | {} |
api.json | FlowPageDefinition | This describes what a page will look like in the app. | {"type": "object", "required": ["type", "steps", "name"], "additionalProperties": false, "properties": {"type": {"enum": ["flow"]}, "steps": {"type": "array", "minItems": 2, "items": {}}, "actions": {}, "progress": {"enum": ["corner-dots", "hidden"]}, "retainFlowData": {"type": "boolean", "default": true}, "name": {"ty... |
api.json | steps | Steps belonging to this page's flow. | {"type": "array", "minItems": 2, "items": {}} |
api.json | progress | The method that should be used to display the status of flow pages. | {"enum": ["corner-dots", "hidden"]} |
api.json | retainFlowData | Whether to retain the flow data when navigating away to another page outside the flow.
By default the flow page retains it's data after navigating once. Set to false to clear it.
| {"type": "boolean", "default": true} |
api.json | name | The name of an app.
This field is always required and must be unique within the app, meaning that it is not possible to
have two pages with the same name. The name of the page is displayed at the *app bar* of each page as well as in the side navigational menu.
> **Note**: The URL used to navigate to pages is determin... | {"type": "string", "maxLength": 50} |
api.json | hideName | Whether or not the page name should be displayed in the *app bar*. | {"type": "boolean"} |
api.json | navTitle | The name of the page when displayed in the navigation menu.
Context property `name` can be used to access the name of the page.
| {} |
api.json | hideNavTitle | Whether or not the page should be displayed in navigational menus.
By default all pages without parameters are added to navigational menus. Set to `true` to hide the
page from menus.
| {"type": "boolean", "default": false} |
api.json | navigation | The type of navigation displayed on the page.
This overrides the navigation property of the app itself. Defaults to `left-menu` if navigation or
App navigation are not set.
Set to `bottom` to use a navigation pane at the bottom of the screen instead of the default side
menu. Set to `hidden` to display no navigational... | {} |
api.json | icon | An optional icon from the fontawesome icon set
This will be displayed in the navigation menu.
| {"type": "string"} |
api.json | parameters | Page parameters can be used for linking to a page that should display a single resource.
This defined as a list of strings representing the properties to pass through. More often than not
passing `id` through is sufficient, depending on the block.
| {"type": "array", "items": {"type": "string", "minLength": 1, "maxLength": 30}} |
api.json | roles | The list of roles that are allowed to view this page.
If the user doesn’t have any of the roles in the list the page will be unavailable to them. An empty
list can be used to specify that users need to log in but do not need a specific role.
Users trying to visit a page without having the correct roles will be redire... | {"type": "array", "items": {"type": "string"}} |
api.json | type | On [flow pages](#flow-page-definition-sub-pages), move to a specific step. | {"enum": ["flow.to"]} |
api.json | step | The name of the step to move to.
This is a remapper which gets called with the action input and context.
| {} |
api.json | GoogleFontDefinition | A Google font definition. | {"type": "object", "additionalProperties": false, "required": ["family"], "properties": {"source": {"enum": ["google"]}, "family": {"enum": ["ABeeZee", "Abel", "Abhaya Libre", "Abril Fatface", "Aclonica", "Acme", "Actor", "Adamina", "Advent Pro", "Aguafina Script", "Akaya Kanadaka", "Akaya Telivigala", "Akronim", "Alad... |
api.json | source | Use a font from [Google Fonts](https://fonts.google.com). | {"enum": ["google"]} |
api.json | family | The font to use in the app.
Any font available on [Google Fonts](https://fonts.google.com) may be used.
| {"enum": ["ABeeZee", "Abel", "Abhaya Libre", "Abril Fatface", "Aclonica", "Acme", "Actor", "Adamina", "Advent Pro", "Aguafina Script", "Akaya Kanadaka", "Akaya Telivigala", "Akronim", "Aladin", "Alata", "Alatsi", "Aldrich", "Alef", "Alegreya", "Alegreya SC", "Alegreya Sans", "Alegreya Sans SC", "Aleo", "Alex Brush", "A... |
api.json | Health | A health check status | {"type": "object", "readOnly": true, "additionalProperties": false, "properties": {"database": {"type": "boolean"}}} |
api.json | database | Whether or not the database status is healthy | {"type": "boolean"} |
api.json | JSONPointer | A JSON pointer which may be used to reference a JSON schema. | {"type": "object", "additionalProperties": false, "required": ["$ref"], "properties": {"default": {}}} |
api.json | $ref | A JSON schema reference. | {"type": "string", "pattern": "^#\\/definitions\\/", "example": "#/definitions/MyReusableSchema"} |
api.json | default | The default value that will be used. | {} |
api.json | title | A short title of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 50} |
api.json | description | A description of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 5000} |
api.json | JSONSchemaAnyOf | A JSON schema which determines the value must match one or more of the given schemas. | {"type": "object", "additionalProperties": false, "required": ["anyOf"], "properties": {"anyOf": {"type": "array", "items": {}}, "examples": {"type": "array", "items": {}}, "default": {}}} |
api.json | properties | The JSON schema must match one or more of the given schemas. | {"type": "array", "items": {}} |
api.json | examples | An example value which is valid according to this schema. | {"type": "array", "items": {}} |
api.json | default | The default value which is used if no value is supplied. | {} |
api.json | title | A short title of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 50} |
api.json | description | A description of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 5000} |
api.json | JSONSchemaArray | A JSON schema for an array. | {"type": "object", "additionalProperties": false, "required": ["type"], "properties": {"type": {"enum": ["array"]}, "example": {"type": "array", "items": {"type": "array", "items": {}}}, "default": {"type": "array", "items": {}}, "maxItems": {"type": "integer", "minimum": 1}, "minItems": {"type": "integer", "minimum": ... |
api.json | type | The type of the JSON schema. An array means a list of data. | {"enum": ["array"]} |
api.json | example | An example array which is valid according to this schema. | {"type": "array", "items": {"type": "array", "items": {}}} |
api.json | default | The default value which is used if no value is supplied. | {"type": "array", "items": {}} |
api.json | maxItems | The minimum amount of items the array is allowed to have. | {"type": "integer", "minimum": 1} |
api.json | minItems | The maximum amount of items the array is allowed to have. | {"type": "integer", "minimum": 0} |
api.json | uniqueItems | If true, all items in the array need to be unique | {"type": "boolean", "default": false} |
api.json | items | This property describes what the items in an array should look like. | {} |
api.json | title | A short title of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 50} |
api.json | description | A description of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 5000} |
api.json | JSONSchemaBoolean | A JSON schema for a boolean. | {"type": "object", "additionalProperties": false, "required": ["type"], "properties": {"type": {"enum": ["boolean"]}, "examples": {"type": "array", "items": {"type": "boolean"}}, "default": {"type": "boolean"}, "enum": {"type": "array", "items": {"type": "boolean"}}, "const": {"type": "boolean"}}} |
api.json | type | The type of the JSON schema. A boolean means either true or false. | {"enum": ["boolean"]} |
api.json | items | An example boolean which is valid according to this schema. | {"type": "boolean"} |
api.json | default | The default value which is used if no value is supplied. | {"type": "boolean"} |
api.json | enum | If an enum is specified, the type can be safely removed. | {"type": "array", "items": {"type": "boolean"}} |
api.json | const | If const is specified, the type can be safely removed. | {"type": "boolean"} |
api.json | title | A short title of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 50} |
api.json | description | A description of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 5000} |
api.json | JSONSchemaConst | A JSON schema which describes a constant | {"type": "object", "additionalProperties": false, "required": ["const"], "properties": {"const": {"anyOf": [{"type": "boolean"}, {"type": "number"}, {"type": "string"}, {"enum": [null]}]}}} |
api.json | const | The given value must exactly match one the value specified here. | {"anyOf": [{"type": "boolean"}, {"type": "number"}, {"type": "string"}, {"enum": [null]}]} |
api.json | title | A short title of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 50} |
api.json | description | A description of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 5000} |
api.json | JSONSchemaEnum | A JSON schema for an enum. | {"type": "object", "additionalProperties": false, "required": ["enum"], "properties": {"enum": {"type": "array", "items": {"anyOf": [{"type": "boolean"}, {"type": "number"}, {"type": "string"}, {"enum": [null]}]}}, "enumDescriptions": {"type": "array", "items": {"type": "string"}}, "examples": {"type": "array", "items"... |
api.json | enum | A specific set of values this property is allowed to have. | {"type": "array", "items": {"anyOf": [{"type": "boolean"}, {"type": "number"}, {"type": "string"}, {"enum": [null]}]}} |
api.json | enumDescriptions | An array is descriptions for the enum values.
The description is applied to the enum value at the same index. | {"type": "array", "items": {"type": "string"}} |
api.json | items | An example which is valid according to this schema. | {"anyOf": [{"type": "boolean"}, {"type": "number"}, {"type": "string"}, {"enum": [null]}]} |
api.json | default | The default value which is used if no value is supplied. | {"anyOf": [{"type": "boolean"}, {"type": "number"}, {"type": "string"}, {"enum": [null]}]} |
api.json | title | A short title of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 50} |
api.json | description | A description of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 5000} |
api.json | JSONSchemaInteger | A JSON schema for an integer. | {"type": "object", "additionalProperties": false, "required": ["type"], "properties": {"type": {"enum": ["integer"]}, "examples": {"type": "array", "items": {"type": "integer"}}, "default": {"type": "integer"}, "enum": {"type": "array", "items": {"type": "integer"}}, "const": {"type": "integer"}, "minimum": {"type": "i... |
api.json | type | The type of the JSON schema. An integer means a fractionless number. | {"enum": ["integer"]} |
api.json | items | An example integer which is valid according to this schema. | {"type": "integer"} |
api.json | default | The default value which is used if no value is supplied. | {"type": "integer"} |
api.json | enum | If an enum is specified, the type can be safely removed. | {"type": "array", "items": {"type": "integer"}} |
api.json | const | If const is specified, the type can be safely removed. | {"type": "integer"} |
api.json | minimum | The minimum value of the number. | {"type": "integer", "example": 0} |
api.json | maximum | The maximum value of the number. | {"type": "integer", "example": 100} |
api.json | multipleOf | The value must be a multiple of this number.
For example, if this is set to 3, then the values 0, 3, 6, 9, etc. will be allowed, but not 1, 2, 4,
5, 7, 8, etc.
| {"type": "integer"} |
api.json | title | A short title of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 50} |
api.json | description | A description of the instance.
This is used in various places inside Appsemble Studio.
| {"type": "string", "minLength": 1, "maxLength": 5000} |
api.json | JSONSchemaMultiType | A JSON schema which defines multiple types. | {"type": "object", "additionalProperties": false, "required": ["type"], "properties": {"type": {"type": "array", "uniqueItems": true, "minItems": 2, "items": {"enum": ["array", "boolean", "integer", "null", "number", "string"]}}, "examples": {"type": "array", "items": {}}, "default": {}, "maxItems": {"type": "integer",... |
api.json | type | The type of the JSON schema. It’s recommended to use only one. | {"type": "array", "uniqueItems": true, "minItems": 2, "items": {"enum": ["array", "boolean", "integer", "null", "number", "string"]}} |
api.json | examples | An example which is valid according to this schema. | {"type": "array", "items": {}} |
api.json | default | The default value which is used if no value is supplied. | {} |
api.json | maxItems | The minimum amount of items the array is allowed to have. | {"type": "integer", "minimum": 1} |
api.json | minItems | The maximum amount of items the array is allowed to have. | {"type": "integer", "minimum": 0} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.