Skip to content

Commit e6e44a2

Browse files
committed
copy editing updates
1 parent 226a4bd commit e6e44a2

33 files changed

+455
-454
lines changed

docs/content/guides/ai-apps.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ AI apps comprise a new messaging experience for Slack. If you're unfamiliar with
1313

1414
## Configuring your app to support AI apps features {#configuring-your-app}
1515

16-
1. Within [App Settings](https://api.slack.com/apps), enable the **Agents & AI Apps** feature.
16+
1. Within [app settings](https://api.slack.com/apps), enable the **Agents & AI Apps** feature.
1717

18-
2. Within the App Settings **OAuth & Permissions** page, add the following scopes:
18+
2. Within the app settings **OAuth & Permissions** page, add the following scopes:
1919
* [`assistant:write`](https://docs.slack.dev/reference/scopes/assistant.write)
2020
* [`chat:write`](https://docs.slack.dev/reference/scopes/chat.write)
2121
* [`im:history`](https://docs.slack.dev/reference/scopes/im.history)
2222

23-
3. Within the App Settings **Event Subscriptions** page, subscribe to the following events:
23+
3. Within the app settings **Event Subscriptions** page, subscribe to the following events:
2424
* [`assistant_thread_started`](https://docs.slack.dev/reference/events/assistant_thread_started)
2525
* [`assistant_thread_context_changed`](https://docs.slack.dev/reference/events/assistant_thread_context_changed)
2626
* [`message.im`](https://docs.slack.dev/reference/events/message.im)
@@ -75,15 +75,15 @@ While the `assistant_thread_started` and `assistant_thread_context_changed` even
7575

7676
If you do provide your own `threadContextService` property, it must feature `get` and `save` methods.
7777

78-
:::tip
78+
:::tip[Tip]
7979
Be sure to give the [AI apps reference docs](/reference#agents--assistants) a look!
8080
:::
8181

8282
## Handling a new thread {#handling-a-new-thread}
8383

8484
When the user opens a new thread with your AI app, the [`assistant_thread_started`](https://docs.slack.dev/reference/events/assistant_thread_started) event will be sent to your app.
8585

86-
:::tip
86+
:::tip[Tip]
8787
When a user opens a thread with your app while in a channel, the channel info is stored as the thread's `AssistantThreadContext` data. You can grab that info by using the `context.getThreadContext()` utility, as subsequent user message event payloads won't include the channel info.
8888
:::
8989

docs/content/guides/app-distribution.md

Lines changed: 47 additions & 39 deletions
Large diffs are not rendered by default.

docs/content/guides/app-home.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ lang: en
66

77
An [App Home](https://docs.slack.dev/surfaces/app-home) is a private, one-to-one space in Slack shared by a user and an app. Each App Home contains a number of tabbed surfaces, including a Messages tab for app-user conversation, and a Home tab that can be fully customized by the app.
88

9-
### Slack App Configuration
9+
### Slack app configuration
1010

11-
To enable Home tabs, visit the [Slack App configuration page](http://api.slack.com/apps), choose the app you're working on, go to **Features** > **App Home** on the left pane, and then turn on **Home Tab**.
11+
To enable Home tabs, visit the [Slack app settings page](http://api.slack.com/apps), choose the app you're working on, go to **Features** > **App Home** on the left pane, and then turn on **Home Tab**.
1212

13-
To enable Events API, go to **Features** > **Event Subscriptions** on the left pane. There are a few things to do on the page.
13+
To enable the Events API, go to **Features** > **Event Subscriptions** on the left pane. There are a few things to do on the page.
1414

1515
* Turn on **Enable Events**
1616
* Set the **Request URL** to `https://{your app's public URL domain}/slack/events` (this step is not required for Socket Mode apps)
@@ -20,25 +20,25 @@ To enable Events API, go to **Features** > **Event Subscriptions** on the left p
2020
* Choose **app_home_opened** event
2121
* Click the **Save Changes** button at the bottom for sure
2222

23-
### What Your Bolt App Does
23+
### What your Bolt app does
2424

25-
All your app needs to do to provide Home tabs to your app users are:
25+
To provide Home tabs to your app users:
2626

27-
1. Call the [**views.publish**](https://docs.slack.dev/reference/methods/views.publish) method to update the Home tab on a per-user basis
28-
2. Handle any user interactions in Home tab (`"block_actions"`, `"block_suggestion"`)
27+
1. Call the [`views.publish`](https://docs.slack.dev/reference/methods/views.publish) method to update the Home tab on a per-user basis
28+
2. Handle any user interactions in Home tab (`block_actions`, `block_suggestion`)
2929

30-
Most commonly, [`"app_home_opened"`](https://docs.slack.dev/reference/events/app_home_opened) events would be used as the trigger to call the [**views.publish**](https://docs.slack.dev/reference/methods/views.publish) method. Subscribing this event type is useful particularly for the initial Home tab creation. But it's also fine to publish Home tabs by any other means.
30+
Most commonly, [`app_home_opened`](https://docs.slack.dev/reference/events/app_home_opened) events would be used as the trigger to call the [`views.publish`](https://docs.slack.dev/reference/methods/views.publish) method. Subscribing this event type is useful particularly for the initial Home tab creation. But it's also fine to publish Home tabs by any other means.
3131

3232
---
3333
## Examples
3434

35-
:::tip
35+
:::tip[Tip]
3636

3737
If you're a beginner to using Bolt for Slack App development, consult [Getting Started with Bolt](/guides/getting-started-with-bolt), first.
3838

3939
:::
4040

41-
The following code calls [**views.publish**](https://docs.slack.dev/reference/methods/views.publish) method when receiving an [`"app_home_opened"` events](https://docs.slack.dev/reference/events/app_home_opened) for the user that triggered the event. The user will see the updated Home tab immediately after the [**views.publish**](https://docs.slack.dev/reference/methods/views.publish) call has been successfully completed.
41+
The following code calls the [`views.publish`](https://docs.slack.dev/reference/methods/views.publish) method when receiving an [`app_home_opened`](https://docs.slack.dev/reference/events/app_home_opened) event for the user that triggered the event. The user will see the updated Home tab immediately after the [`views.publish`](https://docs.slack.dev/reference/methods/views.publish) call has been successfully completed.
4242

4343
```java
4444
import com.slack.api.methods.response.views.ViewsPublishResponse;
@@ -78,7 +78,7 @@ app.event(AppHomeOpenedEvent.class, (payload, ctx) -> {
7878
});
7979
```
8080

81-
It looks like as below in Kotlin. (New to Kotlin? [Getting Started in Kotlin](/guides/getting-started-with-bolt#getting-started-in-kotlin) may be helpful)
81+
It looks like this in Kotlin. (New to Kotlin? [Getting Started in Kotlin](/guides/getting-started-with-bolt#getting-started-in-kotlin) may be helpful.)
8282

8383
```kotlin
8484
// static imports
@@ -130,6 +130,6 @@ val appHomeView = view { it
130130
}
131131
```
132132

133-
### Under the Hood
133+
## Under the hood
134134

135135
Refer to [the Events API guide](/guides/events-api).

docs/content/guides/audit-logs-api.md

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ lang: en
44

55
# Audit Logs API
66

7-
[Audit Logs API](https://api.lack.com/docs/audit-logs-api) is a set of APIs for monitoring what's happening in your [Enterprise Grid](https://docs.slack.dev/enterprise-grid/) organization.
7+
The [Audit Logs API](https://api.lack.com/docs/audit-logs-api) is used for monitoring what is happening in your [Enterprise Grid](https://docs.slack.dev/enterprise-grid/) organization.
88

99
The Audit Logs API can be used by security information and event management (SIEM) tools to provide an analysis of how your Slack organization is being accessed. You can also use this API to write your own applications to see how members of your organization are using Slack.
1010

11-
Follow the instructions in [the API document](https://docs.slack.dev/admins/audit-logs-api) to get a valid token for using Audit Logs API. Your Slack app for Audit Logs API needs to be installed on the Enterprise Grid Organization, not an individual workspace within the organization.
11+
Follow the instructions in [the API documentation](https://docs.slack.dev/admins/audit-logs-api) to get a valid token for using the Audit Logs API. Your Slack app used for accessing the Audit Logs API needs to be installed at the org level on the Enterprise Grid organization, not an individual workspace within the organization.
1212

1313
---
14-
## Call Audit Logs API in Java
14+
## Call the Audit Logs API in Java
1515

16-
It's straight-forward to call Audit Logs API using the `slack-api-client` library.
16+
Use the `slack-api-client` library to call the Audit Logs API.
1717

1818
```java
1919
import com.slack.api.Slack;
@@ -24,17 +24,17 @@ String token = System.getenv("SLACK_ADMIN_ACCESS_TOKN"); // `auditlogs:read` sco
2424
AuditClient audit = slack.audit(token);
2525
```
2626

27-
All the endpoints are supported.
27+
All of the endpoints are supported.
2828

2929
|Java Method|Endpoint|
3030
|-|-|
3131
|`AuditClient#getLogs()`|`GET /logs`|
3232
|`AuditClient#getSchemas()`|`GET /schemas`|
3333
|`AuditClient#getActions()`|`GET /actions`|
3434

35-
### getLogs()
35+
### `getLogs()`
3636

37-
This is the primary endpoint for retrieving actual audit events from your organization. It will return a list of actions that have occurred on the installed workspace or grid organization. Authentication required.
37+
This is the primary endpoint for retrieving actual audit events from your organization. It will return a list of actions that have occurred on the installed workspace or grid organization. Authentication is required.
3838

3939
```java
4040
import com.slack.api.audit.response.LogsResponse;
@@ -46,45 +46,43 @@ LogsResponse response = audit.getLogs(req -> req
4646
);
4747
```
4848

49-
Refer to [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-api-client/sdkLatestVersion/slack-api-client-sdkLatestVersion-javadoc.jar/!/com/slack/api/audit/response/LogsResponse.html) to know the response data structure.
49+
Refer to the [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-api-client/sdkLatestVersion/slack-api-client-sdkLatestVersion-javadoc.jar/!/com/slack/api/audit/response/LogsResponse.html) to know the response data structure.
5050

51-
### getSchemas()
51+
### `getSchemas()`
5252

53-
This endpoint returns information about the kind of objects which the Audit Logs API returns as a list of all objects and a short description. Authentication not required.
53+
This endpoint returns information about the kind of objects, which the Audit Logs API returns as a list of all objects and a short description. Authentication is not required.
5454

5555
```java
5656
import com.slack.api.audit.response.SchemasResponse;
5757

5858
SchemasResponse response = audit.getSchemas();
5959
```
6060

61-
Refer to [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-api-client/sdkLatestVersion/slack-api-client-sdkLatestVersion-javadoc.jar/!/com/slack/api/audit/response/SchemasResponse.html) to know the response data structure.
61+
Refer to the [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-api-client/sdkLatestVersion/slack-api-client-sdkLatestVersion-javadoc.jar/!/com/slack/api/audit/response/SchemasResponse.html) to know the response data structure.
6262

63-
### getActions()
63+
### `getActions()`
6464

65-
This endpoint returns information about the kind of actions that the Audit Logs API returns as [a list of all actions](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-api-client/sdkLatestVersion/slack-api-client-sdkLatestVersion-javadoc.jar/!/com/slack/api/audit/Actions.html) and a short description of each. Authentication not required.
65+
This endpoint returns information about the kind of actions that the Audit Logs API returns as [a list of all actions](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-api-client/sdkLatestVersion/slack-api-client-sdkLatestVersion-javadoc.jar/!/com/slack/api/audit/Actions.html) and a short description of each. Authentication is not required.
6666

6767
```java
6868
import com.slack.api.audit.response.ActionsResponse;
6969

7070
ActionsResponse response = audit.getActions();
7171
```
7272

73-
Refer to [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-api-client/sdkLatestVersion/slack-api-client-sdkLatestVersion-javadoc.jar/!/com/slack/api/audit/response/ActionsResponse.html) to know the response data structure.
73+
Refer to the [Javadoc](https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-api-client/sdkLatestVersion/slack-api-client-sdkLatestVersion-javadoc.jar/!/com/slack/api/audit/response/ActionsResponse.html) to know the response data structure.
7474

7575

7676
---
77-
## Rate Limits
77+
## Rate limits
7878

79-
The Audit Logs API methods conform to Slack's [rate limits](https://docs.slack.dev/apis/web-api/rate-limits) and all methods are rated Tier 3. This allows for up to 50 calls per minute, with an allowance for sporadic bursts. Refer to [the API document](https://docs.slack.dev/admins/audit-logs-api) for more details.
79+
The Audit Logs API methods conform to Slack's [rate limits](https://docs.slack.dev/apis/web-api/rate-limits) and all methods are rated Tier 3. This allows for up to 50 calls per minute, with an allowance for sporadic bursts. Refer to [the API documentation](https://docs.slack.dev/admins/audit-logs-api) for more details.
8080

81-
`AsyncAuditClient`, the async client, has great consideration for Rate Limits.
81+
The async client, `AsyncAuditClient`, has great consideration for rate limits. The async client internally has its queue systems to avoid burst traffics as much as possible while `AuditClient`, the synchronous client, always blindly sends requests. Both sync and async clients maintain the metrics data in a `MetricsDatastore` together. This allows the async client to accurately know the current traffic they generated toward the Slack platform and estimate the remaining amount to call.
8282

83-
The async client internally has its queue systems to avoid burst traffics as much as possible while `AuditClient`, the synchronous client, always blindly sends requests. The good thing is that both sync and async clients maintain the metrics data in a `MetricsDatastore` together. This allows the async client to accurately know the current traffic they generated toward the Slack Platform and estimate the remaining amount to call.
83+
The default implementation of the datastore is an in-memory one using the JVM heap memory. The default `SlackConfig` enables the in-memory one.
8484

85-
The default implementation of the datastore is in-memory one using the JVM heap memory. The default `SlackConfig` enables the in-memory one. It should work nicely for most cases. If your app is fine with it, you don't need to configure anything.
86-
87-
`AsyncAuditClient` considers the metrics data very well. It may delay API requests to avoid rate-limited errors if the clients in the app already sent too many requests within a short period.
85+
The `AsyncAuditClient` considers the metrics data well. It may delay API requests to avoid rate-limited errors if the clients in the app already sent too many requests within a short period.
8886

8987
```java
9088
import com.slack.api.audit.*;

0 commit comments

Comments
 (0)