docs(api-reference): daily api-review 2026-10-23 — incident labels, invite schedule_id, reorder example

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

@@ -135,6 +135,11 @@
             "application/json": {
               "schema": {
                 "$ref": "#/components/schemas/ReorderEscalationRulesRequest"
+              },
+              "example": {
+                "channel_id": 1001,
+                "drag_rule_id": "6621b23f4a2c5e0012ab34d9",
+                "target_rule_id": "6621b23f4a2c5e0012ab34d0"
               }
             }
           }
@@ -14616,6 +14621,11 @@
                   "person_ids": [
                     2476444212131
                   ]
+                },
+                "labels": {
+                  "env": "production",
+                  "service": "order-api",
+                  "region": "cn-hangzhou"
                 }
               }
             },
@@ -22469,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, keys are normalized to `[a-zA-Z_][a-zA-Z0-9_]*` (other characters become `_`), and values are trimmed and truncated at 8 KiB."
           }
         }
       },

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

@@ -135,6 +135,11 @@
             "application/json": {
               "schema": {
                 "$ref": "#/components/schemas/ReorderEscalationRulesRequest"
+              },
+              "example": {
+                "channel_id": 1001,
+                "drag_rule_id": "6621b23f4a2c5e0012ab34d9",
+                "target_rule_id": "6621b23f4a2c5e0012ab34d0"
               }
             }
           }
@@ -14616,6 +14621,11 @@
                   "person_ids": [
                     2476444212131
                   ]
+                },
+                "labels": {
+                  "env": "production",
+                  "service": "order-api",
+                  "region": "cn-hangzhou"
                 }
               }
             },
@@ -22469,6 +22479,14 @@
           "fields": {
             "$ref": "#/components/schemas/CustomFieldValues",
             "description": "以字段名为键的自定义字段值。创建表单生效时，只接受表单中可见的字段。"
+          },
+          "labels": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string"
+            },
+            "maxProperties": 50,
+            "description": "新建故障时写入的标签，最多 50 个。空值会被丢弃，key 会规范化为 `[a-zA-Z_][a-zA-Z0-9_]*`（其它字符替换为 `_`），value 会去掉首尾空白并截断到 8 KiB。"
           }
         }
       },

api-reference/openapi.en.json

@@ -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, keys are normalized to `[a-zA-Z_][a-zA-Z0-9_]*` (other characters become `_`), and values are trimmed and truncated at 8 KiB."
           }
         }
       },
@@ -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 once the invitation is accepted. The join runs as the caller, so they must be allowed to edit that schedule; a schedule that was deleted or has no joinable layer is skipped. Omit it to invite without a schedule."
           }
         }
       },
@@ -39944,6 +39957,11 @@
             "application/json": {
               "schema": {
                 "$ref": "#/components/schemas/ReorderEscalationRulesRequest"
+              },
+              "example": {
+                "channel_id": 1001,
+                "drag_rule_id": "6621b23f4a2c5e0012ab34d9",
+                "target_rule_id": "6621b23f4a2c5e0012ab34d0"
               }
             }
           }
@@ -44993,6 +45011,11 @@
                   "person_ids": [
                     2476444212131
                   ]
+                },
+                "labels": {
+                  "env": "production",
+                  "service": "order-api",
+                  "region": "cn-hangzhou"
                 }
               }
             },
@@ -50503,7 +50526,8 @@
                     "time_zone": "Asia/Shanghai",
                     "role_ids": [
                       6
-                    ]
+                    ],
+                    "schedule_id": 5789640530410
                   },
                   {
                     "member_name": "Dave",

api-reference/openapi.zh.json

@@ -5965,6 +5965,14 @@
           "fields": {
             "$ref": "#/components/schemas/CustomFieldValues",
             "description": "以字段名为键的自定义字段值。创建表单生效时，只接受表单中可见的字段。"
+          },
+          "labels": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string"
+            },
+            "maxProperties": 50,
+            "description": "新建故障时写入的标签，最多 50 个。空值会被丢弃，key 会规范化为 `[a-zA-Z_][a-zA-Z0-9_]*`（其它字符替换为 `_`），value 会去掉首尾空白并截断到 8 KiB。"
           }
         }
       },
@@ -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。加入动作以调用方身份执行，因此调用方必须有权编辑该排班；排班已被删除或没有可加入的层级时会跳过。不传表示邀请不带排班。"
           }
         }
       },
@@ -39944,6 +39957,11 @@
             "application/json": {
               "schema": {
                 "$ref": "#/components/schemas/ReorderEscalationRulesRequest"
+              },
+              "example": {
+                "channel_id": 1001,
+                "drag_rule_id": "6621b23f4a2c5e0012ab34d9",
+                "target_rule_id": "6621b23f4a2c5e0012ab34d0"
               }
             }
           }
@@ -44993,6 +45011,11 @@
                   "person_ids": [
                     2476444212131
                   ]
+                },
+                "labels": {
+                  "env": "production",
+                  "service": "order-api",
+                  "region": "cn-hangzhou"
                 }
               }
             },
@@ -50503,7 +50526,8 @@
                     "time_zone": "Asia/Shanghai",
                     "role_ids": [
                       6
-                    ]
+                    ],
+                    "schedule_id": 5789640530410
                   },
                   {
                     "member_name": "Dave",

api-reference/platform.openapi.en.json

@@ -1001,7 +1001,8 @@
                     "time_zone": "Asia/Shanghai",
                     "role_ids": [
                       6
-                    ]
+                    ],
+                    "schedule_id": 5789640530410
                   },
                   {
                     "member_name": "Dave",
@@ -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 once the invitation is accepted. The join runs as the caller, so they must be allowed to edit that schedule; a schedule that was deleted or has no joinable layer is skipped. Omit it to invite without a schedule."
           }
         }
       },

api-reference/platform.openapi.zh.json

@@ -1001,7 +1001,8 @@
                     "time_zone": "Asia/Shanghai",
                     "role_ids": [
                       6
-                    ]
+                    ],
+                    "schedule_id": 5789640530410
                   },
                   {
                     "member_name": "Dave",
@@ -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。加入动作以调用方身份执行，因此调用方必须有权编辑该排班；排班已被删除或没有可加入的层级时会跳过。不传表示邀请不带排班。"
           }
         }
       },

docs.json

@@ -1639,6 +1639,10 @@
       "source": "/channel/escalate/rule/list",
       "destination": "/zh/api-reference/on-call/channels/channel-escalate-rule-list"
     },
+    {
+      "source": "/channel/escalate/rule/reorder",
+      "destination": "/zh/api-reference/on-call/channels/channel-escalate-rule-reorder"
+    },
     {
       "source": "/channel/escalate/rule/update",
       "destination": "/zh/api-reference/on-call/channels/channel-escalate-rule-update"