-
-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Slack API Ref Buildbot
committed
Mar 23, 2023
1 parent
f0f9a29
commit 878be8f
Showing
7 changed files
with
377 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "name": "apps.datastore" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| { | ||
| "group": "apps", | ||
| "name": "apps.datastore.delete", | ||
| "deprecated": false, | ||
| "desc": "Delete an item from a datastore", | ||
| "args": { | ||
| "datastore": { | ||
| "required": true, | ||
| "desc": "name of the datastore.", | ||
| "type": "string" | ||
| }, | ||
| "id": { | ||
| "required": true, | ||
| "desc": "item id.", | ||
| "type": "string" | ||
| }, | ||
| "app_id": { | ||
| "required": false, | ||
| "desc": "." | ||
| } | ||
| }, | ||
| "response": { | ||
| "examples": [ | ||
| "{\n \"ok\": true\n}", | ||
| "{\n \"ok\": false,\n \"error\": \"datastore_error\",\n \"errors\": [\n {\n \"code\": \"datastore_config_not_found\",\n \"message\": \"The datastore configuration could not be found\",\n \"pointer\": \"/datastores\"\n }\n ]\n}" | ||
| ] | ||
| }, | ||
| "errors": { | ||
| "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments.", | ||
| "invalid_datastore": "The provided datastore is invalid.", | ||
| "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", | ||
| "app_not_hosted": "The App Datastore feature is not available for use by this app.", | ||
| "datastore_error": "Datastore error.", | ||
| "access_denied": "Access to a resource specified in the request is denied.", | ||
| "invalid_app_id": "The app_id provided is not valid for team and user.", | ||
| "free_team_not_allowed": "Datastore delete not allowed on a free team.", | ||
| "datastore_migration_in_progress": "The datastore is currently unavailable due to an in progress Enterprise Grid migration.", | ||
| "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", | ||
| "deprecated_endpoint": "The endpoint has been deprecated.", | ||
| "ekm_access_denied": "Administrators have suspended the ability to post a message.", | ||
| "enterprise_is_restricted": "The method cannot be called from an Enterprise.", | ||
| "is_bot": "This method cannot be called by a bot user.", | ||
| "method_deprecated": "The method has been deprecated.", | ||
| "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", | ||
| "not_allowed_token_type": "The token type used in this request is not allowed.", | ||
| "not_authed": "No authentication token provided.", | ||
| "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", | ||
| "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", | ||
| "token_expired": "Authentication token has expired.", | ||
| "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", | ||
| "two_factor_setup_required": "Two factor setup is required.", | ||
| "accesslimited": "Access to this method is limited on the current network.", | ||
| "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", | ||
| "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", | ||
| "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", | ||
| "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", | ||
| "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.", | ||
| "invalid_form_data": "The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", | ||
| "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.", | ||
| "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", | ||
| "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", | ||
| "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", | ||
| "service_unavailable": "The service is temporarily unavailable.", | ||
| "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete." | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| { | ||
| "group": "apps", | ||
| "name": "apps.datastore.get", | ||
| "deprecated": false, | ||
| "desc": "Get an item from a datastore", | ||
| "args": { | ||
| "datastore": { | ||
| "required": true, | ||
| "desc": "name of the datastore.", | ||
| "type": "string" | ||
| }, | ||
| "id": { | ||
| "required": true, | ||
| "desc": "item id.", | ||
| "type": "string" | ||
| }, | ||
| "app_id": { | ||
| "required": false, | ||
| "desc": "." | ||
| } | ||
| }, | ||
| "response": { | ||
| "examples": [ | ||
| "{\n \"ok\": true,\n \"datastore\": \"good_tunes\",\n \"item\": {\n \"artist\": \"Whitney Houston\",\n \"song\": \"I Will Always Love You\",\n \"id\": \"4\"\n }\n}", | ||
| "{\n \"ok\": false,\n \"error\": \"datastore_error\",\n \"errors\": [\n {\n \"code\": \"datastore_config_not_found\",\n \"message\": \"The datastore configuration could not be found\",\n \"pointer\": \"/datastores\"\n }\n ]\n}" | ||
| ] | ||
| }, | ||
| "errors": { | ||
| "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments.", | ||
| "invalid_datastore": "The provided datastore is invalid.", | ||
| "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", | ||
| "app_not_hosted": "The App Datastore feature is not available for use by this app.", | ||
| "not_found": "Item not found.", | ||
| "datastore_error": "Datastore error.", | ||
| "access_denied": "Access to a resource specified in the request is denied.", | ||
| "invalid_app_id": "The app_id provided is not valid for team and user.", | ||
| "free_team_not_allowed": "Datastore get not allowed on a free team.", | ||
| "team_quota_exceeded": "Total number of requests exceeded team quota.", | ||
| "datastore_migration_in_progress": "The datastore is currently unavailable due to an in progress Enterprise Grid migration.", | ||
| "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", | ||
| "deprecated_endpoint": "The endpoint has been deprecated.", | ||
| "ekm_access_denied": "Administrators have suspended the ability to post a message.", | ||
| "enterprise_is_restricted": "The method cannot be called from an Enterprise.", | ||
| "is_bot": "This method cannot be called by a bot user.", | ||
| "method_deprecated": "The method has been deprecated.", | ||
| "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", | ||
| "not_allowed_token_type": "The token type used in this request is not allowed.", | ||
| "not_authed": "No authentication token provided.", | ||
| "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", | ||
| "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", | ||
| "token_expired": "Authentication token has expired.", | ||
| "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", | ||
| "two_factor_setup_required": "Two factor setup is required.", | ||
| "accesslimited": "Access to this method is limited on the current network.", | ||
| "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", | ||
| "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", | ||
| "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", | ||
| "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", | ||
| "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.", | ||
| "invalid_form_data": "The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", | ||
| "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.", | ||
| "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", | ||
| "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", | ||
| "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", | ||
| "service_unavailable": "The service is temporarily unavailable.", | ||
| "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete." | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| { | ||
| "group": "apps", | ||
| "name": "apps.datastore.put", | ||
| "deprecated": false, | ||
| "desc": "Creates a new item, or replaces an old item with a new item.", | ||
| "args": { | ||
| "datastore": { | ||
| "required": true, | ||
| "desc": "name of the datastore.", | ||
| "type": "string" | ||
| }, | ||
| "item": { | ||
| "required": true, | ||
| "desc": "attribute names and values of the item.", | ||
| "type": "object" | ||
| }, | ||
| "app_id": { | ||
| "required": false, | ||
| "desc": "." | ||
| } | ||
| }, | ||
| "response": { | ||
| "examples": [ | ||
| "{\n \"ok\": true,\n \"datastore\": \"good_tunes\",\n \"item\": {\n \"artist\": \"Whitney Houston\",\n \"song\": \"I Will Always Love You\",\n \"id\": \"4\"\n }\n}", | ||
| "{\n \"ok\": false,\n \"error\": \"datastore_error\",\n \"errors\": [\n {\n \"code\": \"datastore_config_not_found\",\n \"message\": \"The datastore configuration could not be found\",\n \"pointer\": \"/datastores\"\n }\n ]\n}" | ||
| ] | ||
| }, | ||
| "errors": { | ||
| "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments.", | ||
| "invalid_datastore": "The provided datastore is invalid.", | ||
| "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", | ||
| "app_not_hosted": "The App Datastore feature is not available for use by this app.", | ||
| "datastore_error": "Datastore error.", | ||
| "access_denied": "Access to a resource specified in the request is denied.", | ||
| "invalid_app_id": "The app_id provided is not valid for team and user.", | ||
| "free_team_not_allowed": "Datastore put not allowed on a free team.", | ||
| "team_quota_exceeded": "Total number of requests exceeded team quota.", | ||
| "datastore_migration_in_progress": "The datastore is currently unavailable due to an in progress Enterprise Grid migration.", | ||
| "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", | ||
| "deprecated_endpoint": "The endpoint has been deprecated.", | ||
| "ekm_access_denied": "Administrators have suspended the ability to post a message.", | ||
| "enterprise_is_restricted": "The method cannot be called from an Enterprise.", | ||
| "is_bot": "This method cannot be called by a bot user.", | ||
| "method_deprecated": "The method has been deprecated.", | ||
| "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", | ||
| "not_allowed_token_type": "The token type used in this request is not allowed.", | ||
| "not_authed": "No authentication token provided.", | ||
| "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", | ||
| "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", | ||
| "token_expired": "Authentication token has expired.", | ||
| "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", | ||
| "two_factor_setup_required": "Two factor setup is required.", | ||
| "accesslimited": "Access to this method is limited on the current network.", | ||
| "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", | ||
| "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", | ||
| "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", | ||
| "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", | ||
| "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.", | ||
| "invalid_form_data": "The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", | ||
| "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.", | ||
| "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", | ||
| "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", | ||
| "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", | ||
| "service_unavailable": "The service is temporarily unavailable.", | ||
| "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete." | ||
| } | ||
| } |
Oops, something went wrong.