Skip to content

docs(api): document incident labels and invite schedule assignment #1134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ysyneu merged 1 commit into from
Oct 26, 2026
Merged

docs(api): document incident labels and invite schedule assignment #1134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 14 additions & 1 deletion api-reference/on-call.openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14621,6 +14621,11 @@
"person_ids": [
2476444212131
]
},
"labels": {
"env": "production",
"service": "order-api",
"region": "cn-hangzhou"
}
}
},
Expand Down Expand Up @@ -22474,6 +22479,14 @@
"fields": {
"$ref": "#/components/schemas/CustomFieldValues",
"description": "Custom field values keyed by field name. When a create form applies, only its visible fields are accepted."
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"maxProperties": 50,
"description": "Labels to store on the created incident, up to 50 entries. Blank values are dropped. Spaces and selected punctuation in keys become `_`; keys and values are trimmed, and values are truncated at 8 KiB."
}
}
},
Expand Down Expand Up @@ -25488,7 +25501,7 @@
"additionalProperties": {
"type": "string"
},
"description": "Labels propagated from alerts."
"description": "Labels on the incident, propagated from alerts or set at creation."
},
"fields": {
"type": "object",
Expand Down
15 changes: 14 additions & 1 deletion api-reference/on-call.openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14621,6 +14621,11 @@
"person_ids": [
2476444212131
]
},
"labels": {
"env": "production",
"service": "order-api",
"region": "cn-hangzhou"
}
}
},
Expand Down Expand Up @@ -22474,6 +22479,14 @@
"fields": {
"$ref": "#/components/schemas/CustomFieldValues",
"description": "以字段名为键的自定义字段值。创建表单生效时，只接受表单中可见的字段。"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"maxProperties": 50,
"description": "新建故障时写入的标签，最多 50 个。空值会被丢弃。key 中的空格和部分标点会替换为 `_`；key 和 value 会去掉首尾空白，value 截断到 8 KiB。"
}
}
},
Expand Down Expand Up @@ -25488,7 +25501,7 @@
"additionalProperties": {
"type": "string"
},
"description": "从告警继承的标签。"
"description": "故障的标签，可从告警继承，也可在手动创建时设置。"
},
"fields": {
"type": "object",
Expand Down
23 changes: 21 additions & 2 deletions api-reference/openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5965,6 +5965,14 @@
"fields": {
"$ref": "#/components/schemas/CustomFieldValues",
"description": "Custom field values keyed by field name. When a create form applies, only its visible fields are accepted."
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"maxProperties": 50,
"description": "Labels to store on the created incident, up to 50 entries. Blank values are dropped. Spaces and selected punctuation in keys become `_`; keys and values are trimmed, and values are truncated at 8 KiB."
}
}
},
Expand Down Expand Up @@ -12214,7 +12222,7 @@
"additionalProperties": {
"type": "string"
},
"description": "Labels propagated from alerts."
"description": "Labels on the incident, propagated from alerts or set at creation."
},
"fields": {
"type": "object",
Expand Down Expand Up @@ -13220,6 +13228,11 @@
"ref_id": {
"type": "string",
"description": "External reference ID (for example an employee ID in an HR system), usable later as a lookup key in `POST /member/delete` and `POST /member/info/reset`."
},
"schedule_id": {
"type": "integer",
"format": "uint64",
"description": "Schedule to add the member to after the member is created or accepts the invitation. The join runs as the caller; if the caller cannot edit the schedule, the schedule is deleted, or it has no joinable layer, the invitation still succeeds but the member is not added. Omit it to invite without a schedule."
}
}
},
Expand Down Expand Up @@ -45022,6 +45035,11 @@
"person_ids": [
2476444212131
]
},
"labels": {
"env": "production",
"service": "order-api",
"region": "cn-hangzhou"
}
}
},
Expand Down Expand Up @@ -50532,7 +50550,8 @@
"time_zone": "Asia/Shanghai",
"role_ids": [
6
]
],
"schedule_id": 5789640530410
},
{
"member_name": "Dave",
Expand Down
23 changes: 21 additions & 2 deletions api-reference/openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5965,6 +5965,14 @@
"fields": {
"$ref": "#/components/schemas/CustomFieldValues",
"description": "以字段名为键的自定义字段值。创建表单生效时，只接受表单中可见的字段。"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"maxProperties": 50,
"description": "新建故障时写入的标签，最多 50 个。空值会被丢弃。key 中的空格和部分标点会替换为 `_`；key 和 value 会去掉首尾空白，value 截断到 8 KiB。"
}
}
},
Expand Down Expand Up @@ -12214,7 +12222,7 @@
"additionalProperties": {
"type": "string"
},
"description": "从告警继承的标签。"
"description": "故障的标签，可从告警继承，也可在手动创建时设置。"
},
"fields": {
"type": "object",
Expand Down Expand Up @@ -13220,6 +13228,11 @@
"ref_id": {
"type": "string",
"description": "外部引用 ID（如 HR 系统中的员工号），之后可在 `POST /member/delete`、`POST /member/info/reset` 中作为查找键。"
},
"schedule_id": {
"type": "integer",
"format": "uint64",
"description": "成员创建或接受邀请后要加入的值班排班 ID。加入动作以调用方身份执行；调用方无权编辑排班、排班已删除或没有可加入的层级时，邀请仍会成功，但成员不会加入该排班。不传表示邀请不带排班。"
}
}
},
Expand Down Expand Up @@ -45022,6 +45035,11 @@
"person_ids": [
2476444212131
]
},
"labels": {
"env": "production",
"service": "order-api",
"region": "cn-hangzhou"
}
}
},
Expand Down Expand Up @@ -50532,7 +50550,8 @@
"time_zone": "Asia/Shanghai",
"role_ids": [
6
]
],
"schedule_id": 5789640530410
},
{
"member_name": "Dave",
Expand Down
8 changes: 7 additions & 1 deletion api-reference/platform.openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1001,7 +1001,8 @@
"time_zone": "Asia/Shanghai",
"role_ids": [
6
]
],
"schedule_id": 5789640530410
},
{
"member_name": "Dave",
Expand Down Expand Up @@ -3023,6 +3024,11 @@
"ref_id": {
"type": "string",
"description": "External reference ID (for example an employee ID in an HR system), usable later as a lookup key in `POST /member/delete` and `POST /member/info/reset`."
},
"schedule_id": {
"type": "integer",
"format": "uint64",
"description": "Schedule to add the member to after the member is created or accepts the invitation. The join runs as the caller; if the caller cannot edit the schedule, the schedule is deleted, or it has no joinable layer, the invitation still succeeds but the member is not added. Omit it to invite without a schedule."
}
}
},
Expand Down
8 changes: 7 additions & 1 deletion api-reference/platform.openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1001,7 +1001,8 @@
"time_zone": "Asia/Shanghai",
"role_ids": [
6
]
],
"schedule_id": 5789640530410
},
{
"member_name": "Dave",
Expand Down Expand Up @@ -3023,6 +3024,11 @@
"ref_id": {
"type": "string",
"description": "外部引用 ID（如 HR 系统中的员工号），之后可在 `POST /member/delete`、`POST /member/info/reset` 中作为查找键。"
},
"schedule_id": {
"type": "integer",
"format": "uint64",
"description": "成员创建或接受邀请后要加入的值班排班 ID。加入动作以调用方身份执行；调用方无权编辑排班、排班已删除或没有可加入的层级时，邀请仍会成功，但成员不会加入该排班。不传表示邀请不带排班。"
}
}
},
Expand Down
Loading