Skip to content

Commit d8d8a64

Browse files
authored
Merge pull request #143 from flashcatcloud/doc-review/20260706-031624
docs: sync doc-review drift findings
2 parents 2d65896 + a8ccf78 commit d8d8a64

16 files changed

Lines changed: 80 additions & 55 deletions

File tree

en/ai-sre/automations.mdx

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Each automation is a **rule**. A rule carries at least one trigger:
1919

2020
- **Schedule (cron)**: set the cadence with a 4-field or 5-field cron expression (for example, every Monday morning or every day at 09:15); it runs automatically when the time comes.
2121
- **Call via API**: generate a trigger URL with a Bearer token, and trigger it on demand from an external system with a `POST`, passing the context for this run in the request body.
22-
- **On-call incident trigger (API)**: subscribe to selected On-call integrations and severities through the Automation API, then start a diagnostic run when a matching incident appears.
22+
- **On-call incident trigger**: select the On-call channels and severities to watch, then start a diagnostic run when a matching incident appears.
2323

2424
When to use it: hand recurring routine inspections (such as a daily health check) and periodic insight / post-mortem reports to AI SRE to run automatically; or wire AI SRE into your existing pipeline, change system, or On-call incident flow so an event kicks off a diagnosis.
2525

@@ -67,7 +67,7 @@ For **Environment**, "Auto" has the backend pick the best available environment
6767

6868
---
6969

70-
A rule must have **at least one trigger** configured. The current console form exposes **Schedule** and **Call via API** in the "Triggers" section, and both can be enabled at the same time; the public API also supports an On-call incident trigger for wiring incident events directly into Automation runs.
70+
A rule must have **at least one trigger** configured. The current console form exposes **Schedule**, **Call via API**, and **On-call incident** in the "Triggers" section, and all three can be enabled at the same time.
7171

7272
### Schedule (cron)
7373

@@ -132,22 +132,32 @@ The `text` in the request body is passed to the agent as context for this run, o
132132
A rule can enable **both** "Schedule" and "Call via API" at the same time: it runs automatically on the cadence and can also be kicked off on demand from outside. Each trigger occupies its own row and can be **removed** independently.
133133
</Tip>
134134

135-
### On-call Incident Trigger (API)
135+
### On-call Incident Trigger
136136

137-
Use the Automation API to configure an `oncall_incident` trigger when you want AI SRE to start automatically from On-call incidents. The trigger registers a subscription with the On-call side, and only incidents matching the selected integrations and severities start a run.
137+
Add the **On-call incident** trigger when you want AI SRE to start automatically from On-call incidents. The trigger registers a subscription with the On-call side, and only incidents matching the selected channels and severities start a run.
138+
139+
<Steps>
140+
<Step title="Add the trigger">
141+
Click the **On-call incident** card in "Triggers". The form expands channel and severity conditions.
142+
</Step>
143+
<Step title="Select channels">
144+
Select the On-call channels to watch in the **Channel** dropdown. Personal-scope rules can select visible account channels; team-scope rules narrow the channel list to the selected team.
145+
</Step>
146+
<Step title="Select severities">
147+
Select one or more severities from `Critical`, `Warning`, and `Info`. When this trigger is enabled, at least one channel and one severity are required.
148+
</Step>
149+
</Steps>
150+
151+
If you create or update a rule through the API, use these fields:
138152

139153
| Field | Type | Notes |
140154
|---|---|---|
141155
| `oncall_incident_trigger_enabled` | boolean | Whether the On-call incident trigger is enabled. |
142-
| `oncall_incident_channel_ids` | int64[] | On-call integration IDs to watch. Creating or enabling this trigger requires at least one valid ID. |
156+
| `oncall_incident_channel_ids` | int64[] | On-call channel IDs to watch. Creating or enabling this trigger requires at least one valid ID. |
143157
| `oncall_incident_severities` | string[] | Incident severities to watch. Supported values are `Critical`, `Warning`, and `Info`; creating or enabling this trigger requires at least one value. |
144158

