schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
api.json | level | The logging level on which to log. | {"enum": ["error", "info", "warn"], "default": "info"} |
api.json | LoopPageActionsDefinition | These actions are fired on a loop page. | {"type": "object", "required": ["onLoad"], "additionalProperties": false, "properties": {"onLoad": {}, "onFlowCancel": {}, "onFlowFinish": {}}} |
api.json | onLoad | This action is used to define the data to pass onto the loop type array | {} |
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 | LoopPageDefinition | This describes what a loop page will look like in the app.
!!
This feature is still under development and is very unstable
!!
| {"type": "object", "required": ["type", "foreach", "actions", "name"], "additionalProperties": false, "properties": {"type": {"enum": ["loop"]}, "actions": {}, "foreach": {}, "progress": {"enum": ["corner-dots", "hidden"]}, "retainFlowData": {"type": "boolean", "default": true}, "name": {"type": "string", "maxLength": ... |
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 | Run another action if one of the cases is true.
Only the first case that equals true is called. | {"enum": ["match"]} |
api.json | items | {"type": "object", "additionalProperties": false, "required": ["case", "action"], "properties": {"case": {}, "action": {}}} | |
api.json | case | The case to be matched. | {} |
api.json | action | Action to be called if the case equals true. | {} |
api.json | Member | A member of an organization. | {"type": "object", "required": ["id"], "additionalProperties": false, "properties": {"id": {}, "name": {}, "primaryEmail": {"type": "string", "format": "email"}, "role": {"enum": ["Member", "Translator", "APIReader", "APIUser", "AppEditor", "Maintainer", "Owner"]}, "properties": {"type": "object", "additionalProperties... |
api.json | primaryEmail | The primary email address of the user. | {"type": "string", "format": "email"} |
api.json | properties | Additional custom properties that a user might have. | {"type": "object", "additionalProperties": {"type": "string"}} |
api.json | type | Display a message to the user.
This is useful in combination with action chaining to notify users they have performed a certain action.
| {"enum": ["message"]} |
api.json | body | The body of the message. | {} |
api.json | color | The Bulma color to apply to the message. | {"enum": ["dark", "primary", "link", "success", "info", "warning", "danger"], "default": "info"} |
api.json | layout | The position of the message on the screen. | {"enum": ["bottom", "top"], "default": "bottom"} |
api.json | dismissable | Boolean value indicating whether the user is able to dismiss the message manually. | {"type": "boolean"} |
api.json | timeout | The time in milliseconds how long the message should be visible. | {"type": "integer", "default": 5000} |
api.json | type | Do nothing when this action is triggered.
This is the default action for block actions that are not required.
| {"enum": ["noop"]} |
api.json | NotificationHookDataDefinition | The data used to display the content of the notification. | {"type": "object", "additionalProperties": true, "minProperties": 1, "properties": {"content": {}, "link": {"type": "string"}}} |
api.json | title | The title of the notification. | {} |
api.json | content | The body of the notification. | {} |
api.json | link | The URL of the page the user gets redirected to after being clicked.
If the URL is relative, it will be relative to the app.
| {"type": "string"} |
api.json | NotificationHookDefinition | The strategy used to notify users. | {"type": "object", "additionalProperties": false, "minProperties": 1, "properties": {"to": {"type": "array", "minItems": 1, "items": {"type": "string"}}, "subscribe": {"enum": ["all", "single", "both"]}, "data": {}}} |
api.json | to | The list of roles to notify.
Aside from roles, `$author` can also be used to notify the author of the resource.
| {"type": "array", "minItems": 1, "items": {"type": "string"}} |
api.json | subscribe | If set, allows users to manually subscribe for notifications for this resource regardless of roles.
The following values are allowed:
- `all`: Allows users to be notified about actions on all of the resources of this type.
- `single`: Allows users to be notified about actions a single instance of a resource of this
... | {"enum": ["all", "single", "both"]} |
api.json | type | Send notifications to one or all the users of an app. | {"enum": ["notify"]} |
api.json | title | The title of the notification. | {} |
api.json | body | The description of the notification. | {} |
api.json | to | To whom the notification should be sent.
Use `all` to send the notification to all app subscribed users.
Or notify specific users by passing either a single user id or an array of user ids.
Nothing is sent if the value is **not** a valid user id.
| {} |
api.json | OAuth2AuthorizationCode | OAuth2 client credentials | {"type": "object", "required": ["code"], "additionalProperties": false, "properties": {"code": {"type": "string", "readOnly": true}}} |
api.json | code | The OAuth2 authorization code. | {"type": "string", "readOnly": true} |
api.json | OAuth2ClientCredentials | OAuth2 client credentials | {"type": "object", "required": ["description", "scopes"], "additionalProperties": false, "properties": {"id": {"type": "string", "readOnly": true}, "secret": {"type": "string", "readOnly": true}, "expires": {"type": "string", "format": "date-time"}, "scopes": {"type": "array", "items": {"enum": ["apps:write", "blocks:w... |
api.json | id | The generated client id | {"type": "string", "readOnly": true} |
api.json | secret | The generated client secret | {"type": "string", "readOnly": true} |
api.json | description | A description for the user to recognize the client. | {"type": "string", "maxLength": 50} |
api.json | expires | When the client credentials expire automatically. | {"type": "string", "format": "date-time"} |
api.json | scopes | The scopes that have been granted to the client. | {"type": "array", "items": {"enum": ["apps:write", "blocks:write", "organizations:write", "resources:read", "resources:write", "assets:write", "teams:read", "teams:write"]}} |
api.json | ObjectRemapperDefinition | An object based remapper is defined by a specific implementation
Object based remappers may only define 1 key. The allowed value depends on the remapper.
| {"type": "object", "minProperties": 1, "maxProperties": 1, "additionalProperties": false, "properties": {"array.map": {}, "array.unique": {}, "array.from": {"type": "array", "items": {}}, "array.append": {"type": "array", "items": {}}, "array.omit": {"type": "array", "items": {}}, "if": {"type": "object", "additionalPr... |
api.json | array.map |
The remapper goes through the given array and applies the given remappers on each individual item.
This can be very handy when sorting arrays by certain data. The remapper always returns an array.
Output can be an empty array if the supplied data isn’t an array.
For example, if you want to sort through a list of peop... | {} |
api.json | array.unique |
Filters out unique values from an array. The value Remapper is applied to each entry in the array
using its result to determine uniqueness.
If the value Remapper results in undefined or null, the entire entry is used for uniqueness.
If the input is not an array, the input is returned without any modifications.
Inpu... | {} |
api.json | array.from |
Creates a new array based on a provided array of remappers. This array can also consist of static
values.
For example:
```yaml
array.from:
- Peter
- Otto
- Harry
```
```json
["Peter", "Otto", "Harry"]
```
This remapper can also be used to convert given data into an array.
Input:
```json
{
"name": "Peter"... | {"type": "array", "items": {}} |
api.json | array.append |
Append new values to the end of an array. If the input is not an array an empty array is returned.
Using the array from the previous example, we can add a new object on top of it using this remapper:
```yaml
array.append:
- object.from:
name: James
occupation: News reporter
```
Result:
```json
[
{
... | {"type": "array", "items": {}} |
api.json | array.omit |
Remove values from an array. The input is expected to be the index(es) of the items to be deleted.
Accepts an array of static or remapper values.
With the previous example we added a new person to the list of people, so now we can remove that
person. We already know the index of this person in the array is `3`, so it... | {"type": "array", "items": {}} |
api.json | if | Check if condition results in a truthy value.
Returns value of `then` if condition is truthy, otherwise it returns the value of `else`.
For example:
```yaml
if:
condition: { equals: [{ prop: inputValue }, 4] }
then:
static: You guessed right!
else:
static: You guessed wrong!
```
If the `inputValue` is... | {"type": "object", "additionalProperties": false, "required": ["condition", "then", "else"], "properties": {"condition": {}, "then": {}, "else": {}}} |
api.json | condition | The condition to check. | {} |
api.json | then | This remapper is used if the condition returns true. | {} |
api.json | else | This remapper is used if the condition returns false. | {} |
api.json | equals | Compare all computed remapper values against each other.
Returns `true` if all entries are equal, otherwise `false`.
In the following example, if the `inputValue` and `expectedValue` are of the same value, the
condition will return `true` and the `then` remapper will fire.
```yaml
condition:
equals:
- prop: in... | {"type": "array", "items": {}} |
api.json | gt | **(gt = Greater than)**
Compare the first computed remapper value with the second computed remapper value.
Returns `true` if the first entry is greater than the second entry.
For example, if `stock` is more than 5 here, it returns `true`.
```yaml
condition:
gt:
- prop: stock
- 5
```
| {"type": "array", "minItems": 2, "maxItems": 2, "items": {}} |
api.json | lt | **(lt = Lesser than)
Compare the first computed remapper value with the second computed remapper value.
Returns `true` if the first entry is lesser than the second entry.
For example, if `stock` is less than 5 here, it returns `true`.
```yaml
condition:
lt:
- prop: stock
- 5
```
| {"type": "array", "minItems": 2, "maxItems": 2, "items": {}} |
api.json | not | Compare all computed remapper values against the first.
Returns `false` if all entries are equal to the first entry, otherwise `true`.
If only one remapper or none is passed, the remapper value gets computed and then inverted.
If `number` in the following example is something other than 4, the condition returns `tru... | {"type": "array", "items": {}} |
api.json | match | Check if any case results in a truthy value.
Returns the value of the first case where the condition equals true, otherwise returns null.
In the following example, let's say the `Gem` is a "Ruby". The match remapper then returns
`value: 75`.
```yaml
match:
- case: { equals: [{ prop: Gem }, Diamond] }
value: 10... | {"type": "array", "items": {"type": "object", "additionalProperties": false, "required": ["case", "value"], "properties": {"case": {}, "value": {}}}} |
api.json | items | {"type": "object", "additionalProperties": false, "required": ["case", "value"], "properties": {"case": {}, "value": {}}} | |
api.json | case | The condition to check. | {} |
api.json | value | This remapper is used if the case is true | {} |
api.json | array | Get the current array.map’s index or length.
Returns nothing when not in the context of `array.map’s`.
For example:
Input:
```json
["a", "b", "c"]
```
This remapper definition maps through the input array and creates an object with the length of the
array and the current index of the loop:
```yaml
array.map:
obje... | {"enum": ["index", "length"]} |
api.json | app | Gives actual information about the current app. Using this remapper you will have access to the
following information:
- `id`: App ID
- `locale`: Current locale (user selected language) of the app
- `url`: Base URL of the app
Example:
```json
{
"id": 11,
"locale": "en",
"url": "https://example-app.examplecompa... | {"enum": ["id", "locale", "url"]} |
api.json | context | Gets a property from custom context passed by blocks. This property is specific to each block. To
understand what the context of a certain block does, check the block’s description.
For this example, we will take the [`table`](/blocks/@appsemble/table/0.20.39) block. As of now,
this block provides two options for cont... | {"type": "string"} |
api.json | history | > **Note:** This remapper is explained more in depth in the [History](/docs/remapper/history) page
Gives the data at the history entry at the specified history index. The history at specified index
is the data that is passed to that action.
```yaml
remapBefore:
object.from:
title: Most influential bands of all ... | {"type": "integer"} |
api.json | step |
While in a loop page, this remapper allows you to get properties from the data at the current index.
```yaml
name: Survey
type: loop
actions:
onLoad:
type: resource.query
resource: questions
foreach:
blocks:
- type: detail-viewer
version: 0.20.39
parameters:
fields:
- la... | {"type": "string"} |
api.json | page | Gives actual information about the current page. This remapper gives access to the following
information:
- `data`: Current page data (FlowPage)
- `url`: Full URL of the current page
Example:
```json
{
"data": {
"name": "Peter"
},
"url": "https://example-app.examplecompany.appsemble.app/en/example-page-a"
... | {"enum": ["data", "url"]} |
api.json | prop | Gets the chosen property from an object.
```json
{
"name": "John",
"age": 52
}
```
```yaml
prop: name
```
Result:
```json
"John"
```
| {"anyOf": [{"type": "string"}, {"type": "integer"}, {"type": "array", "minItems": 1, "items": {"anyOf": [{"type": "string"}, {"type": "integer"}]}}]} |
api.json | root | Gets the input data as it was initially passed to the remapper function.
```yaml
type: resource.query
resource: people
query:
object.from:
$filter: city eq 'Eindhoven'
onSuccess:
remapBefore:
object.from:
name: Residents of Eindhoven
people:
root: null
```
Result:
```json
{
"name": ... | {"enum": [null]} |
api.json | static | Create a static value
```yaml
static: Hello!
```
Returns the following string:
```
Hello!
```
| {} |
api.json | translate | > **Note:** This is explained much more in depth at [Translating](/docs/03-guide/translating)
This remapper allows you to easily add translations to your app. To make this remapper work, replace
any static text with `translate: {name}`. Then, in your app’s Translations page pick the language
you want to translate. You... | {"type": "string"} |
api.json | user |
> **Note:** For this remapper to work, the user that activated the remapper has to be logged in to
> the app
Provides some fields of user information taken from the OpenID user info. These fields are:
- `email`: User’s **primary** email address
- `email_verified`: Whether the user’s primary email address is verified... | {"enum": ["sub", "name", "email", "email_verified", "picture", "profile", "locale"]} |
api.json | date.add | Adds a specified date value to the provided date.
The value to add should be specified according to the
[parse-duration](https://www.npmjs.com/package/parse-duration) API. If you want to add a day to a
date for example, the syntax would be `date.add: 1d`.
Full list of supported unit types:
- nanoseconds (ns)
- micros... | {"type": "string"} |
api.json | date.format | Format a date according to the RFC3339 format.
Here is an example of a RFC3339 complicit date:
`2002-10-02T15:00:00Z`
In an app definition, it’s best to use this when you want to display a date in a specific format.
For example, if your app has a form with a Datepicker field the incoming data will be formatted
as a s... | {"enum": [null]} |
api.json | date.now | Returns the current date as a JavaScript Date object.
```yaml
date.now: null
```
Result:
```js
"Mon Jul 03 2023 11:47:18 GMT+0200 (Midden-Europese zomertijd)"
```
| {"enum": [null]} |
api.json | date.parse | Convert a string to a date using a given format.
For example:
```yaml
- static: 02/11/2014 # The date string to parse
- date.parse: MM/dd/yyyy # The given format to parse the date with
# => Tue Feb 11 2014 00:00:00
```
See [date-fns](https://date-fns.org/v2.29.3/docs/parse) for the supported formats.
... | {"type": "string"} |
api.json | from.history | Creates a new object based on the specified properties in the given history index. This can be very
useful when you want to combine two sources of data together. It’s also cleaner than separately
using `object.from` together with `history`.
In the following example, you can see why this might be handy. Let’s say you g... | {"type": "object", "required": ["index", "props"], "additionalProperties": false, "properties": {"index": {"type": "integer"}, "props": {"additionalProperties": {}}}} |
api.json | index | The index of the history stack item to assign.
0 is the index of the first item in the history stack.
| {"type": "integer"} |
api.json | props | Predefined mapper keys to choose what properties to apply. | {"additionalProperties": {}} |
api.json | assign.history | Assigns properties from the specified history stack index to an existing object.
Similarly to the `from.history` remapper, this allows you to get a property from a place in the
history and give it to a new object. The only difference here is that you are not creating an
entirely new object, but you are taking an existi... | {"type": "object", "required": ["index", "props"], "additionalProperties": false, "properties": {"index": {"type": "integer"}, "props": {"additionalProperties": {}}}} |
api.json | index | The index of the history stack item to assign.
0 is the index of the first item in the history stack.
| {"type": "integer"} |
api.json | props | Predefined mapper keys to choose what properties to assign. | {"additionalProperties": {}} |
api.json | omit.history | Assigns properties from the specified history stack index to the current value and excludes the
given properties.
Similarly to the other history remappers, this gives you the data from a certain point in the
history stack and allows you to modify it before adding to the current value. This one, however,
allows you to ... | {"type": "object", "required": ["index", "keys"], "additionalProperties": false, "properties": {"index": {"type": "integer"}, "keys": {"type": "array", "items": {"minItems": 1, "anyOf": [{"type": "string"}, {"type": "array", "minItems": 2, "items": {"type": "string"}}]}}}} |
api.json | index | The index of the history stack item to assign.
0 is the index of the first item in the history stack.
| {"type": "integer"} |
api.json | keys | Exclude properties from the history stack item, based on the given object keys.
Nested properties can be excluded using arrays of keys.
For example:
```yaml
omit.history:
index: 0
keys:
- foo # Excludes the property foo
- - bar # Excludes the property baz inside of bar
- baz
```
| {"type": "array", "items": {"minItems": 1, "anyOf": [{"type": "string"}, {"type": "array", "minItems": 2, "items": {"type": "string"}}]}} |
api.json | object.assign |
Let’s say you have an existing object that you want to add an additional value on top of. For this
you can use the `object.assign` remapper. The remapper takes an existing object and allows the user
to assign their own value on top of that.
Input:
```json
{
"title": "Weekly fishing 21"
}
```
```yaml
object.assig... | {"additionalProperties": {}} |
api.json | object.from |
With this remapper you can create an entirely new object based on input values and other remappers.
`object.from` itself accepts remapper functions as its input which allows you to chain multiple
remappers together to make complex objects.
As a base, the remapper looks like this:
```yaml
object.from:
username: Ch... | {"additionalProperties": {}} |
api.json | object.omit |
In contrary to the previous remapper, what if you have an object from which you want to remove a
value? Then you can use `object.omit`. The remapper can remove properties from an existing object
based on the given object keys. This includes nested properties.
Input:
```json
{
"title": "Weekly fishing 21",
"auth... | {"type": "array", "items": {"minItems": 1, "anyOf": [{"type": "string"}, {"type": "array", "minItems": 2, "items": {"type": "string"}}]}} |
api.json | random.choice | Pick and return a random entry from an array. If the input is not an array, the input is returned as-is.
For example:
If you input the following array:
```json
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
```
```yaml
random.choice: null
```
The result could return any one of these numbers.
You can also combine different data... | {"enum": [null]} |
api.json | random.integer | Pick and return a random integer between the provided lowest and highest values.
For example:
```yaml
random.integer:
- 0
- 1000
```
Returns a random integer between 0 and 1000.
| {"type": "array", "maxItems": 2, "minItems": 2, "items": {"type": "integer"}} |
api.json | random.float | Pick and return a random float value between the provided lowest and highest values.
For example:
```yaml
random.float:
- 0
- 1
```
Returns a random float value between 0 and 1.
| {"type": "array", "maxItems": 2, "minItems": 2, "items": {"type": "number"}} |
api.json | random.string | Pick and return a random string from a given length using characters from a given input string defined in `choice`.
For example:
```yaml
random.string:
choice: abcdefghijklmnopqrstuvwxyz0123456789
length: 6
```
Returns a randomized string that is 6 characters long and consists of any characters in the `choice` fie... | {"type": "object", "required": ["choice", "length"], "additionalProperties": false, "properties": {"choice": {"type": "string", "minLength": 1}, "length": {"type": "integer", "minimum": 1}}} |
api.json | string.case | Convert a string to upper or lower case.
```yaml
string.case: upper
```
Result:
```json
"PATRICK"
```
| {"enum": ["lower", "upper"]} |
api.json | string.format | Format a string using remapped input variables.
Useful for replacing static text with generated values.
```yaml
string.format:
template: 'You have won €{lotteryAmount} in the lottery!!'
values:
lotteryAmount: { prop: lotteryPrize }
```
Result:
```json
"You have won €5000 in the lottery!!"
```
> **Tip:** Con... | {"type": "object", "additionalProperties": false, "properties": {"messageId": {"type": "string"}, "template": {"type": "string"}, "values": {"additionalProperties": {}}}} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.