Skip to content

Commit 31ba79d

Browse files
authored
Merge pull request #144 from flashcatcloud/doc-review/2026-07-07-031545
docs: update OpenAPI operation count
2 parents d8d8a64 + 14a8cb0 commit 31ba79d

8 files changed

Lines changed: 10 additions & 10 deletions

File tree

en/developer/cli.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,7 @@ 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 **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:
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, incident-trigger-subscription, change, channel, field, status-page, template, and more), it also covers:
380380

381381
- **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

en/developer/go-sdk.mdx

Lines changed: 2 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 291 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 288 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 **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.
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.
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.

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 291 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 288 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 291 endpoints organized by module
165+
All 288 endpoints organized by module
166166
</Card>
167167
<Card title="About Pagination" icon="file-lines" href="/en/openapi/pagination">
168168
Traditional and cursor pagination

zh/developer/cli.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,7 @@ flashduty monit preview-sync [flags]
376376

377377
### 全量命令覆盖
378378

379-
除上述精选命令外,CLI 现已通过 spec 驱动的代码生成实现对 Flashduty OpenAPI 的**全量覆盖**。当前 OpenAPI 含 **291 个 API 操作**,CLI 会为这些操作生成对应命令,并按资源组织为顶层命令组。除 On-call 域(incident、incident-trigger-subscription、change、channel、field、status-page、template 等)外,还覆盖了:
379+
除上述精选命令外,CLI 现已通过 spec 驱动的代码生成实现对 Flashduty OpenAPI 的**全量覆盖**。当前 OpenAPI 含 **288 个 API 操作**,CLI 会为这些操作生成对应命令,并按资源组织为顶层命令组。除 On-call 域(incident、incident-trigger-subscription、change、channel、field、status-page、template 等)外,还覆盖了:
380380

381381
- **AI SRE(`safari`**:a2a-agents、automations、mcp-servers、sessions、skills 等
382382
- **告警与降噪**:alert、alert-event、enrichment(alert-rules、rule-sets)、route

zh/developer/go-sdk.mdx

Lines changed: 2 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 是 Flashduty 官方开源的 Go SDK,与 Open API 严格 1:1 的类型化封装,当前覆盖全部 291 个 API 操作、32 个服务。"
4+
description: "go-flashduty 是 Flashduty 官方开源的 Go SDK,与 Open API 严格 1:1 的类型化封装,当前覆盖全部 288 个 API 操作、32 个服务。"
55
keywords: ["Go SDK", "go-flashduty", "Open API", "Golang", "客户端"]
66
---
77

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

1212
`go-flashduty` 是 Flashduty 官方开源的 Go 客户端,覆盖 Flashduty Open API 的每一个 REST 接口。它采用与 [go-github](https://github.com/google/go-github) 一致的设计风格——服务分组、类型化请求与响应、可组合传输层——并与 OpenAPI 规范保持严格 1:1:每个方法对应且仅对应一次 HTTP 调用,返回 `(*T, *Response, error)`,不做任何跨接口的隐式聚合或增强。
1313

14-
SDK 当前覆盖 **291 个 API 操作****32 个服务**,全部由 Flashduty OpenAPI 规范生成,经单元测试覆盖,并针对线上 API 做过端到端验证。
14+
SDK 当前覆盖 **288 个 API 操作****32 个服务**,全部由 Flashduty OpenAPI 规范生成,经单元测试覆盖,并针对线上 API 做过端到端验证。
1515

1616
<Note>
1717
SDK 故意保持"薄"。诸如短 ID 解析、跨接口编排等消费侧逻辑应放在调用方(CLI / MCP)中,而不是塞进 SDK 或滥用某个接口。这样 SDK 始终与 API 一一对应,可预测、可生成、可校验。

zh/developer/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ curl -sSL https://static.flashcat.cloud/flashduty-cli/install.sh | sh
5858

5959
## Go SDK
6060

61-
go-flashduty 是 Flashduty 官方的 Go SDK,采用 go-github 风格的设计,对 Flashduty OpenAPI 进行类型化封装,覆盖 291 个 API 操作、32 个服务。您可以在 Go 程序中直接调用,享受完整的类型安全和自动补全。
61+
go-flashduty 是 Flashduty 官方的 Go SDK,采用 go-github 风格的设计,对 Flashduty OpenAPI 进行类型化封装,覆盖 288 个 API 操作、32 个服务。您可以在 Go 程序中直接调用,享受完整的类型安全和自动补全。
6262

6363
模块为 `github.com/flashcatcloud/go-flashduty`,要求 Go 1.24+,一行命令安装:
6464

zh/home.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ AI SRE 目前处于**内测**阶段,专业版及以上用户可申请**免费
163163
认证方式、请求规范、错误处理
164164
</Card>
165165
<Card title="API 总览" icon="list" href="/zh/openapi/api-catalog">
166-
全部 291 个接口,按模块分类
166+
全部 288 个接口,按模块分类
167167
</Card>
168168
<Card title="关于分页" icon="file-lines" href="/zh/openapi/pagination">
169169
传统分页与游标分页机制

0 commit comments

Comments
 (0)