145159
When a matching event arrives, the system creates a run with `trigger_kind: "oncall_incident"` and passes event context such as `incident_id`, `channel_id`, and `severity` into the session. The same trigger and the same `incident_id` reuse the same run, avoiding duplicate hidden sessions for one incident.
146160

147-
<Note>
148-
The current console form does not expose a separate On-call incident trigger card. Configure it with the Automation create / update APIs in the API reference.
149-
</Note>
150-
151161
## Run History
152162

153163
---

en/ai-sre/environments.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ AI SRE provides two types of Environments:
1919

2020
<CardGroup cols={2}>
2121
<Card title="Cloud Sandbox" icon="cloud" href="/en/ai-sre/sandbox">
22-
A Flashduty-managed temporary container that works out of the box with no install. When no BYOC Runner is online, sessions automatically fall back to the cloud Sandbox.
22+
A Flashduty-managed temporary container that works out of the box with no install. When no usable BYOC Runner is online for the current member, sessions automatically fall back to the cloud Sandbox.
2323
</Card>
2424
<Card title="BYOC Runner" icon="server" href="#byoc-runner">
2525
A persistent process deployed on your own machine. It connects to AI SRE over WebSocket and lets the agent execute inside your network boundary.
2626
</Card>
2727
</CardGroup>
2828

29-
The default selection logic is: **if the account has an online BYOC Runner, AI SRE uses a Runner first; otherwise it uses the cloud Sandbox.** You can also pin a session to the cloud Sandbox, or to a specific Runner, from the environment selector in the chat input.
29+
The default selection logic is: **AI SRE uses an online BYOC Runner that the current member can use first; otherwise it uses the cloud Sandbox.** Usable Runners include account-scoped Runners and team-scoped Runners that belong to one of the current member's teams. You can also pin a session to the cloud Sandbox, or to a specific Runner, from the environment selector in the chat input.
3030

3131
<Note>
3232
The console record is called an **Environment**. The process running on your machine is called a **Runner**. One BYOC Environment maps to one Runner process; cloud Sandbox instances are managed by the system per session.
@@ -321,9 +321,9 @@ The environment selector at the bottom of the chat input decides where a new ses
321321

322322
| Option | Meaning |
323323
|---|---|
324-
| **Auto** | The default for new sessions. Uses an online Runner if the account has one; otherwise falls back to the cloud Sandbox. |
324+
| **Auto** | The default for new sessions. Uses an online Runner the current member can use; otherwise falls back to the cloud Sandbox. |
325325
| **Cloud Sandbox · Default** | Forces the system-managed cloud Sandbox and ignores self-hosted Runners. |
326-
| **Self-hosted Environment** | Lists visible Runners. Offline or never-connected Runners appear disabled and cannot be selected. |
326+
| **Self-hosted Environment** | Lists Runners the current member can use. Offline, never-connected, or team-mismatched Runners cannot be selected. |
327327

328328
<Warning>
329329
Environment selection is locked once per session: the Environment determined when the session sends its first message is recorded and reused for all later turns. Changing the selector afterward does not change that session. To switch environments, start a new session.
@@ -339,8 +339,8 @@ Each BYOC Environment has account-level or team-level scope:
339339

340340
| Scope | Visibility |
341341
|---|---|
342-
| Account | Visible to all members in the account. |
343-
| Team | Visible and editable only by members of that team. |
342+
| Account | Visible, selectable, and usable by all members in the account. |
343+
| Team | Visible, editable, selectable, and usable only by members of that team. |
344344

345345
Edit permissions follow the unified rule:
346346

@@ -349,7 +349,7 @@ Edit permissions follow the unified rule:
349349
3. There is no "creator extra permission"; you do not need to be the creator if the rules above allow the edit.
350350

351351
<Note>
352-
Scope is an editing and ownership label, while the account is the runtime security boundary. When auto-selecting a Runner, the system chooses from online BYOC Runners in the account by matching tags. Team scope mainly controls who can see and edit the Runner in the console.
352+
The account remains the runtime security boundary, but team scope also participates in Runner selection. When the system auto-selects a Runner, or when a session is pinned to a Runner by ID, it only uses account-scoped Runners or team-scoped Runners that belong to one of the current member's teams. This prevents a member from landing a session on a team Runner they cannot use.
353353
</Note>
354354

