From 9266bd4b66810a5ed0df19306947fd799b6d668d Mon Sep 17 00:00:00 2001 From: ysyneu Date: Thu, 8 Oct 2026 01:37:21 -0700 Subject: [PATCH] docs(api): add incident_id filter and ref field to session list --- api-reference/openapi.en.json | 10 +++++++++- api-reference/openapi.zh.json | 10 +++++++++- api-reference/safari.openapi.en.json | 10 +++++++++- api-reference/safari.openapi.zh.json | 10 +++++++++- 4 files changed, 36 insertions(+), 4 deletions(-) diff --git a/api-reference/openapi.en.json b/api-reference/openapi.en.json index d4c919c38..0ad90a5ce 100644 --- a/api-reference/openapi.en.json +++ b/api-reference/openapi.en.json @@ -23915,6 +23915,10 @@ "description": "Creator person id.", "type": "string" }, + "ref": { + "type": "string", + "description": "Reference the session is about, as `inc_` when it is an incident session. Omitted when the session is not bound to a reference." + }, "creator_name": { "type": "string", "description": "Display name of the session creator, resolved when the response is rendered. Omitted when the member lookup fails." @@ -24119,6 +24123,10 @@ "format": "int64" }, "description": "Filter by who started the session: returns only sessions started by these members (a session is kept when `person_id` matches any of them). Intersects with `scope` and `team_ids`, so it never widens what the caller is allowed to see." + }, + "incident_id": { + "type": "string", + "description": "Filter to sessions about this incident, by incident ID. Matches the session bound to the incident, its forks, and the session that absorbed the incident through on-call incident fan-in while the absorbing rule still exists, so one incident can match several sessions. Intersects with `scope` and `team_ids`, so it never widens what the caller is allowed to see." } }, "required": [ @@ -58203,7 +58211,7 @@ "AI SRE/Sessions" ], "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | None — any valid `app_key` can call this operation |\n\n## Usage\n\n- Pagination uses `p`/`limit` (max 100); `scope` defaults to `all`.\n- `all` returns your personal sessions plus team sessions you can access; account admins see all team sessions, but not other users' personal sessions.\n- `team_ids` narrows the visible set and never expands access.\n- `is_running` reflects the live run-set; `has_unread` is computed per calling user; the `current_turn_*` fields are always zero here — only `session/get` computes them while a session is running.\n- `suggest_init` is an account-wide onboarding flag (true only when the account has no knowledge in any scope) — it doesn't depend on the list filters.\n", + "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | None — any valid `app_key` can call this operation |\n\n## Usage\n\n- Pagination uses `p`/`limit` (max 100); `scope` defaults to `all`.\n- `all` returns your personal sessions plus team sessions you can access; account admins see all team sessions, but not other users' personal sessions.\n- `team_ids` narrows the visible set and never expands access.\n- `incident_id` returns the sessions about one incident; the matching rows carry `ref` = `inc_`.\n- `is_running` reflects the live run-set; `has_unread` is computed per calling user; the `current_turn_*` fields are always zero here — only `session/get` computes them while a session is running.\n- `suggest_init` is an account-wide onboarding flag (true only when the account has no knowledge in any scope) — it doesn't depend on the list filters.\n", "href": "/en/api-reference/ai-sre/sessions/session-read-list", "metadata": { "sidebarTitle": "List sessions" diff --git a/api-reference/openapi.zh.json b/api-reference/openapi.zh.json index 75f58d1e8..9687cd77f 100644 --- a/api-reference/openapi.zh.json +++ b/api-reference/openapi.zh.json @@ -23915,6 +23915,10 @@ "description": "创建者人员 ID。", "type": "string" }, + "ref": { + "type": "string", + "description": "会话关联的对象引用；故障会话的值为 `inc_`。会话未绑定引用时省略。" + }, "creator_name": { "type": "string", "description": "会话创建者的显示名，渲染响应时解析得到；成员查询失败时不返回该字段。" @@ -24119,6 +24123,10 @@ "format": "int64" }, "description": "按会话发起人过滤：只返回由这些成员发起的会话（`person_id` 命中其一即保留）。与 `scope`、`team_ids` 取交集，因此不会让调用方看到本来无权限的会话。" + }, + "incident_id": { + "type": "string", + "description": "按故障 ID 过滤，仅返回与该故障相关的会话：包括绑定到该故障的会话、它的分叉会话，以及在吸收规则仍存在时通过 on-call 故障合并（fan-in）吸收了该故障的会话，因此一个故障可能匹配多个会话。与 `scope`、`team_ids` 取交集，不会扩大调用方的可见范围。" } }, "required": [ @@ -58203,7 +58211,7 @@ "AI SRE/会话" ], "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个 `app_key` **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | 无 —— 持有有效的 `app_key` 即可调用 |\n\n## 使用说明\n\n- 分页使用 `p`/`limit`（最大 100）；`scope` 默认 `all`。\n- `all` 返回调用者自己的个人会话，以及调用者可访问团队的团队会话；账户管理员可见所有团队会话，但不可见他人的个人会话。\n- `team_ids` 只会收窄可见集合，不会扩大访问范围。\n- `is_running` 反映实时运行集合；`has_unread` 按调用者各自计算；`current_turn_*` 字段在此接口恒为 0 —— 仅 `session/get` 会在会话运行时计算它们。\n- `suggest_init` 是账户级的引导提示（仅当账户在任何范围内都没有知识时为 true），与列表过滤条件无关。\n", + "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个 `app_key` **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | 无 —— 持有有效的 `app_key` 即可调用 |\n\n## 使用说明\n\n- 分页使用 `p`/`limit`（最大 100）；`scope` 默认 `all`。\n- `all` 返回调用者自己的个人会话，以及调用者可访问团队的团队会话；账户管理员可见所有团队会话，但不可见他人的个人会话。\n- `team_ids` 只会收窄可见集合，不会扩大访问范围。\n- 传 `incident_id` 返回与某个故障相关的会话；匹配到的行 `ref` 为 `inc_`。\n- `is_running` 反映实时运行集合；`has_unread` 按调用者各自计算；`current_turn_*` 字段在此接口恒为 0 —— 仅 `session/get` 会在会话运行时计算它们。\n- `suggest_init` 是账户级的引导提示（仅当账户在任何范围内都没有知识时为 true），与列表过滤条件无关。\n", "href": "/zh/api-reference/ai-sre/sessions/session-read-list", "metadata": { "sidebarTitle": "查询会话列表" diff --git a/api-reference/safari.openapi.en.json b/api-reference/safari.openapi.en.json index ad49ef08d..a919c5cca 100644 --- a/api-reference/safari.openapi.en.json +++ b/api-reference/safari.openapi.en.json @@ -2429,7 +2429,7 @@ } ], "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | None — any valid `app_key` can call this operation |\n\n## Usage\n\n- Pagination uses `p`/`limit` (max 100); `scope` defaults to `all`.\n- `all` returns your personal sessions plus team sessions you can access; account admins see all team sessions, but not other users' personal sessions.\n- `team_ids` narrows the visible set and never expands access.\n- `is_running` reflects the live run-set; `has_unread` is computed per calling user; the `current_turn_*` fields are always zero here — only `session/get` computes them while a session is running.\n- `suggest_init` is an account-wide onboarding flag (true only when the account has no knowledge in any scope) — it doesn't depend on the list filters.\n", + "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | None — any valid `app_key` can call this operation |\n\n## Usage\n\n- Pagination uses `p`/`limit` (max 100); `scope` defaults to `all`.\n- `all` returns your personal sessions plus team sessions you can access; account admins see all team sessions, but not other users' personal sessions.\n- `team_ids` narrows the visible set and never expands access.\n- `incident_id` returns the sessions about one incident; the matching rows carry `ref` = `inc_`.\n- `is_running` reflects the live run-set; `has_unread` is computed per calling user; the `current_turn_*` fields are always zero here — only `session/get` computes them while a session is running.\n- `suggest_init` is an account-wide onboarding flag (true only when the account has no knowledge in any scope) — it doesn't depend on the list filters.\n", "href": "/en/api-reference/ai-sre/sessions/session-read-list", "metadata": { "sidebarTitle": "List sessions" @@ -7308,6 +7308,10 @@ "type": "string", "description": "Creator person id." }, + "ref": { + "type": "string", + "description": "Reference the session is about, as `inc_` when it is an incident session. Omitted when the session is not bound to a reference." + }, "creator_name": { "type": "string", "description": "Display name of the session creator, resolved when the response is rendered. Omitted when the member lookup fails." @@ -7602,6 +7606,10 @@ "archived", "all" ] + }, + "incident_id": { + "type": "string", + "description": "Filter to sessions about this incident, by incident ID. Matches the session bound to the incident, its forks, and the session that absorbed the incident through on-call incident fan-in while the absorbing rule still exists, so one incident can match several sessions. Intersects with `scope` and `team_ids`, so it never widens what the caller is allowed to see." } }, "required": [ diff --git a/api-reference/safari.openapi.zh.json b/api-reference/safari.openapi.zh.json index c17d82529..08aa5ed6e 100644 --- a/api-reference/safari.openapi.zh.json +++ b/api-reference/safari.openapi.zh.json @@ -2429,7 +2429,7 @@ } ], "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个 `app_key` **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | 无 —— 持有有效的 `app_key` 即可调用 |\n\n## 使用说明\n\n- 分页使用 `p`/`limit`（最大 100）；`scope` 默认 `all`。\n- `all` 返回调用者自己的个人会话，以及调用者可访问团队的团队会话；账户管理员可见所有团队会话，但不可见他人的个人会话。\n- `team_ids` 只会收窄可见集合，不会扩大访问范围。\n- `is_running` 反映实时运行集合；`has_unread` 按调用者各自计算；`current_turn_*` 字段在此接口恒为 0 —— 仅 `session/get` 会在会话运行时计算它们。\n- `suggest_init` 是账户级的引导提示（仅当账户在任何范围内都没有知识时为 true），与列表过滤条件无关。\n", + "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个 `app_key` **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | 无 —— 持有有效的 `app_key` 即可调用 |\n\n## 使用说明\n\n- 分页使用 `p`/`limit`（最大 100）；`scope` 默认 `all`。\n- `all` 返回调用者自己的个人会话，以及调用者可访问团队的团队会话；账户管理员可见所有团队会话，但不可见他人的个人会话。\n- `team_ids` 只会收窄可见集合，不会扩大访问范围。\n- 传 `incident_id` 返回与某个故障相关的会话；匹配到的行 `ref` 为 `inc_`。\n- `is_running` 反映实时运行集合；`has_unread` 按调用者各自计算；`current_turn_*` 字段在此接口恒为 0 —— 仅 `session/get` 会在会话运行时计算它们。\n- `suggest_init` 是账户级的引导提示（仅当账户在任何范围内都没有知识时为 true），与列表过滤条件无关。\n", "href": "/zh/api-reference/ai-sre/sessions/session-read-list", "metadata": { "sidebarTitle": "查询会话列表" @@ -7308,6 +7308,10 @@ "type": "string", "description": "创建者人员 ID。" }, + "ref": { + "type": "string", + "description": "会话关联的对象引用；故障会话的值为 `inc_`。会话未绑定引用时省略。" + }, "creator_name": { "type": "string", "description": "会话创建者的显示名，渲染响应时解析得到；成员查询失败时不返回该字段。" @@ -7602,6 +7606,10 @@ "archived", "all" ] + }, + "incident_id": { + "type": "string", + "description": "按故障 ID 过滤，仅返回与该故障相关的会话：包括绑定到该故障的会话、它的分叉会话，以及在吸收规则仍存在时通过 on-call 故障合并（fan-in）吸收了该故障的会话，因此一个故障可能匹配多个会话。与 `scope`、`team_ids` 取交集，不会扩大调用方的可见范围。" } }, "required": [