Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion en/developer/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -376,7 +376,7 @@ Common flags:

### Full command coverage

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 **275 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:
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:

- **AI SRE (`safari`)**: a2a-agents, mcp-servers, sessions, skills, and more
- **Alerting & noise reduction**: alert, alert-event, enrichment (alert-rules, rule-sets), route
Expand Down
4 changes: 2 additions & 2 deletions en/developer/go-sdk.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Go SDK
sidebarTitle: Go SDK
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 275 endpoints across 29 services."
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."
keywords: ["Go SDK", "go-flashduty", "Open API", "Golang", "client"]
---

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

`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.

The SDK currently covers **275 endpoints** across **29 services**, all generated from the Flashduty OpenAPI spec, covered by unit tests, and end-to-end verified against the live API.
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.

<Note>
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.
Expand Down
2 changes: 1 addition & 1 deletion en/developer/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ See the [Command-line tool](/en/developer/cli) guide for the full installation m

## Go SDK

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 roughly 254 endpoints across 27 services, so you can call them directly from Go with full type safety and autocompletion.
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.

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

Expand Down
2 changes: 1 addition & 1 deletion en/home.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ Integrate Flashduty through Open API and Webhooks for automation and custom deve
Authentication, request specs, error handling
</Card>
<Card title="API Catalog" icon="list" href="/en/openapi/api-catalog">
All 214 endpoints organized by module
All 288 endpoints organized by module
</Card>
<Card title="About Pagination" icon="file-lines" href="/en/openapi/pagination">
Traditional and cursor pagination
Expand Down
2 changes: 1 addition & 1 deletion zh/developer/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -376,7 +376,7 @@ flashduty monit preview-sync [flags]

### 全量命令覆盖

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

- **AI SRE(`safari`)**:a2a-agents、mcp-servers、sessions、skills 等
- **告警与降噪**:alert、alert-event、enrichment(alert-rules、rule-sets)、route
Expand Down
4 changes: 2 additions & 2 deletions zh/developer/go-sdk.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Go SDK
sidebarTitle: Go SDK
description: "go-flashduty 是 Flashduty 官方开源的 Go SDK,与 Open API 严格 1:1 的类型化封装,当前覆盖全部 275 个接口、29 个服务。"
description: "go-flashduty 是 Flashduty 官方开源的 Go SDK,与 Open API 严格 1:1 的类型化封装,当前覆盖全部 288 个 API 操作、32 个服务。"
keywords: ["Go SDK", "go-flashduty", "Open API", "Golang", "客户端"]
---

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

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

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

<Note>
SDK 故意保持"薄"。诸如短 ID 解析、跨接口编排等消费侧逻辑应放在调用方(CLI / MCP)中,而不是塞进 SDK 或滥用某个接口。这样 SDK 始终与 API 一一对应,可预测、可生成、可校验。
Expand Down
2 changes: 1 addition & 1 deletion zh/developer/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ curl -sSL https://static.flashcat.cloud/flashduty-cli/install.sh | sh

## Go SDK

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

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

Expand Down