355355
## Troubleshooting

en/ai-sre/sandbox.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Sandbox
3-
description: The cloud sandbox is a Flashduty-managed, temporary execution environment that works out of the box with no install. When no self-hosted Runner is online, AI SRE sessions run in the cloud sandbox by default; you can also pin a session to it manually.
3+
description: The cloud sandbox is a Flashduty-managed, temporary execution environment that works out of the box with no install. When no usable self-hosted Runner is online for the current member, AI SRE sessions run in the cloud sandbox by default; you can also pin a session to it manually.
44
keywords: ["AI SRE", "cloud sandbox", "Sandbox", "environment", "fallback", "egress", "BYOC"]
55
sidebarTitle: Sandbox
66
---
@@ -15,7 +15,7 @@ sidebarTitle: Sandbox
1515

1616
The **cloud sandbox** is a **temporary execution environment** managed by Flashduty — an isolated, ready-to-use container. The AI SRE agent's tool calls (running commands, reading and writing files, running Skills, connecting to MCP) all happen inside it, and you **don't have to install or maintain anything**.
1717

18-
It is AI SRE's **default fallback**: when your account has no online self-hosted Runner ([BYOC Runner](/en/ai-sre/environments#byoc-runner)), sessions automatically run in the cloud sandbox; you can also **pin a session to it manually**.
18+
It is AI SRE's **default fallback**: when no usable self-hosted Runner ([BYOC Runner](/en/ai-sre/environments#byoc-runner)) is online for the current member, sessions automatically run in the cloud sandbox; you can also **pin a session to it manually**.
1919

2020
<CardGroup cols={2}>
2121
<Card title="Zero install, ready to use" icon="cloud">
@@ -48,7 +48,7 @@ The **environment selector** at the bottom of the chat box decides where the ses
4848

4949
| Option | Behavior |
5050
|---|---|
51-
| **Auto** | The default for new sessions. Prefers an online Runner if the account has one; otherwise **falls back to the cloud sandbox**. |
51+
| **Auto** | The default for new sessions. Prefers an online Runner the current member can use; otherwise **falls back to the cloud sandbox**. |
5252
| **Cloud sandbox · Default** | Forces the cloud sandbox, ignoring all self-hosted Runners. |
5353

5454
<Note>

en/developer/cli.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -376,9 +376,9 @@ Common flags:
376376

377377
### Full command coverage
378378

379-
Beyond the curated commands above, the CLI now provides **full coverage** of the Flashduty OpenAPI through a spec-driven code generator. The current OpenAPI contains **288 API operations**, and the CLI generates corresponding resource-organized commands for them. In addition to the On-call domain (incident, change, channel, field, status-page, template, and more), it also covers:
379+
Beyond the curated commands above, the CLI now provides **full coverage** of the Flashduty OpenAPI through a spec-driven code generator. The current OpenAPI contains **291 API operations**, and the CLI generates corresponding resource-organized commands for them. In addition to the On-call domain (incident, incident-trigger-subscription, change, channel, field, status-page, template, and more), it also covers:
380380

381-
- **AI SRE (`safari`)**: a2a-agents, mcp-servers, sessions, skills, and more
381+
- **AI SRE (`safari`)**: a2a-agents, automations, mcp-servers, sessions, skills, and more
382382
- **Alerting & noise reduction**: alert, alert-event, enrichment (alert-rules, rule-sets), route
383383
- **On-call & scheduling**: calendar, schedule
384384
- **Platform administration**: account, member, person, team, role (roles-permissions), audit (audit-logs)

en/developer/go-sdk.mdx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Go SDK
33
sidebarTitle: Go SDK
4-
description: "go-flashduty is the official open-source Go SDK for Flashduty — a typed, strictly 1:1 wrapper over the Open API currently covering all 288 API operations across 32 services."
4+
description: "go-flashduty is the official open-source Go SDK for Flashduty — a typed, strictly 1:1 wrapper over the Open API currently covering all 291 API operations across 32 services."
55
keywords: ["Go SDK", "go-flashduty", "Open API", "Golang", "client"]
66
---
77

