Skip to content

Commit f64b6d0

Browse files
committed
Merge remote-tracking branch 'origin/main' into doc-review/20260901-091033
# Conflicts: # en/changelog/changelog.mdx # en/on-call/incident/search-view-incident.mdx # zh/changelog/changelog.mdx # zh/on-call/incident/search-view-incident.mdx
2 parents ea91be4 + 7d581e4 commit f64b6d0

95 files changed

Lines changed: 135068 additions & 124340 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

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

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17322,6 +17322,95 @@
1732217322
}
1732317323
}
1732417324
}
17325+
},
17326+
"/schedule/by-person": {
17327+
"post": {
17328+
"operationId": "scheduleByPerson",
17329+
"summary": "Get member on-call status",
17330+
"description": "Get a member's current and next on-call shifts and every enabled schedule they participate in.",
17331+
"tags": [
17332+
"On-call/Schedules"
17333+
],
17334+
"x-mint": {
17335+
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Schedules Read** (`on-call`) or **Schedules Manage** (`on-call`) |\n\n## Usage\n\n- `current` carries the shift in progress with its true start time; `next` is the upcoming shift, absent when nothing is scheduled within the lookup window.\n- Disabled schedules are not listed.",
17336+
"href": "/en/api-reference/on-call/schedules/schedule-by-person",
17337+
"metadata": {
17338+
"sidebarTitle": "Get member on-call status"
17339+
}
17340+
},
17341+
"responses": {
17342+
"200": {
17343+
"description": "Success",
17344+
"content": {
17345+
"application/json": {
17346+
"schema": {
17347+
"allOf": [
17348+
{
17349+
"$ref": "#/components/schemas/SuccessEnvelope"
17350+
},
17351+
{
17352+
"type": "object",
17353+
"properties": {
17354+
"data": {
17355+
"$ref": "#/components/schemas/ScheduleByPersonResponse"
17356+
}
17357+
}
17358+
}
17359+
]
17360+
},
17361+
"example": {
17362+
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
17363+
"data": {
17364+
"current": {
17365+
"schedule_id": 2539108069860,
17366+
"schedule_name": "Open Source Q&A",
17367+
"start_at": 1773446400,
17368+
"end_at": 1773532799
17369+
},
17370+
"next": {
17371+
"schedule_id": 2539108069860,
17372+
"schedule_name": "Open Source Q&A",
17373+
"start_at": 1773532800,
17374+
"end_at": 1773619199
17375+
},
17376+
"schedules": [
17377+
{
17378+
"schedule_id": 2539108069860,
17379+
"schedule_name": "Open Source Q&A"
17380+
}
17381+
]
17382+
}
17383+
}
17384+
}
17385+
}
17386+
},
17387+
"400": {
17388+
"$ref": "#/components/responses/BadRequest"
17389+
},
17390+
"401": {
17391+
"$ref": "#/components/responses/Unauthorized"
17392+
},
17393+
"429": {
17394+
"$ref": "#/components/responses/TooManyRequests"
17395+
},
17396+
"500": {
17397+
"$ref": "#/components/responses/ServerError"
17398+
}
17399+
},
17400+
"requestBody": {
17401+
"required": true,
17402+
"content": {
17403+
"application/json": {
17404+
"schema": {
17405+
"$ref": "#/components/schemas/ScheduleByPersonRequest"
17406+
},
17407+
"example": {
17408+
"person_id": 2476444212131
17409+
}
17410+
}
17411+
}
17412+
}
17413+
}
1732517414
}
1732617415
},
1732717416
"components": {
@@ -33346,6 +33435,82 @@
3334633435
"title": "a_unack",
3334733436
"description": "Detail payload for `a_unack` (historical). No fields.",
3334833437
"properties": {}
33438+
},
33439+
"ScheduleByPersonRequest": {
33440+
"type": "object",
33441+
"description": "Member on-call status request",
33442+
"properties": {
33443+
"person_id": {
33444+
"type": "integer",
33445+
"description": "Member ID whose on-call status is returned.",
33446+
"format": "int64"
33447+
}
33448+
},
33449+
"required": [
33450+
"person_id"
33451+
]
33452+
},
33453+
"ScheduleByPersonResponse": {
33454+
"type": "object",
33455+
"description": "The member's on-call status: the shift in progress, the next one, and every enabled schedule they participate in.",
33456+
"properties": {
33457+
"current": {
33458+
"$ref": "#/components/schemas/MemberOncallInterval"
33459+
},
33460+
"next": {
33461+
"$ref": "#/components/schemas/MemberOncallInterval"
33462+
},
33463+
"schedules": {
33464+
"type": "array",
33465+
"description": "All enabled schedules the member participates in.",
33466+
"items": {
33467+
"$ref": "#/components/schemas/MemberScheduleItem"
33468+
}
33469+
}
33470+
},
33471+
"required": [
33472+
"schedules"
33473+
]
33474+
},
33475+
"MemberScheduleItem": {
33476+
"type": "object",
33477+
"description": "An enabled schedule the member participates in.",
33478+
"properties": {
33479+
"schedule_id": {
33480+
"type": "integer",
33481+
"description": "Schedule ID.",
33482+
"format": "int64"
33483+
},
33484+
"schedule_name": {
33485+
"type": "string",
33486+
"description": "Schedule name."
33487+
}
33488+
}
33489+
},
33490+
"MemberOncallInterval": {
33491+
"type": "object",
33492+
"description": "One on-call shift interval of a member.",
33493+
"properties": {
33494+
"schedule_id": {
33495+
"type": "integer",
33496+
"description": "Owning schedule ID.",
33497+
"format": "int64"
33498+
},
33499+
"schedule_name": {
33500+
"type": "string",
33501+
"description": "Owning schedule name."
33502+
},
33503+
"start_at": {
33504+
"type": "integer",
33505+
"description": "Unix timestamp in seconds - when the shift starts.",
33506+
"format": "int64"
33507+
},
33508+
"end_at": {
33509+
"type": "integer",
33510+
"description": "Unix timestamp in seconds - when the shift ends. Absent while the shift is ongoing.",
33511+
"format": "int64"
33512+
}
33513+
}
3334933514
}
3335033515
}
3335133516
}

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

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17322,6 +17322,95 @@
1732217322
}
1732317323
}
1732417324
}
17325+
},
17326+
"/schedule/by-person": {
17327+
"post": {
17328+
"operationId": "scheduleByPerson",
17329+
"summary": "查看成员值班状态",
17330+
"description": "查看某成员正在值班的班次、下一次值班以及其参与的全部启用排班。",
17331+
"tags": [
17332+
"On-call/值班排班"
17333+
],
17334+
"x-mint": {
17335+
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**;**50 次/秒** |\n| 权限要求 | **值班查看**(`on-call`) 或 **值班管理**(`on-call`) |\n\n## 使用说明\n\n- `current` 为正在值班的班次(含真实开始时间);`next` 为下一次值班,查询窗口内没有排班时缺省。\n- 已禁用的排班不会出现在列表中。",
17336+
"href": "/zh/api-reference/on-call/schedules/schedule-by-person",
17337+
"metadata": {
17338+
"sidebarTitle": "查看成员值班状态"
17339+
}
17340+
},
17341+
"responses": {
17342+
"200": {
17343+
"description": "Success",
17344+
"content": {
17345+
"application/json": {
17346+
"schema": {
17347+
"allOf": [
17348+
{
17349+
"$ref": "#/components/schemas/SuccessEnvelope"
17350+
},
17351+
{
17352+
"type": "object",
17353+
"properties": {
17354+
"data": {
17355+
"$ref": "#/components/schemas/ScheduleByPersonResponse"
17356+
}
17357+
}
17358+
}
17359+
]
17360+
},
17361+
"example": {
17362+
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
17363+
"data": {
17364+
"current": {
17365+
"schedule_id": 2539108069860,
17366+
"schedule_name": "Open Source Q&A",
17367+
"start_at": 1773446400,
17368+
"end_at": 1773532799
17369+
},
17370+
"next": {
17371+
"schedule_id": 2539108069860,
17372+
"schedule_name": "Open Source Q&A",
17373+
"start_at": 1773532800,
17374+
"end_at": 1773619199
17375+
},
17376+
"schedules": [
17377+
{
17378+
"schedule_id": 2539108069860,
17379+
"schedule_name": "Open Source Q&A"
17380+
}
17381+
]
17382+
}
17383+
}
17384+
}
17385+
}
17386+
},
17387+
"400": {
17388+
"$ref": "#/components/responses/BadRequest"
17389+
},
17390+
"401": {
17391+
"$ref": "#/components/responses/Unauthorized"
17392+
},
17393+
"429": {
17394+
"$ref": "#/components/responses/TooManyRequests"
17395+
},
17396+
"500": {
17397+
"$ref": "#/components/responses/ServerError"
17398+
}
17399+
},
17400+
"requestBody": {
17401+
"required": true,
17402+
"content": {
17403+
"application/json": {
17404+
"schema": {
17405+
"$ref": "#/components/schemas/ScheduleByPersonRequest"
17406+
},
17407+
"example": {
17408+
"person_id": 2476444212131
17409+
}
17410+
}
17411+
}
17412+
}
17413+
}
1732517414
}
1732617415
},
1732717416
"components": {
@@ -33346,6 +33435,82 @@
3334633435
"title": "a_unack",
3334733436
"description": "`a_unack` 的详情数据(历史),无字段。",
3334833437
"properties": {}
33438+
},
33439+
"ScheduleByPersonRequest": {
33440+
"type": "object",
33441+
"description": "成员值班状态查询请求",
33442+
"properties": {
33443+
"person_id": {
33444+
"type": "integer",
33445+
"description": "要查询值班状态的成员 ID。",
33446+
"format": "int64"
33447+
}
33448+
},
33449+
"required": [
33450+
"person_id"
33451+
]
33452+
},
33453+
"ScheduleByPersonResponse": {
33454+
"type": "object",
33455+
"description": "成员的值班状态:正在值班的班次、下一次值班,以及其参与的全部启用排班。",
33456+
"properties": {
33457+
"current": {
33458+
"$ref": "#/components/schemas/MemberOncallInterval"
33459+
},
33460+
"next": {
33461+
"$ref": "#/components/schemas/MemberOncallInterval"
33462+
},
33463+
"schedules": {
33464+
"type": "array",
33465+
"description": "该成员参与的全部启用排班。",
33466+
"items": {
33467+
"$ref": "#/components/schemas/MemberScheduleItem"
33468+
}
33469+
}
33470+
},
33471+
"required": [
33472+
"schedules"
33473+
]
33474+
},
33475+
"MemberScheduleItem": {
33476+
"type": "object",
33477+
"description": "该成员参与的一个启用中的排班。",
33478+
"properties": {
33479+
"schedule_id": {
33480+
"type": "integer",
33481+
"description": "排班 ID。",
33482+
"format": "int64"
33483+
},
33484+
"schedule_name": {
33485+
"type": "string",
33486+
"description": "排班名称。"
33487+
}
33488+
}
33489+
},
33490+
"MemberOncallInterval": {
33491+
"type": "object",
33492+
"description": "成员的一个值班班次区间。",
33493+
"properties": {
33494+
"schedule_id": {
33495+
"type": "integer",
33496+
"description": "所属排班 ID。",
33497+
"format": "int64"
33498+
},
33499+
"schedule_name": {
33500+
"type": "string",
33501+
"description": "所属排班名称。"
33502+
},
33503+
"start_at": {
33504+
"type": "integer",
33505+
"description": "Unix 时间戳(秒)—— 班次开始时间。",
33506+
"format": "int64"
33507+
},
33508+
"end_at": {
33509+
"type": "integer",
33510+
"description": "Unix 时间戳(秒)—— 班次结束时间。值班进行中时缺省。",
33511+
"format": "int64"
33512+
}
33513+
}
3334933514
}
3335033515
}
3335133516
}

0 commit comments

Comments
 (0)