schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
api.json | pages | The pages of the app. | {"type": "array", "minItems": 1, "items": {"anyOf": [{}, {}, {}, {}]}} |
api.json | cron | A list of cron jobs that are associated with this app. | {"type": "object", "minProperties": 1, "additionalProperties": {}} |
api.json | anchors | Helper property that can be used to store YAML anchors. | {"type": "array", "minItems": 1, "items": {}} |
api.json | AppLayoutDefinition | The layout definition allows you to tweak several layout elements of the app. | {"type": "object", "additionalProperties": false, "minProperties": 1, "properties": {"login": {"enum": ["navbar", "navigation", "hidden"], "default": "navbar"}, "settings": {"enum": ["navbar", "navigation", "hidden"], "default": "navbar"}, "feedback": {"enum": ["navbar", "navigation", "hidden"], "default": "navigation"... |
api.json | login | The location of the login button. | {"enum": ["navbar", "navigation", "hidden"], "default": "navbar"} |
api.json | settings | The location of the settings button.
If set to `navigation`, it will only be visible if `login` is also visible in `navigation`.
| {"enum": ["navbar", "navigation", "hidden"], "default": "navbar"} |
api.json | feedback | The location of the feedback button.
If set to `navigation`, it will only be visible if `login` is also visible in `navigation`.
| {"enum": ["navbar", "navigation", "hidden"], "default": "navigation"} |
api.json | navigation | The navigation type to use.
If this is omitted, a collapsable side navigation menu will be rendered on the left.
| {"enum": ["bottom", "left-menu", "hidden"], "default": "left-menu"} |
api.json | AppMessages | The response object of an messages create call. | {"type": "object", "required": ["language", "messages"], "additionalProperties": false, "properties": {"language": {"type": "string"}, "messages": {}, "force": {"type": "boolean", "writeOnly": true}}} |
api.json | language | The language the messages represent. | {"type": "string"} |
api.json | force | If this is true, the app lock is ignored. | {"type": "boolean", "writeOnly": true} |
api.json | AppOAuth2Secret | Settings for login in apps using third party OAuth2 providers | {"type": "object", "required": ["authorizationUrl", "clientId", "clientSecret", "icon", "name", "scope", "tokenUrl"], "additionalProperties": false, "properties": {"id": {"type": "number", "readOnly": true}, "authorizationUrl": {"type": "string", "format": "uri"}, "tokenUrl": {"type": "string", "format": "uri"}, "clien... |
api.json | id | An autogenerated ID | {"type": "number", "readOnly": true} |
api.json | authorizationUrl | The OAuth2 redirect URL. | {"type": "string", "format": "uri"} |
api.json | tokenUrl | The URL to request access tokens from. | {"type": "string", "format": "uri"} |
api.json | clientId | The public client id which identifies Appsemble to the authorization server. | {"type": "string"} |
api.json | clientSecret | The OAuth2 client secret. | {"type": "string"} |
api.json | icon | A Font Awesome icon which represents the OAuth2 provider. | {"type": "string"} |
api.json | name | A display name which represents the OAuth2 provider. | {"type": "string"} |
api.json | scope | The login scope that will be requested from the authorization server. | {"type": "string"} |
api.json | userInfoUrl | The URL to request user info from | {"type": "string", "format": "uri"} |
api.json | remapper | A remapper to apply on retrieved user information from the user info endpoint. | {"type": "array", "items": {}} |
api.json | created | When the secret was created originally. | {"type": "string", "format": "date-time"} |
api.json | updated | When the secret was last updated. | {"type": "string", "format": "date-time"} |
api.json | AppServiceSecret | App service secret settings | {"type": "object", "required": ["urlPatterns", "authenticationMethod"], "additionalProperties": false, "properties": {"id": {"type": "number", "readOnly": true}, "serviceName": {"type": "string"}, "urlPatterns": {"type": "string"}, "authenticationMethod": {"enum": ["http-basic", "client-certificate", "client-credential... |
api.json | id | An autogenerated ID. | {"type": "number", "readOnly": true} |
api.json | serviceName | An optional name to give extra clarity what the secret is used for. | {"type": "string"} |
api.json | urlPatterns | The url pattern that is matched when a proxied request action is called. | {"type": "string"} |
api.json | authenticationMethod | The method to authenticate the request action with. | {"enum": ["http-basic", "client-certificate", "client-credentials", "cookie", "custom-header", "query-parameter"]} |
api.json | identifier | The parameter name, header name, username or certificate that goes with the secret. | {"type": "string"} |
api.json | secret | The secret to authenticate the proxied outgoing request with. | {"type": "string"} |
api.json | tokenUrl | The URL to request access tokens from. | {"type": "string"} |
api.json | AppsembleMessages | A mapping of the messages for this language | {"type": "object", "additionalProperties": false, "properties": {"core": {"type": "object", "additionalProperties": {"type": "string"}}, "app": {"type": "object", "additionalProperties": {"type": "string"}}, "blocks": {"type": "object", "additionalProperties": {"type": "object", "pattern": "^@([\\da-z](?:(?!.*--)[\\da-... |
api.json | core | Translations for the core of the app. | {"type": "object", "additionalProperties": {"type": "string"}} |
api.json | app | Translations for global block messages and meta properties of the app. | {"type": "object", "additionalProperties": {"type": "string"}} |
api.json | blocks | Translations for the core of the app. | {"type": "object", "additionalProperties": {"type": "object", "pattern": "^@([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)/([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$", "additionalProperties": {"type": "object", "pattern": "^\\d+\\.\\d+\\.\\d+$", "additionalProperties": {"type": "string"}}}} |
api.json | additionalProperties | The name of the block type. | {"type": "object", "pattern": "^@([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)/([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$", "additionalProperties": {"type": "object", "pattern": "^\\d+\\.\\d+\\.\\d+$", "additionalProperties": {"type": "string"}}} |
api.json | additionalProperties | The version of the block. | {"type": "object", "pattern": "^\\d+\\.\\d+\\.\\d+$", "additionalProperties": {"type": "string"}} |
api.json | messageIds | A list of custom message IDs used by the app. | {"type": "object", "additionalProperties": {"type": "string"}} |
api.json | ArrayRemapperDefinition | If a remapper is an array, it represents a chain of remappers.
Each item represents a remapper which is called with the result of the remapper before it.
If an array is nested, it will be flattened. This allows you to create reusable remappers and
reference them using YAML anchors.
| {"type": "array", "minItems": 1, "items": {"anyOf": [{}, {}]}} |
api.json | Asset | The response object of an asset create call. | {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string", "readOnly": true, "pattern": "^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$"}, "mime": {"type": "string", "readOnly": true}, "filename": {"type": "string", "readOnly": true}, "name": {"type": "string", "pattern": "^([\\da-z](?:(?!.*... |
api.json | id | The unique identifier for the asset. | {"type": "string", "readOnly": true, "pattern": "^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$"} |
api.json | mime | The IANA MIME type of the asset. | {"type": "string", "readOnly": true} |
api.json | filename | The filename of the asset. | {"type": "string", "readOnly": true} |
api.json | name | The given name of the asset. Assets may be referenced by their name or ID in the API. | {"type": "string", "pattern": "^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$"} |
api.json | BlockDefinition | A block that is displayed on a page. | {"type": "object", "required": ["type", "version"], "additionalProperties": false, "properties": {"theme": {}, "type": {"type": "string", "pattern": "^(@([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)/)?([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$"}, "version": {"type": "string", "pattern": "^\\d+\\.\\d+\\.\\d+$"}, "layout": {... |
api.json | type | The type of the block.
A block type follows the format `@organization/name`. If the organization is _appsemble_, it may
be omitted.
Some examples:
- `form`
- `@amsterdam/splash`
| {"type": "string", "pattern": "^(@([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)/)?([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$"} |
api.json | version | The version of the block to use.
Since blocks may change over time, a version must be specified in order to ensure that the block
will remain the same until it is manually updated.
| {"type": "string", "pattern": "^\\d+\\.\\d+\\.\\d+$"} |
api.json | layout | An override of the block’s default. | {"enum": ["float", "grow", "static"]} |
api.json | header | An optional header to render above the block. | {} |
api.json | roles | The list of roles that are allowed to view this block.
If a user does not have the right role, the block is not rendered.
| {"type": "array", "items": {"type": "string"}} |
api.json | position | For floating blocks this propert defines where the block should float. | {"default": "bottom right", "enum": ["top left", "top", "top right", "left", "right", "bottom left", "bottom", "bottom right"]} |
api.json | parameters | A free form mapping of named parameters.
The exact meaning of the parameters depends on the block type.
| {"type": "object", "additionalProperties": true} |
api.json | actions | A mapping of actions that can be fired by the block to action handlers. | {"type": "object", "additionalProperties": {}} |
api.json | BlockVersion | A version of a block definition
Block versions can’t be updated or deleted. This ensures apps that use a block version can never
be broken by alterations of block definitions.
| {"type": "object", "required": ["name", "version", "files"], "additionalProperties": false, "properties": {"name": {"type": "string", "readOnly": true, "pattern": "^@([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)/([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$"}, "longDescription": {"type": "string"}, "icon": {"type": "string", ... |
api.json | name | The name of a block.
This uses the same form as scoped npm packages. For example, `@appsemble/form`.
| {"type": "string", "readOnly": true, "pattern": "^@([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)/([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$"} |
api.json | description | The description of the block. | {"type": "string", "maxLength": 160} |
api.json | longDescription | The long description of the block. | {"type": "string"} |
api.json | icon | An icon to represent the block in Appsemble studio. | {"type": "string", "format": "binary"} |
api.json | iconUrl | The relative URL on which the icon is served | {"type": "string", "format": "uri", "readOnly": true} |
api.json | version | A [semver](https://semver.org) representation of the block version. | {"type": "string", "pattern": "^\\d+\\.\\d+\\.\\d+$"} |
api.json | visibility | Whether the block should be listed publicly for users who aren’t part of the block’s organization.
- **`public`**: The block is visible for everyone.
- **`unlisted`**: The block will only be visible if the user is logged in and is part of the block’s organization. | {"enum": ["public", "unlisted"], "default": "public"} |
api.json | layout | How the block will be displayed on the screen.
- **`float`**: The block will float somewhere on the screen.
- **`grow`**: The block will be positioned in the main page. It will grow to fill up remaining
space on the page.
- **`static`**: The block will be positioned in the main page. It will take up a fixed amount o... | {"default": "grow", "enum": ["float", "grow", "static", "hidden"]} |
api.json | actions | An object which describes the actions a block can trigger.
This will be used to validate app definitions.
| {"type": "object", "additionalProperties": true} |
api.json | parameters | A draft 7 JSON schema to use for block parameter validation.
If the parameters of a block definition don’t conform to this schema, the app definition will be
considered invalid.
| {} |
api.json | events | An object describing the names of the events the block can listen and emit to. | {"type": "object", "additionalProperties": false, "properties": {"listen": {"type": "object", "additionalProperties": {"type": "object", "additionalProperties": false, "properties": {}}}, "emit": {"type": "object", "additionalProperties": {"type": "object", "additionalProperties": false, "properties": {}}}}} |
api.json | listen | A mapping of events this block may listen on | {"type": "object", "additionalProperties": {"type": "object", "additionalProperties": false, "properties": {}}} |
api.json | additionalProperties | A mapping of events this block may listen on | {"type": "object", "additionalProperties": false, "properties": {}} |
api.json | emit | A mapping of events this block may emit | {"type": "object", "additionalProperties": {"type": "object", "additionalProperties": false, "properties": {}}} |
api.json | additionalProperties | A mapping of events this block may emit | {"type": "object", "additionalProperties": false, "properties": {}} |
api.json | resources | deprecated | {"type": "object", "additionalProperties": true} |
api.json | messages | The translated messages for the block.
English (`en`) messages are required.
| {"type": "object", "required": ["en"], "properties": {"en": {"type": "object", "additionalProperties": {"type": "string", "minLength": 1}}}, "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}} |
api.json | en | A mapping of language IDs to their English translation | {"type": "object", "additionalProperties": {"type": "string", "minLength": 1}} |
api.json | additionalProperties | The default translations to use. | {"type": "string", "minLength": 1} |
api.json | additionalProperties | A mapping of language IDs to their internationalized translation | {"type": "object", "additionalProperties": {"type": "string"}} |
api.json | additionalProperties | The translated messages for this language. | {"type": "string"} |
api.json | files | A list of file assets that belong to the app version. | {"type": "array", "minLength": 1, "items": {"type": "string", "format": "binary"}} |
api.json | examples | A list of exmples how the block can be used within an app definition. | {"type": "array", "items": {"type": "string"}} |
api.json | type | Run another action if a certain contition is met. | {"enum": ["condition"]} |
api.json | if | A remapper to determine the condition to check.
If this yields a truthy value, the `then` action is called. Otherwise the `else` action is
called.
| {} |
api.json | then | This action is called if the `if` remapper yields a truthy value. | {} |
api.json | else | This action is called if the `if` remapper yields a falsy value. | {} |
api.json | CronDefinition | A cron definition defines tasks that Appsemble will run periodically for the app. | {"type": "object", "required": ["schedule"], "additionalProperties": false, "properties": {"schedule": {"type": "string"}, "action": {}}} |
api.json | schedule | A crontab string to define when the action should be run.
See [Crontab guru](https://crontab.guru) for details
| {"type": "string"} |
api.json | action | The action to run when the cronjob is triggered. | {} |
api.json | CustomFontDefinition | A custom font definition. | {"type": "object", "additionalProperties": false, "required": ["source", "family"], "properties": {"source": {"enum": ["custom"]}, "family": {"type": "string"}}} |
api.json | source | Use a custom font. | {"enum": ["custom"]} |
api.json | family | The font family to use in the app.
Make sure the font is available using custom CSS.
| {"type": "string"} |
api.json | type | This action opens a pop-up dialog that can be used to seamlessly transition to a new set of blocks temporarily.
Dialogs can be closed by calling the [`dialog.ok`](#DialogOkActionDefinition) or
[`dialog.error`](#DialogErrorActionDefinition). Users can still manually close dialogs, which
should be supported by the app.
... | {"enum": ["dialog"]} |
api.json | title | An optional title to set in the dialog header. | {} |
api.json | closable | Whether users are allowed to close the dialog by clicking outside of it or on the close button. | {"type": "boolean", "default": true} |
api.json | fullscreen | Whether the dialog should be displayed full screen as if it’s a new page, or as a pop-up. | {"type": "boolean", "default": false} |
api.json | blocks | A list of blocks to display in the dialog. | {"type": "array", "items": {}} |
api.json | type | Close an open dialog.
The dialog action that opened the dialog will be rejected with the data passed to this action.
| {"enum": ["dialog.error"]} |
api.json | type | Close an open dialog.
The dialog action that opened the dialog will be rejected with the data passed to this action.
| {"enum": ["dialog.ok"]} |
api.json | type | Download the data as a file. | {"enum": ["download"]} |
api.json | filename | The filename to save the file as. This must include a file extension. | {"type": "string", "pattern": "\\."} |
api.json | type | Run an action for each entry in an array.
The actions are run in parallel.
If the input is not an array, the action will be applied to the input instead. | {"enum": ["each"]} |
api.json | serial | Runs the action in series instead of parallel | {"type": "boolean"} |
api.json | do | This action is called for each item in the input array. | {} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.