schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
api.json | put | Set the role of the member within the organization. | {"tags": ["organization"], "operationId": "setRole", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["role"], "properties": {"role": {"type": "string", "enum": ["Member", "Translator", "APIReader", "APIUser", "AppEditor", "Maintainer", "Owner"]}}}}}}, "responses": {"200": {"content": {"application/json": {"schema": {}}}}}, "security": [{"studio": []}]} |
api.json | requestBody | The role to set. | {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["role"], "properties": {"role": {"type": "string", "enum": ["Member", "Translator", "APIReader", "APIUser", "AppEditor", "Maintainer", "Owner"]}}}}}} |
api.json | 200 | The member’s role has been successfully updated. | {"content": {"application/json": {"schema": {}}}} |
api.json | get | Get a list of an organization’s apps. Private apps are excluded unless the user is in the organization. | {"tags": ["organization"], "parameters": [{"name": "language", "schema": {"type": "string"}, "in": "query"}], "operationId": "getOrganizationApps", "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 this organization’s apps. | {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}} |
api.json | get | Get a list of an organization’s blocks. | {"tags": ["organization"], "operationId": "getOrganizationBlocks", "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}, "security": [{"studio": []}, {}]} |
api.json | 200 | The list of this organization’s blocks. | {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}} |
api.json | parameters | The path to the action to execute. | {"in": "path", "name": "path", "required": true, "schema": {"type": "string"}} |
api.json | get | Proxy a GET request action | {"tags": ["proxy"], "operationId": "proxyGet", "responses": {"default": {}}, "security": [{"app": ["email", "profile"]}, {}], "parameters": [{"in": "query", "name": "data", "required": true, "schema": {"type": "string"}}]} |
api.json | default | The proxied response | {} |
api.json | parameters | The data that was passed to the action | {"in": "query", "name": "data", "required": true, "schema": {"type": "string"}} |
api.json | delete | Proxy a DELETE request action | {"tags": ["proxy"], "operationId": "proxyDelete", "responses": {"default": {}}, "security": [{"app": ["email", "profile"]}, {}], "parameters": [{"in": "query", "name": "data", "required": true, "schema": {"type": "string"}}]} |
api.json | default | The proxied response | {} |
api.json | parameters | The data that was passed to the action | {"in": "query", "name": "data", "required": true, "schema": {"type": "string"}} |
api.json | patch | Proxy a PATCH request action | {"tags": ["proxy"], "operationId": "proxyPatch", "responses": {"default": {}}, "security": [{"app": ["email", "profile"]}, {}], "requestBody": {"required": true, "content": {"application/json": {}}}} |
api.json | default | The proxied response | {} |
api.json | requestBody | The data that was passed to the action | {"required": true, "content": {"application/json": {}}} |
api.json | post | Proxy a POST request action | {"tags": ["proxy"], "operationId": "proxyPost", "responses": {"default": {}}, "security": [{"app": ["email", "profile"]}, {}], "requestBody": {"required": true, "content": {"application/json": {}}}} |
api.json | default | The proxied response | {} |
api.json | requestBody | The data that was passed to the action | {"required": true, "content": {"application/json": {}}} |
api.json | put | Proxy a PUT request action | {"tags": ["proxy"], "operationId": "proxyPut", "responses": {"default": {}}, "security": [{"app": ["email", "profile"]}, {}], "requestBody": {"required": true, "content": {"application/json": {}}}} |
api.json | default | The proxied response | {} |
api.json | requestBody | The data that was passed to the action | {"required": true, "content": {"application/json": {}}} |
api.json | get | Get the known history of a resource | {"tags": ["resource"], "operationId": "getResourceHistory", "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}, "security": [{"studio": []}]} |
api.json | 200 | The resource that matches the given id. | {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}} |
api.json | get | Get all resources of this app. | {"tags": ["resource"], "operationId": "queryResources", "parameters": [{}, {}, {}, {}, {}, {}], "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}, "text/csv": {"schema": {"type": "string"}}}}}, "security": [{"studio": []}, {"app": ["resources:manage"]}, {"cli": ["resources:read"]}, {}]} |
api.json | 200 | The list of all this app’s resources of this type. | {"content": {"application/json": {"schema": {"type": "array", "items": {}}}, "text/csv": {"schema": {"type": "string"}}}} |
api.json | post | Create a new resource for this app. | {"tags": ["resource"], "operationId": "createResource", "requestBody": {"required": true, "content": {"application/json": {"schema": {"anyOf": [{}, {"type": "array", "items": {}}]}}, "multipart/form-data": {"schema": {"type": "object", "required": ["resource"], "additionalProperties": false, "properties": {"resource": {"type": "array", "items": {}}, "assets": {"type": "array", "items": {"type": "string", "format": "binary"}}}}}, "text/csv": {"schema": {"type": "array", "items": {"type": "object", "additionalProperties": {"type": "string"}}}}}}, "responses": {"201": {}}, "security": [{"studio": []}, {"app": ["resources:manage"]}, {"cli": ["resources:write"]}, {}]} |
api.json | requestBody | The resource to create | {"required": true, "content": {"application/json": {"schema": {"anyOf": [{}, {"type": "array", "items": {}}]}}, "multipart/form-data": {"schema": {"type": "object", "required": ["resource"], "additionalProperties": false, "properties": {"resource": {"type": "array", "items": {}}, "assets": {"type": "array", "items": {"type": "string", "format": "binary"}}}}}, "text/csv": {"schema": {"type": "array", "items": {"type": "object", "additionalProperties": {"type": "string"}}}}}} |
api.json | schema | A `multipart/form-data` representation of a resource. | {"type": "object", "required": ["resource"], "additionalProperties": false, "properties": {"resource": {"type": "array", "items": {}}, "assets": {"type": "array", "items": {"type": "string", "format": "binary"}}}} |
api.json | assets | A list of assets that should be linked to the resource. | {"type": "array", "items": {"type": "string", "format": "binary"}} |
api.json | 201 | The resource that was created. | {} |
api.json | put | Update existing app resources. | {"tags": ["resource"], "operationId": "updateResources", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "array", "items": {}}}, "multipart/form-data": {"schema": {"type": "object", "required": ["resource"], "additionalProperties": false, "properties": {"resource": {"type": "array", "items": {}}, "assets": {"type": "array", "items": {"type": "string", "format": "binary"}}}}}, "text/csv": {"schema": {"type": "array", "items": {"type": "object", "additionalProperties": {"type": "string"}}}}}}, "responses": {"200": {}}, "security": [{"studio": []}, {"app": ["resources:manage"]}, {"cli": ["resources:write"]}, {}]} |
api.json | requestBody | The resources to update | {"required": true, "content": {"application/json": {"schema": {"type": "array", "items": {}}}, "multipart/form-data": {"schema": {"type": "object", "required": ["resource"], "additionalProperties": false, "properties": {"resource": {"type": "array", "items": {}}, "assets": {"type": "array", "items": {"type": "string", "format": "binary"}}}}}, "text/csv": {"schema": {"type": "array", "items": {"type": "object", "additionalProperties": {"type": "string"}}}}}} |
api.json | schema | A `multipart/form-data` representation of a resource. | {"type": "object", "required": ["resource"], "additionalProperties": false, "properties": {"resource": {"type": "array", "items": {}}, "assets": {"type": "array", "items": {"type": "string", "format": "binary"}}}} |
api.json | assets | A list of assets that should be linked to the resources. | {"type": "array", "items": {"type": "string", "format": "binary"}} |
api.json | 200 | The updated resources. | {} |
api.json | delete | Delete multiple app resources. | {"tags": ["resource"], "operationId": "deleteResources", "requestBody": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}, "responses": {"204": {}}, "security": [{"studio": []}, {"app": ["resources:manage"]}, {"cli": ["resources:write"]}, {}]} |
api.json | schema | An array of resource IDs to remove. | {"type": "array", "items": {}} |
api.json | 204 | The app resources have been deleted successfully. | {} |
api.json | get | Get a count of all resources of this app. | {"tags": ["resource"], "operationId": "countResources", "parameters": [{}, {}], "responses": {"200": {"content": {"application/json": {"schema": {"type": "number"}}}}}, "security": [{"studio": []}, {"app": ["resources:manage"]}, {"cli": ["resources:read"]}, {}]} |
api.json | 200 | The count of all this app’s resources of this type. | {"content": {"application/json": {"schema": {"type": "number"}}}} |
api.json | get | Get the current subscription status of this resource. | {"tags": ["resource"], "operationId": "getResourceTypeSubscription", "responses": {"200": {"content": {"application/json": {"schema": {}}}}}, "security": [{"studio": []}, {"app": ["openid"]}, {}]} |
api.json | 200 | The subscription status for this resource. | {"content": {"application/json": {"schema": {}}}} |
api.json | get | Get a single app resource. | {"tags": ["resource"], "operationId": "getResourceById", "responses": {"200": {}}, "security": [{"studio": []}, {"app": ["resources:manage"]}, {"cli": ["resources:read"]}, {}]} |
api.json | 200 | The resource that matches the given id. | {} |
api.json | put | Update an existing app resource. | {"tags": ["resource"], "operationId": "updateResource", "requestBody": {"required": true}, "responses": {"200": {}}, "security": [{"studio": []}, {"app": ["resources:manage"]}, {"cli": ["resources:write"]}, {}]} |
api.json | 200 | The updated resource. | {} |
api.json | patch | Patch an existing app resource. | {"tags": ["resource"], "operationId": "patchResource", "requestBody": {"required": true}, "responses": {"200": {}}, "security": [{"studio": []}, {"app": ["resources:manage"]}, {"cli": ["resources:write"]}, {}]} |
api.json | 200 | The patched resource. | {} |
api.json | delete | Delete an existing app resource. | {"tags": ["resource"], "operationId": "deleteResource", "responses": {"204": {}}, "security": [{"studio": []}, {"app": ["resources:manage"]}, {"cli": ["resources:write"]}, {}]} |
api.json | 204 | The app resource has been deleted successfully. | {} |
api.json | get | Get the subscription status of a resource. | {"tags": ["resource"], "operationId": "getResourceSubscription", "responses": {"200": {"content": {"application/json": {"schema": {"type": "object", "properties": {"id": {"type": "number"}, "update": {"type": "boolean"}, "delete": {"type": "boolean"}}}}}}}} |
api.json | 200 | The subscription status of the resource that matches the given id. | {"content": {"application/json": {"schema": {"type": "object", "properties": {"id": {"type": "number"}, "update": {"type": "boolean"}, "delete": {"type": "boolean"}}}}}} |
api.json | 201 | A list of the SAML secrets for the app. | {"content": {"application/json": {"schema": {}}}} |
api.json | 302 | A list of the SAML secrets for the app. | {"content": {"application/json": {"schema": {}}}} |
api.json | 200 | Get the SAML entity ID metadata | {"content": {"application/xml": {"schema": {}}}} |
api.json | 200 | Continue SAML login in case of an email conflict | {"content": {"application/jso": {"schema": {"type": "object", "additionalProperties": false, "properties": {"redirect": {"type": "string"}}}}}} |
api.json | get | Fetch a list of all available templates. | {"tags": ["template"], "operationId": "getAppTemplates", "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "properties": {"template": {"type": "string"}, "resources": {"type": "boolean"}}}}}}}}, "security": [{"studio": []}]} |
api.json | 200 | The list of all available templates. | {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "properties": {"template": {"type": "string"}, "resources": {"type": "boolean"}}}}}}} |
api.json | template | The name of the template. | {"type": "string"} |
api.json | description | The description of the template. | {"type": "string"} |
api.json | resources | Whether this template supports pre-made resources | {"type": "boolean"} |
api.json | post | Register a new app using a template. | {"tags": ["template"], "operationId": "createTemplateApp", "requestBody": {"content": {"application/json": {"schema": {"type": "object", "required": ["templateId", "organizationId"], "properties": {"templateId": {"type": "number"}, "name": {}, "organizationId": {}, "resources": {"type": "boolean"}, "visibility": {}}}}}}, "responses": {"201": {}}, "security": [{"studio": []}]} |
api.json | requestBody | The template to use for app creation. | {"content": {"application/json": {"schema": {"type": "object", "required": ["templateId", "organizationId"], "properties": {"templateId": {"type": "number"}, "name": {}, "organizationId": {}, "resources": {"type": "boolean"}, "visibility": {}}}}}} |
api.json | templateId | The ID of the template. | {"type": "number"} |
api.json | resources | Include example resources. | {"type": "boolean"} |
api.json | get | Get a list of all languages with messages. | {"tags": ["language"], "operationId": "getLanguages", "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 | post | Upload messages for the given language. | {"tags": ["language"], "operationId": "createMessages", "requestBody": {"required": true, "content": {"application/json": {"schema": {}}}}, "responses": {"201": {"content": {"application/json": {"schema": {}}}}}, "security": [{"studio": []}, {"cli": ["apps:write"]}]} |
api.json | 201 | The translation was created. | {"content": {"application/json": {"schema": {}}}} |
api.json | parameters | Whether the language’s messages should be merged with its base language. | {"in": "query", "name": "merge", "schema": {"type": "string"}} |
api.json | parameters | Whether the app’s language overrides should be included and merged. | {"in": "query", "name": "override", "schema": {"type": "string", "default": "true"}} |
api.json | get | Get the app’s messages for this language. | {"tags": ["language"], "operationId": "getMessages", "responses": {"200": {"content": {"application/json": {"schema": {}}}}}} |
api.json | 200 | The app messages for the selected language. | {"content": {"application/json": {"schema": {}}}} |
api.json | delete | Delete the app’s messages for this language. | {"tags": ["language"], "operationId": "deleteMessages", "responses": {"204": {}}, "security": [{"studio": []}]} |
api.json | 204 | The messages have successfully been deleted. | {} |
api.json | 201 | The created app service secret. | {"content": {"application/json": {"schema": {}}}} |
api.json | 200 | The list of app service secrets. | {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}} |
api.json | 200 | The updated app service secret. | {"content": {"application/json": {"schema": {}}}} |
api.json | 204 | The deleted app service secret. | {} |
api.json | post | Login using the Appsemble studio. | {"tags": ["user"], "operationId": "emailLogin", "responses": {"200": {}}, "security": [{"basic": []}]} |
api.json | 200 | Logged in successfully. | {} |
api.json | get | Get all apps that are editable by the user. | {"tags": ["app"], "parameters": [{"name": "language", "schema": {"type": "string"}, "in": "query"}], "operationId": "queryMyApps", "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 editable apps. | {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}} |
api.json | post | Refresh an access token using the Appsemble studio | {"tags": ["user"], "operationId": "refreshToken", "requestBody": {"required": true, "content": {"application/json": {"schema": {"type": "object", "required": ["refresh_token"], "properties": {"refresh_token": {"type": "string"}}}}}}, "responses": {"200": {}}} |
api.json | refresh_token | The refresh token to use for refreshing the session. | {"type": "string"} |
api.json | 200 | The token has been refreshed successfully. | {} |
api.json | get | Fetch the logged in user's profile. | {"tags": ["user"], "operationId": "getUser", "responses": {"200": {"content": {"application/json": {"schema": {}}}}}, "security": [{"studio": []}]} |
api.json | 200 | The user's profile. | {"content": {"application/json": {"schema": {}}}} |
api.json | put | Update the logged in user's profile. | {"tags": ["user"], "operationId": "updateUser", "requestBody": {"required": true}, "responses": {"200": {"content": {"application/json": {"schema": {}}}}}, "security": [{"studio": []}]} |
api.json | 200 | The user's profile. | {"content": {"application/json": {"schema": {}}}} |
api.json | get | Fetch the logged in user's organizations. | {"tags": ["template"], "operationId": "getUserOrganizations", "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "properties": {"id": {}, "name": {}, "role": {}}}}}}}}, "security": [{"studio": []}]} |
api.json | 200 | The organizations the logged in user is a member of. | {"content": {"application/json": {"schema": {"type": "array", "items": {"type": "object", "properties": {"id": {}, "name": {}, "role": {}}}}}}} |
api.json | get | List email addresses registered to logged in user's account. | {"tags": ["user"], "operationId": "listEmails", "responses": {"200": {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}}}, "security": [{"studio": []}]} |
api.json | 200 | The email address has been added successfully. | {"content": {"application/json": {"schema": {"type": "array", "items": {}}}}} |
api.json | post | Register a new email to logged in user's account. | {"tags": ["user"], "operationId": "addEmail", "requestBody": {"required": true, "content": {"application/json": {"schema": {}}}}, "responses": {"201": {"content": {"application/json": {"schema": {}}}}}, "security": [{"studio": []}]} |
api.json | 201 | The email address has been added successfully. | {"content": {"application/json": {"schema": {}}}} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.