schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
api.json | 200 |
Get a partial app OAuth2 secret
Only public facing values are output on this endpoint.
| {"content": {"application/json": {"schema": {"type": "object", "properties": {"code": {"type": "string"}}}}}} |
api.json | post | Create a new app | {"tags": ["app"], "operationId": "createApp", "parameters": [{"in": "query", "name": "dryRun", "schema": {"type": "string"}}], "requestBody": {"content": {"multipart/form-data": {"schema": {"type": "object", "required": ["OrganizationId", "yaml"], "properties": {"domain": {}, "path": {}, "visibility": {}, "template": {}, "longDescription": {}, "yaml": {"type": "string"}, "OrganizationId": {}, "icon": {"type": "string", "format": "binary"}, "maskableIcon": {"type": "string", "format": "binary"}, "iconBackground": {"type": "string", "pattern": "^#[\\dA-Fa-f]{6}$"}, "coreStyle": {"type": "string"}, "sharedStyle": {"type": "string"}, "screenshots": {"type": "array", "items": {"type": "string", "format": "binary"}}}}, "encoding": {"coreStyle": {"contentType": "text/css"}, "sharedStyle": {"contentType": "text/css"}, "icon": {"contentType": "image/png,image/jpeg,image/tiff,image/webp"}, "screenshots": {"contentType": "image/png,image/jpeg,image/tiff,image/webp"}}}}}, "responses": {"201": {}}, "security": [{"studio": []}, {"cli": ["apps:write"]}]} |
api.json | parameters | Validate whether an app could be created without actually creating one. Must be set to ‘true’. | {"in": "query", "name": "dryRun", "schema": {"type": "string"}} |
api.json | yaml | The original YAML definition used to define the app. | {"type": "string"} |
api.json | icon | The app icon. | {"type": "string", "format": "binary"} |
api.json | maskableIcon | The app icon. | {"type": "string", "format": "binary"} |
api.json | iconBackground | The background color to use for the maskable icon. | {"type": "string", "pattern": "^#[\\dA-Fa-f]{6}$"} |
api.json | coreStyle | The custom style to apply to the core app. | {"type": "string"} |
api.json | sharedStyle | The custom style to apply to all parts of app. | {"type": "string"} |
api.json | screenshots | Screenshots to showcase in the store | {"type": "array", "items": {"type": "string", "format": "binary"}} |
api.json | 201 | The app that was created. | {} |
api.json | get | Get all existing apps. | {"tags": ["app"], "parameters": [{"name": "language", "schema": {"type": "string"}, "in": "query"}], "operationId": "queryApps", "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}, "security": [{"studio": []}, {}]} |
api.json | parameters | The language to include the translations of, if available | {"name": "language", "schema": {"type": "string"}, "in": "query"} |
api.json | 200 | The list of all apps. | {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}} |
api.json | get | Get a single app | {"tags": ["app"], "parameters": [{"name": "language", "schema": {"type": "string"}, "in": "query"}], "operationId": "getAppById", "responses": {"200": {}}, "security": [{"studio": []}, {}]} |
api.json | parameters | The language to include the translations of, if available | {"name": "language", "schema": {"type": "string"}, "in": "query"} |
api.json | 200 | The app that matches the given id. | {} |
api.json | patch | Update parts of an existing app | {"tags": ["app"], "operationId": "patchApp", "requestBody": {"content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"domain": {}, "path": {}, "visibility": {}, "template": {}, "longDescription": {}, "force": {"type": "boolean"}, "yaml": {"type": "string"}, "icon": {"type": "string", "format": "binary"}, "maskableIcon": {"type": "string", "format": "binary"}, "iconBackground": {"type": "string", "pattern": "^#[\\dA-Fa-f]{6}$"}, "coreStyle": {"type": "string"}, "sharedStyle": {"type": "string"}, "screenshots": {"type": "array", "items": {"type": "string", "format": "binary"}}, "showAppsembleLogin": {"type": "boolean"}, "showAppsembleOAuth2Login": {"type": "boolean"}, "emailName": {"type": "string"}, "emailHost": {"type": "string"}, "emailPassword": {"type": "string"}, "emailUser": {"type": "string"}, "emailPort": {"type": "string"}, "emailSecure": {"type": "boolean"}}}, "encoding": {"coreStyle": {"contentType": "text/css"}, "sharedStyle": {"contentType": "text/css"}, "icon": {"contentType": "image/png,image/jpeg,image/tiff,image/webp"}}}}}, "responses": {"200": {}}, "security": [{"studio": []}, {"cli": ["apps:write"]}]} |
api.json | force | Whether the locked property should be ignored. | {"type": "boolean"} |
api.json | yaml | The original YAML definition used to define the app. | {"type": "string"} |
api.json | icon | The app icon. | {"type": "string", "format": "binary"} |
api.json | maskableIcon | The app icon. | {"type": "string", "format": "binary"} |
api.json | coreStyle | The custom style to apply to the core app. | {"type": "string"} |
api.json | sharedStyle | The custom style to apply to all parts of app. | {"type": "string"} |
api.json | screenshots | Screenshots to showcase in the store | {"type": "array", "items": {"type": "string", "format": "binary"}} |
api.json | showAppsembleLogin | Whether the Appsemble login method should be shown. | {"type": "boolean"} |
api.json | showAppsembleOAuth2Login | Whether the Appsemble OAuth2 login method should be shown. | {"type": "boolean"} |
api.json | emailName | The name used for emails. | {"type": "string"} |
api.json | emailHost | The hostname of the SMTP server. | {"type": "string"} |
api.json | emailPassword | The password to use for SMTP authentication. This gets encrypted when stored. | {"type": "string"} |
api.json | emailUser | The username used to authenticate against the SMTP server. | {"type": "string"} |
api.json | emailPort | The port used for the SMTP server. | {"type": "string"} |
api.json | emailSecure | Whether TLS is being used. | {"type": "boolean"} |
api.json | 200 | The updated app. | {} |
api.json | delete | Delete an existing app | {"tags": ["app"], "operationId": "deleteApp", "responses": {"204": {}}, "security": [{"studio": []}]} |
api.json | 204 | The app was successfully deleted. | {} |
api.json | post | Update the locked property an app. | {"tags": ["app"], "operationId": "setAppLock", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["locked"], "properties": {"locked": {}}}}}}, "responses": {"204": {}}, "security": [{"studio": []}, {"cli": ["apps:write"]}]} |
api.json | locked | Whether the app should be locked. | {} |
api.json | 204 | Lock status successfully changed | {} |
api.json | get | Get the app’s email settings. | {"tags": ["app"], "operationId": "getAppEmailSettings", "responses": {"200": {"content": {"application/json": {"schema": {"type": "object", "properties": {"emailName": {"type": "string"}, "emailHost": {"type": "string"}, "emailPassword": {"type": "boolean"}, "emailUser": {"type": "string"}, "emailPort": {"type": "string"}, "emailSecure": {"type": "boolean"}}}}}}}, "security": [{"studio": []}, {"cli": ["apps:write"]}]} |
api.json | 200 | The current app email settings | {"content": {"application/json": {"schema": {"type": "object", "properties": {"emailName": {"type": "string"}, "emailHost": {"type": "string"}, "emailPassword": {"type": "boolean"}, "emailUser": {"type": "string"}, "emailPort": {"type": "string"}, "emailSecure": {"type": "boolean"}}}}}} |
api.json | emailName | The name used for emails. | {"type": "string"} |
api.json | emailHost | The hostname of the SMTP server. | {"type": "string"} |
api.json | emailPassword | Whether a password is set. | {"type": "boolean"} |
api.json | emailUser | The username used to authenticate against the SMTP server. | {"type": "string"} |
api.json | emailPort | The port used for the SMTP server. | {"type": "string"} |
api.json | emailSecure | Whether TLS is being used. | {"type": "boolean"} |
api.json | get | Get the current app icon. | {"tags": ["app"], "operationId": "getAppIcon", "responses": {"200": {"content": {"image/png": {}, "image/jpeg": {}, "image/tiff": {}, "image/webp": {}}}}} |
api.json | 200 | The icon of the app that matches the given id. | {"content": {"image/png": {}, "image/jpeg": {}, "image/tiff": {}, "image/webp": {}}} |
api.json | delete | Delete the current app icon. | {"tags": ["app"], "operationId": "deleteAppIcon", "responses": {"204": {}}, "security": [{"studio": []}, {"cli": ["apps:write"]}]} |
api.json | 204 | The icon has been successfully removed | {} |
api.json | delete | Delete the current app’s maskable icon. | {"tags": ["app"], "operationId": "deleteAppMaskableIcon", "responses": {"204": {}}, "security": [{"studio": []}, {"cli": ["apps:write"]}]} |
api.json | 204 | The icon has been successfully removed | {} |
api.json | get | Fetch all subscription settings of an app. | {"tags": ["app"], "parameters": [{}], "operationId": "getSubscription", "responses": {"200": {}}} |
api.json | 200 | The subscription settings. | {} |
api.json | post | Subscribe to an app’s push notifications | {"tags": ["app"], "operationId": "addSubscription", "requestBody": {"content": {"application/json": {"schema": {"type": "object", "required": ["endpoint", "keys"], "properties": {"endpoint": {"type": "string"}, "keys": {"type": "object", "required": ["p256dh", "auth"], "properties": {"p256dh": {"type": "string"}, "auth": {"type": "string"}}}}}}}}, "responses": {"204": {}}, "security": [{"app": ["openid"]}, {}]} |
api.json | schema | A serialized PushSubscription object | {"type": "object", "required": ["endpoint", "keys"], "properties": {"endpoint": {"type": "string"}, "keys": {"type": "object", "required": ["p256dh", "auth"], "properties": {"p256dh": {"type": "string"}, "auth": {"type": "string"}}}}} |
api.json | 204 | The subscription has successfully been registered. | {} |
api.json | patch | Subscribe to an app’s push notifications. If value isn’t set it will toggle between subscribing and unsubscribing. | {"tags": ["app"], "operationId": "updateSubscription", "requestBody": {"content": {"application/json": {"schema": {"type": "object", "required": ["endpoint", "resource", "action"], "properties": {"endpoint": {"type": "string", "format": "uri"}, "resource": {"type": "string"}, "action": {"type": "string", "enum": ["create", "update", "delete"]}, "value": {"type": "boolean"}, "resourceId": {"type": "number"}}}}}}, "responses": {"204": {}}, "security": [{"app": ["openid"]}, {}]} |
api.json | 204 | The subscription has successfully been updated. | {} |
api.json | get | Fetch all members of an app. | {"tags": ["app"], "operationId": "getAppMembers", "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}, "security": [{"studio": []}, {"app": ["openid"]}]} |
api.json | 200 | The list of app members. | {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}} |
api.json | parameters | The ID of the member on which to perform an operation | {"name": "memberId", "in": "path", "required": true, "schema": {}} |
api.json | get | Get an app member. | {"tags": ["app"], "operationId": "getAppMember", "responses": {"200": {"content": {"application/json": {"schema": {}}}}}, "security": [{"studio": []}, {"app": ["openid"]}]} |
api.json | 200 | The resulting app member. | {"content": {"application/json": {"schema": {}}}} |
api.json | post | Assign an app role to a member. | {"tags": ["app"], "operationId": "setAppMember", "requestBody": {"content": {"application/json": {"schema": {"type": "object", "required": ["role"], "properties": {"role": {"type": "string"}, "properties": {"type": "object", "additionalProperties": {"type": "string"}}}}}}}, "responses": {"200": {"content": {"application/json": {"schema": {}}}}}, "security": [{"studio": []}]} |
api.json | role | The role to assign. | {"type": "string"} |
api.json | properties | Any additional properties that are allowed to be set for members. | {"type": "object", "additionalProperties": {"type": "string"}} |
api.json | 200 | The resulting app member. | {"content": {"application/json": {"schema": {}}}} |
api.json | delete | Delete an app member. | {"tags": ["app"], "operationId": "deleteAppMember", "responses": {"204": {}}, "security": [{"studio": []}]} |
api.json | 204 | The app member was deleted successfully. | {} |
api.json | parameters | The ID of the member on which to perform an operation | {"name": "memberId", "in": "path", "required": true, "schema": {}} |
api.json | get | Get an app member’s profile picture.
This will return a 404 if the user has not uploaded one. | {"tags": ["app"], "operationId": "getAppMemberPicture", "responses": {"200": {"content": {"image/png": {}, "image/jpeg": {}, "image/tiff": {}, "image/webp": {}}}}} |
api.json | 200 | The profile picture of the app member. | {"content": {"image/png": {}, "image/jpeg": {}, "image/tiff": {}, "image/webp": {}}} |
api.json | get | Fetch all ratings of an app. | {"tags": ["app"], "operationId": "getAppRatings", "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}} |
api.json | 200 | The list of apps ratings. | {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}} |
api.json | post | Submit an app rating. | {"tags": ["app"], "operationId": "submitAppRating", "requestBody": {"content": {"application/json": {"schema": {"type": "object", "required": ["rating"], "properties": {"rating": {}}}}}}, "responses": {"200": {"content": {"application/json": {"schema": {}}}}}, "security": [{"studio": []}]} |
api.json | 200 | The submitted app rating. | {"content": {"application/json": {"schema": {}}}} |
api.json | post | Broadcast a push notification to every subscriber of the app. | {"tags": ["app"], "operationId": "broadcast", "requestBody": {"content": {"application/json": {"schema": {"type": "object", "required": ["body"], "properties": {"body": {"type": "string"}}}}}}, "responses": {"204": {}}, "security": [{"studio": []}]} |
api.json | schema | The data to include in the notification | {"type": "object", "required": ["body"], "properties": {"body": {"type": "string"}}} |
api.json | title | The title of the notification. This defaults to the name of the app if not otherwise specified. | {"type": "string"} |
api.json | body | The content of the notification | {"type": "string"} |
api.json | 204 | The notification has been successfully broadcasted. | {} |
api.json | get | Get a list of snapshots made of the app. | {"tags": ["app"], "operationId": "getAppSnapshots", "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "number"}, "$created": {"type": "string", "format": "date-time"}, "$author": {"type": "object", "properties": {"id": {}, "name": {}}}}}}}}}}, "security": [{"studio": []}, {"cli": ["apps:write"]}]} |
api.json | 200 | The available snapshots | {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "number"}, "$created": {"type": "string", "format": "date-time"}, "$author": {"type": "object", "properties": {"id": {}, "name": {}}}}}}}}} |
api.json | id | The ID of the snapshot. | {"type": "number"} |
api.json | $created | The creation date of the snapshot. | {"type": "string", "format": "date-time"} |
api.json | parameters | The ID of the snapshot | {"name": "snapshotId", "in": "path", "required": true, "schema": {"type": "number"}} |
api.json | schema | The ID of the snapshot. | {"type": "number"} |
api.json | get | Get a single snapshot made of the app. | {"tags": ["app"], "operationId": "getAppSnapshot", "responses": {"200": {"content": {"application/json": {"schema": {"type": "object", "properties": {"id": {"type": "integer"}, "yaml": {"type": "string"}, "$created": {"type": "string", "format": "date-time"}, "$author": {"type": "object", "properties": {"id": {}, "name": {}}}}}}}}}, "security": [{"studio": []}, {"cli": ["apps:write"]}]} |
api.json | 200 | The snapshot | {"content": {"application/json": {"schema": {"type": "object", "properties": {"id": {"type": "integer"}, "yaml": {"type": "string"}, "$created": {"type": "string", "format": "date-time"}, "$author": {"type": "object", "properties": {"id": {}, "name": {}}}}}}}} |
api.json | id | The ID of the snapshot. | {"type": "integer"} |
api.json | yaml | The app definition. | {"type": "string"} |
api.json | $created | The creation date of the snapshot. | {"type": "string", "format": "date-time"} |
api.json | post | Add one or multiple screenshots of an app. | {"tags": ["app"], "operationId": "createAppScreenshot", "requestBody": {"content": {"multipart/form-data": {"schema": {"type": "object", "properties": {"screenshots": {"type": "array", "minItems": 1, "items": {"type": "string", "format": "binary"}}}}, "encoding": {"screenshots": {"contentType": "image/png,image/jpeg,image/tiff,image/webp"}}}}}, "responses": {"201": {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "integer"}}}}}}, "security": [{"studio": []}, {"cli": ["apps:write"]}]} |
api.json | screenshots | Screenshots to showcase in the store | {"type": "array", "minItems": 1, "items": {"type": "string", "format": "binary"}} |
api.json | 201 | The screenshots have been successfully created. | {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "integer"}}}}} |
api.json | items | The ID of the newly created screenshot. | {"type": "integer"} |
api.json | get | Get a screenshot of an app. | {"tags": ["app"], "operationId": "getAppScreenshot", "responses": {"200": {}}} |
api.json | 200 | The app screenshot | {} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.