Skip to content

Commit 3379fff

Browse files
ysyneuclaude
andauthored
docs: replace old developer.flashcat.cloud links with new API reference (#45)
* docs: add API reference with developer guide, catalog, and bilingual sidebar - Add x-mint.href /en/ prefix to all EN OpenAPI specs (was missing, caused 404) - Add x-mint.metadata.sidebarTitle to all operations for correct bilingual sidebar labels - Create developer guide pages: Quick Start (merged rate-limits), API Catalog, Pagination - Quick Start includes Open API vs Webhooks/Events comparison at top - API Catalog lists all 214 endpoints with clickable links organized by module - Move route rules outside channels group, next to integrations - Navbar API Reference link points to Quick Start page - Update pagination page links from old docs URLs to new API reference paths - Remove RequestExample from introduction (not an API schema page) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: move glossary to repo root, update README, add Developer section to home - Move glossary.md from .cursor/skills/ to repo root for easier access - Update CLAUDE.md, README.md, README_zh.md to reference new glossary path - Add api-reference/ and glossary.md to directory structure in READMEs - Add Developer section to both zh/home.mdx and en/home.mdx with links to Quick Start, API Catalog, and Pagination pages Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: replace external developer.flashcat.cloud links with internal API reference paths Migrate all doc links pointing to the legacy developer portal to use internal /api-reference/ routes, add API terminology to the translation glossary, exclude api-reference/ from Meilisearch indexing, and add the legacy OpenAPI spec archive. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: replace all old developer.flashcat.cloud links with new API reference Replace 34 references to developer.flashcat.cloud and developer-en.flashcat.cloud across 18 doc files with internal links to the new API reference pages: - Open API quickstart → /openapi/introduction - Incident list API → /api-reference/on-call/incidents/incident-list - Member invite API → /api-reference/platform/members/member-invite - Insight API → /api-reference/on-call/analytics/insight-incident-list - Mapping data API → /api-reference/on-call/alert-enrichment/mapping-data-write-upsert - Standard alert event → /on-call/integration/alert-integration/alert-sources/standard alert - Email integration → /on-call/integration/alert-integration/alert-sources/email - Change event → /on-call/integration/change-integration/custom-event - Webhook → /on-call/integration/webhooks/incident-webhook - Redirect pages (openapi.mdx) → /openapi/introduction No frontend repos (fc-foundation-app, flashduty-app, status-page-fe, flashduty-mcp-server, terraform-provider-flashduty) contain these old URLs. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 814a8ee commit 3379fff

9 files changed

Lines changed: 9 additions & 9 deletions

File tree

en/on-call/advanced/reference-variables.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ By referencing variables from alert labels and attributes, you can modify and cu
99

1010
<CardGroup cols={2}>
1111
<Card title="Event API Reporting" icon="code">
12-
When reporting custom alert events via the alert [Event API](https://developer.flashcat.cloud/zh/flashduty/event-api/alert-event), you can use the `title_rule` field to customize the alert title.
12+
When reporting custom alert events via the alert [Event API](/en/on-call/integration/alert-integration/alert-sources/standard alert), you can use the `title_rule` field to customize the alert title.
1313
</Card>
1414
<Card title="Alert Pipeline" icon="filter" href="/en/on-call/integration/alert-integration/alert-pipelines">
1515
Reference variables in alert pipelines to modify alert severity, title, description, and other information.

en/on-call/integration/alert-integration/alert-sources/standard alert.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Field|Required|Type|Description
8787
Field|Required|Type|Description
8888
:-:|:-:|:-:|:---
8989
| alt | No | string | Image alternative text, limit 128 characters, truncated if exceeded.
90-
| src | Yes | string | Image source, value: http/https URL or image_key returned by [Image Upload API](https://developer.flashcat.cloud/api-344943718). Limit 256 characters, discarded if exceeded
90+
| src | Yes | string | Image source, value: http/https URL or image_key returned by [Image Upload API](/en/openapi/api-catalog). Limit 256 characters, discarded if exceeded
9191
| href | No | string | Hyperlink reference path, limit 256 characters, truncated if exceeded
9292

9393
</div>

en/on-call/integration/alert-integration/label-enhancement.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ In the mapping table details page, you can manage mapping table data:
225225
</Frame>
226226

227227
<Tip>
228-
For frequently changing mapping relationships (like Mapping api data sync), we recommend using API mapping, or use [Flashduty API](https://developer.flashcat.cloud/api-142429470) for automated mapping table updates.
228+
For frequently changing mapping relationships (like Mapping api data sync), we recommend using API mapping, or use [Flashduty API](/en/api-reference/on-call/alert-enrichment/mapping-data-write-upsert) for automated mapping table updates.
229229
</Tip>
230230

231231
### Mapping Service API Specification

en/on-call/integration/change-integration/custom-event.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Click **Save**, then copy the newly generated **Push URL** from the current page
2727

2828
## Implement Protocol
2929

30-
Please refer to the [Developer Documentation](https://developer.flashcat.cloud/zh/flashduty/event-api/change-event) to complete protocol development.
30+
Please refer to the [Developer Documentation](/en/on-call/integration/change-integration/custom-event) to complete protocol development.
3131

3232
## Best Practices
3333

zh/on-call/advanced/reference-variables.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ keywords: ["引用变量", "模板变量", "标签引用", "动态内容", "变
1010

1111
<CardGroup cols={2}>
1212
<Card title="Event API 上报" icon="code">
13-
通过告警 [Event API](https://developer.flashcat.cloud/zh/flashduty/event-api/alert-event) 上报自定义告警事件时,可以使用 `title_rule` 字段自定义告警的标题。
13+
通过告警 [Event API](/zh/on-call/integration/alert-integration/alert-sources/standard alert) 上报自定义告警事件时,可以使用 `title_rule` 字段自定义告警的标题。
1414
</Card>
1515
<Card title="告警 Pipeline" icon="filter" href="/zh/on-call/integration/alert-integration/alert-pipelines">
1616
在告警 Pipeline 中引用变量,实现对告警的严重程度、标题和描述等信息的修改。

zh/on-call/integration/alert-integration/alert-sources/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ POST, Content-Type:"application/json"
9292
字段|必含|类型|释义
9393
:-:|:-:|:-:|:---
9494
| alt | 否 | string | 图片的替代文本, 长度限制 128 字符,超长截断。
95-
| src | 是 | string | 图片来源,值:http/https 开头的图片链接地址 或 [图片上传接口](https://developer.flashcat.cloud/api-344943718)返回的image_key,长度限制 256 字符,超长会被丢弃
95+
| src | 是 | string | 图片来源,值:http/https 开头的图片链接地址 或 [图片上传接口](/zh/openapi/api-catalog)返回的image_key,长度限制 256 字符,超长会被丢弃
9696
| href | 否 | string | 超链接引用路径,长度限制 256 字符,超长截断
9797

9898
</div>

zh/on-call/integration/alert-integration/alert-sources/standard alert.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ POST, Content-Type:"application/json"
8383
字段|必含|类型|释义
8484
:-:|:-:|:-:|:---
8585
| alt | 否 | string | 图片的替代文本, 长度限制 128 字符,超长截断。
86-
| src | 是 | string | 图片来源,值:http/https 开头的图片链接地址 或 [图片上传接口](https://developer.flashcat.cloud/api-344943718)返回的image_key,长度限制 256 字符,超长会被丢弃
86+
| src | 是 | string | 图片来源,值:http/https 开头的图片链接地址 或 [图片上传接口](/zh/openapi/api-catalog)返回的image_key,长度限制 256 字符,超长会被丢弃
8787
| href | 否 | string | 超链接引用路径,长度限制 256 字符,超长截断
8888

8989
</div>

zh/on-call/integration/alert-integration/label-enhancement.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ keywords: ["标签增强", "自动标签", "数据提取", "字段映射", "告
225225
</Frame>
226226

227227
<Tip>
228-
对于频繁变更的映射关系(如 Mapping api 数据同步),建议使用 API 映射方式,或通过 [Flashduty API](https://developer.flashcat.cloud/api-142429470) 自动化更新映射表数据。
228+
对于频繁变更的映射关系(如 Mapping api 数据同步),建议使用 API 映射方式,或通过 [Flashduty API](/zh/api-reference/on-call/alert-enrichment/mapping-data-write-upsert) 自动化更新映射表数据。
229229
</Tip>
230230

231231
### 映射服务 API 规范

zh/on-call/integration/change-integration/custom-event.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Flashduty On-call 已适配部分常用工单、部署系统的 webhook 协议
2828

2929
## 实现协议
3030

31-
请参照 [开发文档](https://developer.flashcat.cloud/zh/flashduty/event-api/change-event) 完成协议开发。
31+
请参照 [开发文档](/zh/on-call/integration/change-integration/custom-event) 完成协议开发。
3232

3333
## 最佳实践
3434

0 commit comments

Comments
 (0)