schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
api.json | delete | Delete an existing screenshot. | {"tags": ["app"], "operationId": "deleteAppScreenshot", "responses": {"200": {}}, "security": [{"studio": []}, {"cli": ["apps:write"]}]} |
api.json | 200 | The screenshot has been successfully deleted. | {} |
api.json | get | Get the core style for this app. | {"tags": ["app"], "operationId": "getAppCoreStyle", "responses": {"200": {"content": {"text/css": {}}}}} |
api.json | 200 | The core stylesheet associated with this app. | {"content": {"text/css": {}}} |
api.json | get | Get the shared style for this app. | {"tags": ["app"], "operationId": "getAppSharedStyle", "responses": {"200": {"content": {"text/css": {}}}}} |
api.json | 200 | The shared stylesheet associated with this app. | {"content": {"text/css": {}}} |
api.json | get | Get the app style for a block. | {"tags": ["app"], "operationId": "getAppBlockStyle", "responses": {"200": {"content": {"text/css": {}}}}} |
api.json | 200 | The stylesheet associated with this block for this app. | {"content": {"text/css": {}}} |
api.json | post | Upload a block stylesheet for this app. | {"tags": ["app"], "operationId": "setAppBlockStyle", "requestBody": {"content": {"application/json": {"schema": {"type": "object", "required": ["style"], "properties": {"style": {"type": "string"}, "force": {"type": "boolean", "writeOnly": true}}}}}}, "responses": {"204": {}}, "security": [{"studio": []}, {"cli": ["apps:write"]}]} |
api.json | requestBody | The new app block stylesheet. | {"content": {"application/json": {"schema": {"type": "object", "required": ["style"], "properties": {"style": {"type": "string"}, "force": {"type": "boolean", "writeOnly": true}}}}}} |
api.json | force | If this is true, the app lock is ignored. | {"type": "boolean", "writeOnly": true} |
api.json | 204 | The block style has been updated successfully. | {} |
api.json | get | Get a list of app teams. | {"tags": ["app"], "operationId": "getTeams", "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "number"}, "name": {"type": "string"}, "role": {"type": "string", "enum": ["member", "manager"]}}}}}}}}, "security": [{"studio": []}, {"app": ["teams:read"]}]} |
api.json | 200 | The list of all teams. | {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "properties": {"id": {"type": "number"}, "name": {"type": "string"}, "role": {"type": "string", "enum": ["member", "manager"]}}}}}}} |
api.json | items | An app team | {"type": "object", "properties": {"id": {"type": "number"}, "name": {"type": "string"}, "role": {"type": "string", "enum": ["member", "manager"]}}} |
api.json | role | The role of the user requesting the list of teams | {"type": "string", "enum": ["member", "manager"]} |
api.json | post | Create a new team. | {"tags": ["app"], "operationId": "createTeam", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}, "annotations": {"type": "object", "additionalProperties": {"type": "string"}}}}}}}, "responses": {"201": {"content": {"application/json": {"schema": {"type": "object", "properties": {"id": {"type": "number"}, "name": {"type": "string"}, "role": {"type": "string", "enum": ["member", "manager"]}}}}}}}, "security": [{"app": ["teams:write"]}, {"studio": []}, {"cli": ["teams:write"]}]} |
api.json | requestBody | The team to create. | {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}, "annotations": {"type": "object", "additionalProperties": {"type": "string"}}}}}}} |
api.json | 201 | The created team | {"content": {"application/json": {"schema": {"type": "object", "properties": {"id": {"type": "number"}, "name": {"type": "string"}, "role": {"type": "string", "enum": ["member", "manager"]}}}}}} |
api.json | role | The role of the user who created the team | {"type": "string", "enum": ["member", "manager"]} |
api.json | parameters | The ID of the team | {"name": "teamId", "in": "path", "required": true, "schema": {"type": "number", "readOnly": true}} |
api.json | get | Fetch an existing team. | {"tags": ["app"], "operationId": "getTeam", "responses": {"200": {"content": {"application/json": {"schema": {"type": "object", "properties": {"id": {"type": "number"}, "name": {"type": "string"}, "role": {"type": "string", "enum": ["member", "manager"]}}}}}}}, "security": [{"studio": []}]} |
api.json | 200 | The requested team | {"content": {"application/json": {"schema": {"type": "object", "properties": {"id": {"type": "number"}, "name": {"type": "string"}, "role": {"type": "string", "enum": ["member", "manager"]}}}}}} |
api.json | role | The role of the user who requested the team | {"type": "string", "enum": ["member", "manager"]} |
api.json | patch | Update an existing team. | {"tags": ["app"], "operationId": "patchTeam", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}, "annotations": {"type": "object", "additionalProperties": {"type": "string"}}}}}}}, "responses": {"200": {"content": {"application/json": {"schema": {"type": "object", "properties": {"id": {"type": "number"}, "name": {"type": "string"}, "role": {"type": "string", "enum": ["member", "manager"]}}}}}}}, "security": [{"studio": []}, {"cli": ["teams:write"]}]} |
api.json | requestBody | The team to update. | {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}, "annotations": {"type": "object", "additionalProperties": {"type": "string"}}}}}}} |
api.json | 200 | The updated team | {"content": {"application/json": {"schema": {"type": "object", "properties": {"id": {"type": "number"}, "name": {"type": "string"}, "role": {"type": "string", "enum": ["member", "manager"]}}}}}} |
api.json | role | The role of the user who updated the team | {"type": "string", "enum": ["member", "manager"]} |
api.json | delete | Delete an existing team. | {"tags": ["app"], "operationId": "deleteTeam", "responses": {"204": {}}, "security": [{"studio": []}, {"cli": ["teams:write"]}]} |
api.json | 204 | The team has successfully been deleted. | {} |
api.json | parameters | The ID of the team | {"name": "teamId", "in": "path", "required": true, "schema": {"type": "number", "readOnly": true}} |
api.json | get | Fetch the members of a team and their roles within the team. | {"tags": ["app"], "operationId": "getTeamMembers", "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}, "security": [{"studio": []}, {"app": ["teams:read"]}]} |
api.json | 200 | The list of all members. | {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}} |
api.json | post | Add an app member member to a team. | {"tags": ["app"], "operationId": "addTeamMember", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["id"], "properties": {"id": {}}}}}}, "responses": {"201": {"content": {"application/json": {"schema": {}}}}}, "security": [{"studio": []}, {"app": ["teams:write"]}, {"cli": ["teams:write"]}]} |
api.json | requestBody | The team to update. | {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["id"], "properties": {"id": {}}}}}} |
api.json | 201 | The added member | {"content": {"application/json": {"schema": {}}}} |
api.json | parameters | The ID of the team | {"name": "teamId", "in": "path", "required": true, "schema": {"type": "number", "readOnly": true}} |
api.json | parameters | The ID of the team member | {"name": "memberId", "in": "path", "required": true, "schema": {}} |
api.json | get | Get a certain team member from a team | {"tags": ["app"], "operationId": "getTeamMember", "responses": {"200": {"content": {"application/json": {"schema": {}}}}}} |
api.json | 200 | The specified team member | {"content": {"application/json": {"schema": {}}}} |
api.json | put | Update the role of a team member. | {"tags": ["app"], "operationId": "updateTeamMember", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["role"], "properties": {"role": {"type": "string", "enum": ["member", "manager"]}}}}}}, "responses": {"200": {"content": {"application/json": {"schema": {}}}}}, "security": [{"studio": []}, {"cli": ["teams:write"]}]} |
api.json | requestBody | The team to update. | {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["role"], "properties": {"role": {"type": "string", "enum": ["member", "manager"]}}}}}} |
api.json | 200 | The updated member | {"content": {"application/json": {"schema": {}}}} |
api.json | delete | Remove a member from a team. | {"tags": ["app"], "operationId": "removeTeamMember", "responses": {"204": {}}, "security": [{"studio": []}, {"cli": ["teams:write"]}]} |
api.json | 204 | The team member has been removed successfully. | {} |
api.json | parameters | The ID of the team | {"name": "teamId", "in": "path", "required": true, "schema": {"type": "number", "readOnly": true}} |
api.json | post | Invite a new user to a team. | {"tags": ["app"], "operationId": "inviteTeamMember", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["email"], "properties": {"email": {"type": "string", "format": "email"}, "role": {"type": "string", "enum": ["member", "manager"], "default": "member"}}}}}}, "responses": {"200": {"content": {"application/json": {"schema": {}}}}}, "security": [{"app": ["teams:write"]}]} |
api.json | requestBody | The team invite to create. | {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["email"], "properties": {"email": {"type": "string", "format": "email"}, "role": {"type": "string", "enum": ["member", "manager"], "default": "member"}}}}}} |
api.json | email | The email address of the user to invite. | {"type": "string", "format": "email"} |
api.json | role | The role to invite the user as. | {"type": "string", "enum": ["member", "manager"], "default": "member"} |
api.json | 200 | The updated member | {"content": {"application/json": {"schema": {}}}} |
api.json | get | Get details of a team invite. | {"tags": ["app"], "operationId": "getTeamInvite", "parameters": [{"name": "code", "in": "query", "required": true, "schema": {"type": "string", "readOnly": true}}], "responses": {"200": {"content": {"application/json": {"schema": {}}}}}, "security": [{"app": ["teams:read"]}]} |
api.json | parameters | The ID code of the team invite | {"name": "code", "in": "query", "required": true, "schema": {"type": "string", "readOnly": true}} |
api.json | 200 | The team invite | {"content": {"application/json": {"schema": {}}}} |
api.json | 200 | The created member | {"content": {"application/json": {"schema": {}}}} |
api.json | 201 | A list of the SAML secrets for the app. | {"content": {"application/json": {"schema": {}}}} |
api.json | 200 | A list of the SAML secrets for the app. | {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}} |
api.json | 200 | The updated SAML secret. | {"content": {"application/json": {"schema": {}}}} |
api.json | 204 | The deleted SAML secret. | {} |
api.json | get | Get app SCIM secret configuration | {"tags": ["secret"], "operationId": "getAppScimSecret", "security": [{"studio": []}], "responses": {"200": {"content": {"application/json": {"schema": {}}}}}} |
api.json | 200 | The app SCIM configuration | {"content": {"application/json": {"schema": {}}}} |
api.json | patch | Update app SCIM secret configuration | {"tags": ["secret"], "operationId": "updateAppScimSecret", "requestBody": {"content": {"application/json": {"schema": {}}}}, "security": [{"studio": []}], "responses": {"200": {"content": {"application/json": {"schema": {}}}}}} |
api.json | 200 | The app SCIM configuration | {"content": {"application/json": {"schema": {}}}} |
api.json | 200 | The SCIM Schema | {"content": {"application/scim+json": {"schema": {}}}} |
api.json | 200 | The SCIM Schema | {"content": {"application/scim+json": {"schema": {}}}} |
api.json | 200 | SCIM user | {"content": {"application/scim+json": {"schema": {}}}} |
api.json | 200 | SCIM user | {"content": {"application/scim+json": {"schema": {}}}} |
api.json | 200 | SCIM user | {"content": {"application/scim+json": {"schema": {}}}} |
api.json | 201 | Integrated SCIM user schema | {"content": {"application/scim+json": {"schema": {}}}} |
api.json | 200 | SCIM user | {"content": {"application/scim+json": {"schema": {}}}} |
api.json | parameters | The ID of the member to perform the operation on | {"name": "userId", "in": "path", "required": true, "schema": {}} |
api.json | 200 | SCIM user | {"content": {"application/scim+json": {"schema": {}}}} |
api.json | 204 | SCIM user | {} |
api.json | 200 | SCIM user | {} |
api.json | 200 | SCIM user | {} |
api.json | get | Get a list of all languages with messages. | {"tags": ["language"], "operationId": "getAppsembleLanguages", "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "string"}}}}}}} |
api.json | 200 | The list of supported languages | {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "string"}}}}} |
api.json | get | Get the Appsemble messages for this language. | {"tags": ["language"], "operationId": "getStudioMessages", "responses": {"200": {"content": {"application/json": {"schema": {}}}}}} |
api.json | 200 | The app messages for the selected language. | {"content": {"application/json": {"schema": {}}}} |
api.json | get | Get the SSL certificate of an app | {"tags": ["app"], "operationId": "getSSLSecret", "responses": {"200": {}}, "security": [{"studio": []}]} |
api.json | 200 | The SSL secret of the app. | {} |
api.json | put | Update the app’s SSL secret | {"tags": ["app"], "operationId": "updateSSLSecret", "requestBody": {"content": {"application/json": {"schema": {}}}}, "responses": {"200": {}}, "security": [{"studio": []}]} |
api.json | 200 | The updated SSL secret. | {} |
api.json | 200 | Email quota for an app | {"content": {"application/json": {"schema": {"type": "object", "properties": {"used": {"type": "number"}, "limit": {"type": "number"}, "reset": {"type": "string", "format": "date-time"}}}}}} |
api.json | used | Number of emails sent today | {"type": "number"} |
api.json | limit | Maximum number of emails that can be sent today | {"type": "number"} |
api.json | reset | Date and time when the quota resets | {"type": "string", "format": "date-time"} |
api.json | get | Get all of the app’s assets. | {"tags": ["asset"], "operationId": "getAssets", "parameters": [{}], "responses": {"200": {"content": {"application/json": {"schema": {}}}}}, "security": [{"studio": []}, {}]} |
api.json | 200 | The assets associated with the app. | {"content": {"application/json": {"schema": {}}}} |
api.json | post | Upload a new asset. | {"tags": ["asset"], "operationId": "createAsset", "requestBody": {"content": {"multipart/form-data": {"schema": {"type": "object", "additionalProperties": false, "required": ["file"], "properties": {"file": {"type": "string", "format": "binary", "writeOnly": true}, "name": {"type": "string", "pattern": "^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$"}}}}}}, "responses": {"201": {"content": {"application/json": {"schema": {}}}}}, "security": [{"studio": []}, {}, {"cli": ["assets:write"]}]} |
api.json | requestBody | The asset to upload. | {"content": {"multipart/form-data": {"schema": {"type": "object", "additionalProperties": false, "required": ["file"], "properties": {"file": {"type": "string", "format": "binary", "writeOnly": true}, "name": {"type": "string", "pattern": "^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$"}}}}}} |
api.json | schema | The request body for creating an asset. | {"type": "object", "additionalProperties": false, "required": ["file"], "properties": {"file": {"type": "string", "format": "binary", "writeOnly": true}, "name": {"type": "string", "pattern": "^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$"}}} |
api.json | file | The binary data of the asset. This may include a filename. | {"type": "string", "format": "binary", "writeOnly": 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 | 201 | The asset that was created. | {"content": {"application/json": {"schema": {}}}} |
api.json | delete | Delete multiple app assets. | {"tags": ["asset"], "operationId": "deleteAssets", "requestBody": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}, "responses": {"204": {}}, "security": [{"studio": []}, {"app": ["resources:manage"]}, {"cli": ["resources:write"]}, {}]} |
api.json | schema | An array of asset IDs to remove. | {"type": "array", "items": {}} |
api.json | 204 | The app assets have been deleted successfully. | {} |
api.json | get | Get the number of assets in the app. | {"tags": ["asset"], "operationId": "countAssets", "responses": {"200": {"content": {"application/json": {"schema": {"type": "number"}}}}}, "security": [{"studio": []}, {"app": ["resources:manage"]}, {"cli": ["resources:read"]}, {}]} |
api.json | 200 | The number of assets in the app. | {"content": {"application/json": {"schema": {"type": "number"}}}} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.