Skip to content

Commit 1a61da6

Browse files
authored
Merge pull request #213 from flashcatcloud/codex/openapi-postmortem-content-reset
docs(api): refine post-mortem content reset OpenAPI spec
2 parents 087ae35 + 48e59c2 commit 1a61da6

4 files changed

Lines changed: 8 additions & 8 deletions

File tree

api-reference/on-call.openapi.en.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14403,7 +14403,7 @@
1440314403
"On-call/Incidents"
1440414404
],
1440514405
"x-mint": {
14406-
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **300 requests/minute**; **20 requests/second** per account |\n| Permissions | Edit access to the target report is required. |\n\n## Usage\n\n- The report must be drafting and its current revision must equal `expected_revision`; otherwise the API returns `409 Conflict`.\n- Reuse an `idempotency_key` only for the same report, revision, and Markdown content; different reuse returns `409 Conflict`.\n- Markdown content is limited to 4 MiB.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.",
14406+
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **300 requests/minute**; **20 requests/second** per account |\n| Permissions | Edit access to the target report is required. |\n\n## Usage\n\n- The report must be drafting and its current revision must equal `expected_revision`; otherwise the API returns `409 Conflict`.\n- Reuse an `idempotency_key` only for the same report, revision, and Markdown content; different reuse returns `409 Conflict`.\n- A successful reset disconnects the previous collaboration (Yjs) room. Reconnect to the new generation room `post-mortem-{accountId}-{postMortemId}-g{N}` (generation 0 has no `-g` suffix). The reset cannot be rolled back.\n- Markdown content is limited to 4 MiB.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.",
1440714407
"href": "/en/api-reference/on-call/incidents/incident-post-mortem-write-reset-content",
1440814408
"metadata": {
1440914409
"sidebarTitle": "Reset post-mortem content"
@@ -24336,7 +24336,7 @@
2433624336
},
2433724337
"markdown_bytes": {
2433824338
"type": "integer",
24339-
"format": "int32",
24339+
"format": "int64",
2434024340
"description": "UTF-8 byte length of the accepted Markdown content."
2434124341
},
2434224342
"markdown_sha256": {

api-reference/on-call.openapi.zh.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14395,7 +14395,7 @@
1439514395
"On-call/故障管理"
1439614396
],
1439714397
"x-mint": {
14398-
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **300 次/分钟**;**20 次/秒** |\n| 权限要求 | 调用方须拥有目标复盘的编辑权限。 |\n\n## 使用说明\n\n- 仅草稿状态的报告可重置,且当前修订版本必须等于 `expected_revision`;否则返回 `409 Conflict`。\n- 同一 `idempotency_key` 只能重试相同的复盘、修订版本和 Markdown 正文;复用到不同请求会返回 `409 Conflict`。\n- Markdown 正文最大为 4 MiB。\n- 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。",
14398+
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **300 次/分钟**;**20 次/秒** |\n| 权限要求 | 调用方须拥有目标复盘的编辑权限。 |\n\n## 使用说明\n\n- 仅草稿状态的报告可重置,且当前修订版本必须等于 `expected_revision`;否则返回 `409 Conflict`。\n- 同一 `idempotency_key` 只能重试相同的复盘、修订版本和 Markdown 正文;复用到不同请求会返回 `409 Conflict`。\n- 重置成功后旧的协作(Yjs)房间会被断开,客户端需切换到新 generation 的房间 `post-mortem-{accountId}-{postMortemId}-g{N}`(generation 0 无 `-g` 后缀)。重置不可回滚。\n- Markdown 正文最大为 4 MiB。\n- 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。",
1439914399
"href": "/zh/api-reference/on-call/incidents/incident-post-mortem-write-reset-content",
1440014400
"metadata": {
1440114401
"sidebarTitle": "重置故障复盘正文"
@@ -24327,7 +24327,7 @@
2432724327
},
2432824328
"markdown_bytes": {
2432924329
"type": "integer",
24330-
"format": "int32",
24330+
"format": "int64",
2433124331
"description": "服务端接受的 Markdown 内容 UTF-8 字节数。"
2433224332
},
2433324333
"markdown_sha256": {

api-reference/openapi.en.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21387,7 +21387,7 @@
2138721387
"On-call/Incidents"
2138821388
],
2138921389
"x-mint": {
21390-
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **300 requests/minute**; **20 requests/second** per account |\n| Permissions | Edit access to the target report is required. |\n\n## Usage\n\n- The report must be drafting and its current revision must equal `expected_revision`; otherwise the API returns `409 Conflict`.\n- Reuse an `idempotency_key` only for the same report, revision, and Markdown content; different reuse returns `409 Conflict`.\n- Markdown content is limited to 4 MiB.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.",
21390+
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **300 requests/minute**; **20 requests/second** per account |\n| Permissions | Edit access to the target report is required. |\n\n## Usage\n\n- The report must be drafting and its current revision must equal `expected_revision`; otherwise the API returns `409 Conflict`.\n- Reuse an `idempotency_key` only for the same report, revision, and Markdown content; different reuse returns `409 Conflict`.\n- A successful reset disconnects the previous collaboration (Yjs) room. Reconnect to the new generation room `post-mortem-{accountId}-{postMortemId}-g{N}` (generation 0 has no `-g` suffix). The reset cannot be rolled back.\n- Markdown content is limited to 4 MiB.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.",
2139121391
"href": "/en/api-reference/on-call/incidents/incident-post-mortem-write-reset-content",
2139221392
"metadata": {
2139321393
"sidebarTitle": "Reset post-mortem content"
@@ -29745,7 +29745,7 @@
2974529745
},
2974629746
"markdown_bytes": {
2974729747
"type": "integer",
29748-
"format": "int32",
29748+
"format": "int64",
2974929749
"description": "UTF-8 byte length of the accepted Markdown content."
2975029750
},
2975129751
"markdown_sha256": {

api-reference/openapi.zh.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21379,7 +21379,7 @@
2137921379
"On-call/故障管理"
2138021380
],
2138121381
"x-mint": {
21382-
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **300 次/分钟**;**20 次/秒** |\n| 权限要求 | 调用方须拥有目标复盘的编辑权限。 |\n\n## 使用说明\n\n- 仅草稿状态的报告可重置,且当前修订版本必须等于 `expected_revision`;否则返回 `409 Conflict`。\n- 同一 `idempotency_key` 只能重试相同的复盘、修订版本和 Markdown 正文;复用到不同请求会返回 `409 Conflict`。\n- Markdown 正文最大为 4 MiB。\n- 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。",
21382+
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **300 次/分钟**;**20 次/秒** |\n| 权限要求 | 调用方须拥有目标复盘的编辑权限。 |\n\n## 使用说明\n\n- 仅草稿状态的报告可重置,且当前修订版本必须等于 `expected_revision`;否则返回 `409 Conflict`。\n- 同一 `idempotency_key` 只能重试相同的复盘、修订版本和 Markdown 正文;复用到不同请求会返回 `409 Conflict`。\n- 重置成功后旧的协作(Yjs)房间会被断开,客户端需切换到新 generation 的房间 `post-mortem-{accountId}-{postMortemId}-g{N}`(generation 0 无 `-g` 后缀)。重置不可回滚。\n- Markdown 正文最大为 4 MiB。\n- 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。",
2138321383
"href": "/zh/api-reference/on-call/incidents/incident-post-mortem-write-reset-content",
2138421384
"metadata": {
2138521385
"sidebarTitle": "重置故障复盘正文"
@@ -29736,7 +29736,7 @@
2973629736
},
2973729737
"markdown_bytes": {
2973829738
"type": "integer",
29739-
"format": "int32",
29739+
"format": "int64",
2974029740
"description": "服务端接受的 Markdown 内容 UTF-8 字节数。"
2974129741
},
2974229742
"markdown_sha256": {

0 commit comments

Comments
 (0)