schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
api.json | method | HTTP method to use for this type of request. | {"type": "string", "default": "PUT"} |
api.json | url | URL to use for this type of request. | {"type": "string", "default": "/api/apps/{appId}/{resource}/{id}"} |
api.json | delete | Overrides for 'delete' requests. | {"type": "object", "additionalProperties": false, "properties": {"roles": {"type": "array", "items": {"type": "string"}}, "query": {"type": "object", "additionalProperties": {"type": "string"}}, "method": {"type": "string", "default": "DELETE"}, "url": {"type": "string", "default": "/api/apps/{appId}/{resource}/{id}"},... |
api.json | roles | The list of roles that are allowed to use this action.
This will override the default roles that are assigned.
| {"type": "array", "items": {"type": "string"}} |
api.json | query | The query parameters to use in the request. | {"type": "object", "additionalProperties": {"type": "string"}} |
api.json | method | HTTP method to use for this type of request. | {"type": "string", "default": "DELETE"} |
api.json | url | URL to use for this type of request. | {"type": "string", "default": "/api/apps/{appId}/{resource}/{id}"} |
api.json | type | Delete a resource. | {"enum": ["resource.delete"]} |
api.json | resource | The type of the resource to delete. | {"type": "string"} |
api.json | method | The type of request to make. | {"enum": ["delete", "get", "patch", "post", "put"], "default": "get"} |
api.json | query | A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is. | {} |
api.json | body | remapper that results in the request body to send.
If not specified, the raw input data is used.
| {} |
api.json | proxy | By default requests will be proxied through the Appsemble API.
This allows to protect user data and ensures
[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be
disabled by setting this to `false`
| {"type": "boolean", "default": true} |
api.json | schema | The name of the schema to validate against before submitting data. | {} |
api.json | type | Get a single resource. | {"enum": ["resource.get"]} |
api.json | resource | The type of the resource to get. | {"type": "string"} |
api.json | view | The view to use for the resource. | {"type": "string"} |
api.json | method | The type of request to make. | {"enum": ["delete", "get", "patch", "post", "put"], "default": "get"} |
api.json | query | A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is. | {} |
api.json | body | remapper that results in the request body to send.
If not specified, the raw input data is used.
| {} |
api.json | proxy | By default requests will be proxied through the Appsemble API.
This allows to protect user data and ensures
[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be
disabled by setting this to `false`
| {"type": "boolean", "default": true} |
api.json | schema | The name of the schema to validate against before submitting data. | {} |
api.json | ResourceHistoryDefinition | A definition of how versioning works for instances of this resource | {"type": "object", "additionalProperties": false, "required": ["data"], "properties": {"data": {"type": "boolean", "default": true}}} |
api.json | data | If set to `false`, edits are still tracked, but exactly what changed is lost. | {"type": "boolean", "default": true} |
api.json | ResourceHooksDefinition | Hooks that are triggered upon calling a resource action. | {"type": "object", "additionalProperties": false, "minProperties": 1, "properties": {"notification": {}}} |
api.json | type | Patch a resource. | {"enum": ["resource.patch"]} |
api.json | resource | The type of the resource to patch. | {"type": "string"} |
api.json | method | The type of request to make. | {"enum": ["delete", "get", "patch", "post", "put"], "default": "get"} |
api.json | query | A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is. | {} |
api.json | body | remapper that results in the request body to send.
If not specified, the raw input data is used.
| {} |
api.json | proxy | By default requests will be proxied through the Appsemble API.
This allows to protect user data and ensures
[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be
disabled by setting this to `false`
| {"type": "boolean", "default": true} |
api.json | schema | The name of the schema to validate against before submitting data. | {} |
api.json | type | Query a list of resources. | {"enum": ["resource.query"]} |
api.json | resource | The type of the resource to query. | {"type": "string"} |
api.json | view | The view to use for the resource. | {"type": "string"} |
api.json | method | The type of request to make. | {"enum": ["delete", "get", "patch", "post", "put"], "default": "get"} |
api.json | query | A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is. | {} |
api.json | body | remapper that results in the request body to send.
If not specified, the raw input data is used.
| {} |
api.json | proxy | By default requests will be proxied through the Appsemble API.
This allows to protect user data and ensures
[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be
disabled by setting this to `false`
| {"type": "boolean", "default": true} |
api.json | schema | The name of the schema to validate against before submitting data. | {} |
api.json | ResourceSubscription | This describes how a user is subscribed to a resource. | {"type": "object", "additionalProperties": false, "properties": {"create": {"type": "boolean"}, "update": {"type": "boolean"}, "delete": {"type": "boolean"}, "subscriptions": {"type": "object", "additionalProperties": {"type": "object", "additionalProperties": false, "properties": {"update": {"type": "boolean"}, "delet... |
api.json | create | If true, the user is subscribed to any create actions for the resource type | {"type": "boolean"} |
api.json | update | If true, the user is subscribed to any update actions for the resource type | {"type": "boolean"} |
api.json | delete | If true, the user is subscribed to any delete actions for the resource type | {"type": "boolean"} |
api.json | subscriptions | A mapping of resource IDs to individual resource subscriptions | {"type": "object", "additionalProperties": {"type": "object", "additionalProperties": false, "properties": {"update": {"type": "boolean"}, "delete": {"type": "boolean"}}}} |
api.json | additionalProperties | The subscription status of a user for a single resource. | {"type": "object", "additionalProperties": false, "properties": {"update": {"type": "boolean"}, "delete": {"type": "boolean"}}} |
api.json | update | If true, the user is subscribed to update actions on this particular resource. | {"type": "boolean"} |
api.json | delete | If true, the user will be notified when this particular resource is deleted. | {"type": "boolean"} |
api.json | type | Get the status of whether or not the user is subscriped to notifications for resource modifications. | {"enum": ["resource.subscription.status"]} |
api.json | resource | The type of the resource to get the subscription state for. | {"type": "string"} |
api.json | action | The resource action type to get the subscription state for. | {"enum": ["create", "delete", "update"]} |
api.json | type | Subscribe to notifications on resource modifications. | {"enum": ["resource.subscription.subscribe"]} |
api.json | resource | The type of the resource to subscribe to. | {"type": "string"} |
api.json | action | The resource action type to subscribe to. | {"enum": ["create", "delete", "update"]} |
api.json | type | Toggle whether or not to receive notifications on resource modifications. | {"enum": ["resource.subscription.toggle"]} |
api.json | resource | The type of the resource to toggle the subscription state for. | {"type": "string"} |
api.json | action | The resource action type to toggle the subscription state for. | {"enum": ["create", "delete", "update"]} |
api.json | type | Unsubscribe from notifications on resource modifications. | {"enum": ["resource.subscription.unsubscribe"]} |
api.json | resource | The type of the resource to unsubscribe from. | {"type": "string"} |
api.json | action | The resource action type to unsubscribe from. | {"enum": ["create", "delete", "update"]} |
api.json | type | Update a resource. | {"enum": ["resource.update"]} |
api.json | resource | The type of the resource to update. | {"type": "string"} |
api.json | method | The type of request to make. | {"enum": ["delete", "get", "patch", "post", "put"], "default": "get"} |
api.json | query | A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is. | {} |
api.json | body | remapper that results in the request body to send.
If not specified, the raw input data is used.
| {} |
api.json | proxy | By default requests will be proxied through the Appsemble API.
This allows to protect user data and ensures
[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be
disabled by setting this to `false`
| {"type": "boolean", "default": true} |
api.json | schema | The name of the schema to validate against before submitting data. | {} |
api.json | ResourceViewDefinition | Alternative views of a resource that are modified using remappers and support different sets of roles. | {"type": "object", "minProperties": 1, "additionalProperties": {"type": "object", "additionalProperties": false, "properties": {"roles": {"type": "array", "items": {"type": "string"}}, "remap": {}}}} |
api.json | additionalProperties | A custom view for a resource. | {"type": "object", "additionalProperties": false, "properties": {"roles": {"type": "array", "items": {"type": "string"}}, "remap": {}}} |
api.json | roles | The list of roles that are allowed to use this view. | {"type": "array", "items": {"type": "string"}} |
api.json | remap | The modified view. | {} |
api.json | SSLSecret | The SSL secret of an app. | {"type": "object", "additionalProperties": false, "properties": {"certificate": {"type": "string"}, "key": {"type": "string"}}} |
api.json | certificate | The public SSL certificate chain in PEM format. | {"type": "string"} |
api.json | key | The SSL private key in PEM format. | {"type": "string"} |
api.json | SSOConfiguration | A single sign on configuration which is exposed to users. | {"type": "object", "additionalProperties": false, "properties": {"url": {"type": "string", "format": "url"}, "name": {"type": "string"}, "icon": {"type": "string"}}} |
api.json | url | The URL users will be redirected to in the login process. | {"type": "string", "format": "url"} |
api.json | name | A user readable name for the configuration. | {"type": "string"} |
api.json | icon | A Font Awesome icon. | {"type": "string"} |
api.json | ScimPatchOp | A SCIM patch operation | {"type": "object", "required": ["schemas", "operations"], "additionalProperties": true, "properties": {"schemas": {"type": "array", "maxItems": 1, "minItems": 1, "items": {"enum": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"]}}, "operations": {"type": "array", "items": {"anyOf": [{"type": "object", "additionalPrope... |
api.json | operations | Patch operations to apply to the resource | {"type": "array", "items": {"anyOf": [{"type": "object", "additionalProperties": false, "required": ["op", "path", "value"], "properties": {"op": {"enum": ["add", "replace"]}, "name": {"type": "string"}, "path": {"type": "string"}, "value": {}}}, {"type": "object", "additionalProperties": false, "required": ["op", "pat... |
api.json | items | A SCIM patch single replace operation | {"type": "object", "additionalProperties": false, "required": ["op", "path", "value"], "properties": {"op": {"enum": ["add", "replace"]}, "name": {"type": "string"}, "path": {"type": "string"}, "value": {}}} |
api.json | items | A SCIM patch bulk replace operation | {"type": "object", "additionalProperties": false, "required": ["op", "path"], "properties": {"op": {"enum": ["remove"]}, "path": {"type": "string"}}} |
api.json | ScimSecret | An app’s SCIM configuration. | {"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean"}, "token": {"type": "string"}}} |
api.json | enabled | Whether or not SCIM is enabled for the app. | {"type": "boolean"} |
api.json | token | The secret SCIM token | {"type": "string"} |
api.json | ScimUser | The definition of a user according to the SCIM documentation. | {"type": "object", "additionalProperties": true, "required": ["emails", "schemas", "userName"], "properties": {"schemas": {"type": "array", "items": {"type": "string"}}, "userName": {"type": "string"}, "active": {"type": "boolean"}, "meta": {"type": "object", "additionalProperties": false, "properties": {"resourceType"... |
api.json | userName | A unique identifier for the user (generally maps to the Azure AD user principal name) | {"type": "string"} |
api.json | meta | Read-only metadata maintained by the service provider | {"type": "object", "additionalProperties": false, "properties": {"resourceType": {"type": "string"}, "created": {"type": "string"}, "lastModified": {"type": "string"}, "location": {"type": "string"}}} |
api.json | items | A user's email. By default, one of these should be of type 'work' and have 'primary' set to true. Value contains actual address | {"type": "object", "additionalProperties": false, "required": ["primary", "type", "value"], "properties": {"primary": {"type": "boolean"}, "type": {"type": "string"}, "value": {"type": "string"}}} |
api.json | SecurityDefaultDefinition | The default role to apply to members. | {"type": "object", "required": ["role"], "additionalProperties": false, "properties": {"policy": {"enum": ["everyone", "organization", "invite"], "default": "everyone"}, "role": {"type": "string"}}} |
api.json | policy | How the `default` role gets applied to users.
The following values are allowed:
- `everyone`: Every authenticated user gets the default role.
- `organization`: Every authenticated user gets the default role if they are in the same organization as the app.
- `invite`: The user has to manually get a role assigned.
> **... | {"enum": ["everyone", "organization", "invite"], "default": "everyone"} |
api.json | role | The default role to apply to members.
This must match with one of the roles defined within the security definition.
| {"type": "string"} |
api.json | SecurityDefinition | This describes how the app is secured. | {"type": "object", "required": ["default", "roles"], "additionalProperties": false, "properties": {"default": {}, "roles": {"type": "object", "minProperties": 1, "additionalProperties": {}}, "teams": {}}} |
api.json | roles | This property defines the user roles that are available within the app. | {"type": "object", "minProperties": 1, "additionalProperties": {}} |
api.json | teams | Define how teams are handled by the app. | {} |
api.json | SecurityRoleDefinition | This describes a security role. | {"type": "object", "additionalProperties": false, "properties": {"defaultPage": {"type": "string"}, "inherits": {"type": "array", "minItems": 1, "items": {"type": "string"}}}} |
api.json | description | The description of the role. | {"type": "string"} |
api.json | defaultPage | The default page to redirect users with this role to. | {"type": "string"} |
api.json | inherits | The name of the role to inherit from.
Note that this role must exist and can not inherit itself via this field or the `inherits` field
of the referenced role.
| {"type": "array", "minItems": 1, "items": {"type": "string"}} |
api.json | type | The `share` action can be used to display a prompt that allows the user to share something with others, primarily via social media.
Depending on whether the user’s browser supports a native share function it will either display a
native dialog for sharing links, or display a more limited fallback in a dialog.
| {"enum": ["share"]} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.