schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
api.json | url | The url that is being shared. | {} |
api.json | title | The title that should be shared. | {} |
api.json | text | The main body that should be shared. | {} |
api.json | type | The `static` action returns static data defined in the action definition.
This is useful for example for stubbing data.
| {"enum": ["static"]} |
api.json | value | The static value to return. | {} |
api.json | type | Append data to an existing array in storage.
If the storage entry is a single object, it turns it into an array to append the data on.
For example:
```yaml
type: storage.append
key: temp
value: { root }
storage: localStorage
remapBefore:
object.from:
text:
This is a new data item
value:
1
`... | {"enum": ["storage.append"]} |
api.json | key | The key of the storage entry. | {} |
api.json | value | The data to write on top of the storage entry. | {} |
api.json | storage | The mechanism used to store the data. | {"enum": ["indexedDB", "localStorage", "sessionStorage", "appStorage"], "default": "indexedDB"} |
api.json | type | Delete the item that is stored at the specified key.
For example:
```yaml
type: storage.delete
key: temp
storage: localStorage
```
| {"enum": ["storage.delete"]} |
api.json | key | The key of the storage entry to remove. | {} |
api.json | storage | The mechanism used to remove the data from. | {"enum": ["indexedDB", "localStorage", "sessionStorage", "appStorage"], "default": "indexedDB"} |
api.json | type | Read data from the app’s local storage.
For example:
```yaml
type: storage.read
key: temp
storage: localStorage
```
| {"enum": ["storage.read"]} |
api.json | key | The key of the storage entry. | {} |
api.json | storage | The mechanism used to read the data from. | {"enum": ["indexedDB", "localStorage", "sessionStorage", "appStorage"], "default": "indexedDB"} |
api.json | type | Subtract last item from a storage entry.
If the entry consists of only one item, turns it into a singular object.
If the entry is a single item, the entry is removed entirely.
For example:
```yaml
type: storage.subtract
key: temp
storage: localStorage
```
| {"enum": ["storage.subtract"]} |
api.json | key | The key of the storage entry. | {} |
api.json | storage | The mechanism used to read the data from. | {"enum": ["indexedDB", "localStorage", "sessionStorage", "appStorage"], "default": "indexedDB"} |
api.json | type | Update an existing item in storage, or update an item inside a stored array.
For example:
```yaml
type: storage.update
key: temp
item: 1
value: { root }
storage: localStorage
remapBefore:
object.from:
text: { prop: text }
value: { prop: value }
newField: "New field"
```
| {"enum": ["storage.update"]} |
api.json | key | The key of the storage entry. | {} |
api.json | item | The key of the item in an array to update. | {} |
api.json | value | The data to update the specified item with. | {} |
api.json | storage | The mechanism used to store the data. | {"enum": ["indexedDB", "localStorage", "sessionStorage", "appStorage"], "default": "indexedDB"} |
api.json | type | Write data to the app’s local storage.
For example:
```yaml
type: storage.write
key: temp
value: { root }
storage: localStorage
remapBefore:
object.from:
data:
cool data
value:
1
```
| {"enum": ["storage.write"]} |
api.json | key | The key of the storage entry. | {} |
api.json | value | The data to write to the storage entry. | {} |
api.json | storage | The mechanism used to store the data. | {"enum": ["indexedDB", "localStorage", "sessionStorage", "appStorage"], "default": "indexedDB"} |
api.json | SubPage | This describes what a sub page will look like in the app. | {"type": "object", "required": ["blocks"], "additionalProperties": false, "properties": {"name": {"type": "string", "minLength": 1, "maxLength": 50}, "blocks": {"type": "array", "minItems": 1, "items": {}}}} |
api.json | name | The name of the sub page. | {"type": "string", "minLength": 1, "maxLength": 50} |
api.json | blocks | The blocks that make up a page. | {"type": "array", "minItems": 1, "items": {}} |
api.json | TabsPageDefinition | This describes what a page will look like in the app. | {"type": "object", "required": ["type", "tabs", "name"], "additionalProperties": true, "properties": {"type": {"enum": ["tabs"]}, "tabs": {"type": "array", "minItems": 1, "items": {}}, "name": {"type": "string", "maxLength": 50}, "hideName": {"type": "boolean"}, "navTitle": {}, "hideNavTitle": {"type": "boolean", "defa... |
api.json | tabs | Each of the available tabs for the tabs page. | {"type": "array", "minItems": 1, "items": {}} |
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 | Get a list of all of the user’s teams. | {"enum": ["team.invite"]} |
api.json | id | The ID of the team to invite the user to. | {} |
api.json | email | The email address of the user to invite. | {} |
api.json | role | The role to invite the user as. | {"default": "member"} |
api.json | type | Get a list of all of the user’s teams. | {"enum": ["team.join"]} |
api.json | type | Get a list of all of the user’s teams. | {"enum": ["team.list"]} |
api.json | type | Get a list of a team's members | {"enum": ["team.members"]} |
api.json | id | The ID of a specific team to get the members from | {} |
api.json | TeamsDefinition | This defines how teams are handled by an app. | {"type": "object", "additionalProperties": false, "required": ["join", "invite"], "properties": {"join": {"enum": ["anyone", "invite"]}, "create": {"type": "array", "items": {"type": "string"}, "default": []}, "invite": {"type": "array", "items": {"type": "string"}}}} |
api.json | join | If this is set to `anyone`, any logged in user may join a team. If this is set to `invite`, only users may join who have been invited. | {"enum": ["anyone", "invite"]} |
api.json | create | A list of app roles which may create a team.
By default teams can only be created from Appsemble Studio. | {"type": "array", "items": {"type": "string"}, "default": []} |
api.json | invite | The roles here determine which users may invite a team member.
The special roles `$team:member` and `$team:manager` mean that users who are already member of manager of the team may also invite new members. | {"type": "array", "items": {"type": "string"}} |
api.json | Theme | A generic theme definition. | {"type": "object", "additionalProperties": false, "minProperties": 1, "properties": {"themeColor": {"type": "string", "pattern": "^#[\\dA-Fa-f]{6}$", "default": "#ffffff"}, "splashColor": {"type": "string", "pattern": "^#[\\dA-Fa-f]{6}$", "default": "#ffffff"}, "primaryColor": {"type": "string", "pattern": "^#[\\dA-Fa-... |
api.json | themeColor | The generic theme color of the app.
This is used for example in the URL bar on Android.
| {"type": "string", "pattern": "^#[\\dA-Fa-f]{6}$", "default": "#ffffff"} |
api.json | splashColor | The background color of the PWA splash screen.
This defaults to the theme color.
| {"type": "string", "pattern": "^#[\\dA-Fa-f]{6}$", "default": "#ffffff"} |
api.json | primaryColor | The primary color used within the app.
This is used in various elements like the navbar.
| {"type": "string", "pattern": "^#[\\dA-Fa-f]{6}$", "default": "#5393ff"} |
api.json | linkColor | The color used for links. | {"type": "string", "pattern": "^#[\\dA-Fa-f]{6}$", "default": "#0440ad"} |
api.json | infoColor | The color used for informational messages. | {"type": "string", "pattern": "^#[\\dA-Fa-f]{6}$", "default": "#a7d0ff"} |
api.json | successColor | The color used for successful actions. | {"type": "string", "pattern": "^#[\\dA-Fa-f]{6}$", "default": "#1fd25b"} |
api.json | warningColor | The color used for warning messages. | {"type": "string", "pattern": "^#[\\dA-Fa-f]{6}$", "default": "#fed719"} |
api.json | dangerColor | The color used for error messages. | {"type": "string", "pattern": "^#[\\dA-Fa-f]{6}$", "default": "#ff2800"} |
api.json | tileLayer | The tileLayer to use for Leaflet maps. | {"type": "string", "format": "uri", "default": "https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png"} |
api.json | font | The font to use in the app. | {"anyOf": [{}, {}]} |
api.json | type | This action throws a new exception based on the data that is passed through.
This can be used to create a custom error that ends up in the error action handler.
| {"enum": ["throw"]} |
api.json | User | An object representing a user. | {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string", "readOnly": true}, "name": {"type": "string"}, "email": {"type": "string"}, "locale": {"type": "string"}, "timezone": {"enum": ["Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmera", "Africa/Bam... |
api.json | id | The ID of the user. | {"type": "string", "readOnly": true} |
api.json | name | The display name of the user. | {"type": "string"} |
api.json | email | The primary email used for communication. | {"type": "string"} |
api.json | locale | The locale of the user. | {"type": "string"} |
api.json | timezone | The time zone of the user. | {"enum": ["Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Af... |
api.json | UserEmail |
An email address that is linked to a user.
Users may use any of their email addresses to login.
| {"type": "object", "required": ["email"], "additionalProperties": false, "properties": {"email": {"type": "string", "format": "email"}, "verified": {"type": "boolean", "readOnly": true}}} |
api.json | email | The email address that is registered | {"type": "string", "format": "email"} |
api.json | verified | Wether or not the email address has been verified by the user. | {"type": "boolean", "readOnly": true} |
api.json | type | Allows the user to login using an email address and a password.
Does nothing if the user is already logged in. | {"enum": ["user.login"]} |
api.json | password | The password to login with. | {} |
api.json | email | The email to login with. | {} |
api.json | type | Allows the user to register a new account using an email address and a password.
Does nothing if the user is already logged in. | {"enum": ["user.register"]} |
api.json | password | The password to login with. | {} |
api.json | email | The email to login with. | {} |
api.json | displayName | The display name of the user. | {} |
api.json | picture | The image to use for the profile picture of the user. | {} |
api.json | properties | The custom properties for the user.
Every value will be converted to a string. | {} |
api.json | type | Allows the user to update their existing account.
Does nothing if the user isn’t logged in. | {"enum": ["user.update"]} |
api.json | password | The new password. | {} |
api.json | email | The new email address. | {} |
api.json | displayName | The new display name of the user. | {} |
api.json | picture | The new profile picture of the user. | {} |
api.json | properties | The custom properties for the user.
Every value will be converted to a string. | {} |
api.json | app |
OAuth2 login for apps.
The authorization code flow is recommended. The password flow exists for legacy apps and will be
removed in the future.
| {"type": "oauth2", "flows": {"authorizationCode": {"authorizationUrl": "/connect/authorize", "tokenUrl": "/oauth2/token", "refreshUrl": "/oauth2/token", "scopes": {"email": "Read the user email address.", "openid": "Login the user to the requesting app using OpenID.", "profile": "Read the user profile, including the di... |
api.json | basic | Used for logging in to the web interface | {"type": "http", "scheme": "basic"} |
api.json | cli |
OAuth2 login for client credentials.
For example the Appsemble CLI uses this.
| {"type": "oauth2", "flows": {"clientCredentials": {"tokenUrl": "/oauth2/token", "scopes": {"apps:write": "Create and update apps", "blocks:write": "Register and update blocks, and publish new block versions.", "organizations:write": "Create and manage organizations.", "resources:read": "Read app resources on behalf of ... |
api.json | scim | Used SCIM clients | {"type": "http", "scheme": "bearer"} |
api.json | studio | Used for authenticating requests made using Appsemble studio interface. | {"type": "http", "scheme": "bearer", "bearerFormat": "jwt"} |
api.json | externalDocs | Appsemble developer documentation | {"url": "https://appsemble.app/docs"} |
api.json | info | Welcome to the Appsemble API.
The app studio can be found on
> https://appsemble.app
The OpenAPI explorer can be found on
> https://appsemble.app/api-explorer
| {"license": {"name": "LGPL", "url": "https://gitlab.com/appsemble/appsemble/blob/main/LICENSE.md"}, "version": "0.21.3"} |
api.json | 201 | A list of the OAuth2 secrets for the app. | {"content": {"application/json": {"schema": {}}}} |
api.json | 200 | A list of the OAuth2 secrets for the app. | {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}} |
api.json | 200 |
Get a partial app OAuth2 secret
Only public facing values are output on this endpoint.
| {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}} |
api.json | 200 | The updated OAuth2 secret. | {"content": {"application/json": {"schema": {}}}} |
api.json | 204 | The deleted OAuth2 secret. | {} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.