@@ -11,7 +11,7 @@ keywords: ["Go SDK", "go-flashduty", "Open API", "Golang", "client"]
1111

1212
`go-flashduty` is the official open-source Go client for Flashduty, covering every REST endpoint of the Flashduty Open API. It follows the same design as [go-github](https://github.com/google/go-github) — service groups, typed requests and responses, a composable transport layer — and stays strictly 1:1 with the OpenAPI spec: each method maps to exactly one HTTP call, returns `(*T, *Response, error)`, and performs no implicit cross-endpoint aggregation or enrichment.
1313

14-
The SDK currently covers **288 API operations** across **32 services**, all generated from the Flashduty OpenAPI spec, covered by unit tests, and end-to-end verified against the live API.
14+
The SDK currently covers **291 API operations** across **32 services**, all generated from the Flashduty OpenAPI spec, covered by unit tests, and end-to-end verified against the live API.
1515

1616
<Note>
1717
The SDK is deliberately "thin." Consumer-side logic such as short-ID resolution and cross-endpoint orchestration belongs in the caller (CLI / MCP), not stuffed into the SDK or shoehorned into an endpoint. This keeps the SDK strictly one-to-one with the API — predictable, generatable, and verifiable.
@@ -163,10 +163,13 @@ Endpoints are grouped by service and hang off the client: the call convention is
163163
| `client.MonitorUtilities` | Monitor datasource preview |
164164
| `client.Analytics` | Analytics |
165165
| `client.A2aAgents` | A2A Agents |
166+
| `client.Automations` | AI SRE automations |
166167
| `client.McpServers` | MCP Servers |
167168
| `client.Sessions` | AI SRE sessions |
168169
| `client.Skills` | Skills |
169170
| `client.Applications` | RUM applications |
171+
| `client.DataQuery` | RUM data query |
172+
| `client.Facets` | RUM fields and facets |
170173
| `client.Issues` | RUM issues |
171174
| `client.Sourcemaps` | RUM sourcemaps |
172175

en/developer/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ See the [Command-line tool](/en/developer/cli) guide for the full installation m
5858

5959
## Go SDK
6060

61-
go-flashduty is the official Go SDK for Flashduty. Built in the go-github style, it provides a typed wrapper over the Flashduty OpenAPI covering 288 API operations across 32 services, so you can call them directly from Go with full type safety and autocompletion.
61+
go-flashduty is the official Go SDK for Flashduty. Built in the go-github style, it provides a typed wrapper over the Flashduty OpenAPI covering 291 API operations across 32 services, so you can call them directly from Go with full type safety and autocompletion.
6262

6363
The module is `github.com/flashcatcloud/go-flashduty` and requires Go 1.24+. Install with one command:
6464

en/home.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ Integrate Flashduty through Open API and Webhooks for automation and custom deve
162162
Authentication, request specs, error handling
163163
</Card>
164164
<Card title="API Catalog" icon="list" href="/en/openapi/api-catalog">
165-
All 288 endpoints organized by module
165+
All 291 endpoints organized by module
166166
</Card>
167167
<Card title="About Pagination" icon="file-lines" href="/en/openapi/pagination">
168168
Traditional and cursor pagination

en/rum/sdk/web/sdk-integration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,8 +172,8 @@ Whether to enable long task event collection
172172
Whether to enable cross-session anonymous user ID collection
173173
</ParamField>
174174

175-
<ParamField body="sessionReplayPrivacyLevel" type="'allow' | 'mask-user-input' | 'mask-all'" default="mask-user-input">
176-
Session replay privacy policy: `allow` collects all data except passwords, `mask-user-input` hides user input field content, `mask-all` hides all text
175+
<ParamField body="sessionReplayPrivacyLevel" type="'allow' | 'mask-user-input' | 'mask'" default="mask-user-input">
176+
Session replay privacy policy: `allow` collects all data except passwords, `mask-user-input` hides user input field content, and `mask` hides all text
177177
</ParamField>
178178

179179
<ParamField body="allowedTracingUrls" type="array">

0 commit comments

Comments
 (0)