diff --git a/api-reference/on-call.openapi.en.json b/api-reference/on-call.openapi.en.json index d0d801f..4cd686c 100644 --- a/api-reference/on-call.openapi.en.json +++ b/api-reference/on-call.openapi.en.json @@ -4569,12 +4569,12 @@ "post": { "operationId": "template-write-update", "summary": "Update a template", - "description": "Replace the content of every channel on an existing template.", + "description": "Update an existing template. Only the fields present in the request are written: a channel you omit keeps its current content, and an explicit empty string clears it.", "tags": [ "On-call/Notification templates" ], "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Templates Manage** (`on-call`) |\n\n## Usage\n\n- Every channel field in the request overwrites the stored value — send an empty string to clear a channel.\n- The caller needs data-permission on the template's team; otherwise the response is `AccessDenied`.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.", + "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Templates Manage** (`on-call`) |\n\n## Usage\n\n- Only the fields present in the request are written. A channel you omit keeps its current content; send it as an empty string to clear it.\n- The caller needs data-permission on the template's team; otherwise the response is `AccessDenied`.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.", "href": "/en/api-reference/on-call/notification-templates/template-write-update", "metadata": { "sidebarTitle": "Update a template" @@ -28245,10 +28245,12 @@ "example": "6605a1b2c3d4e5f6a7b8c9d0" }, "team_id": { - "type": "integer", + "type": [ + "integer", + "null" + ], "format": "int64", - "description": "Team scope. 0 for account-wide.", - "default": 0 + "description": "Team scope. 0 for account-wide. Omit to keep the template's current team." }, "template_name": { "type": "string", @@ -28257,37 +28259,61 @@ "description": "Template name. 1–39 characters." }, "description": { - "type": "string", + "type": [ + "string", + "null" + ], "maxLength": 500, - "description": "Free-form description. Up to 500 characters." + "description": "Free-form description. Up to 500 characters. Omit to keep the current content; send an empty string to clear it." }, "email": { - "type": "string", - "description": "Email body template source (Go `html/template` syntax)." + "type": [ + "string", + "null" + ], + "description": "Email body template source (Go `html/template` syntax). Omit to keep the current content; send an empty string to clear it." }, "sms": { - "type": "string", - "description": "SMS template source (Go `text/template` syntax)." + "type": [ + "string", + "null" + ], + "description": "SMS template source (Go `text/template` syntax). Omit to keep the current content; send an empty string to clear it." }, "voice": { - "type": "string", - "description": "Voice call script template source." + "type": [ + "string", + "null" + ], + "description": "Voice call script template source. Omit to keep the current content; send an empty string to clear it." }, "dingtalk": { - "type": "string", - "description": "DingTalk robot message template source." + "type": [ + "string", + "null" + ], + "description": "DingTalk robot message template source. Omit to keep the current content; send an empty string to clear it." }, "wecom": { - "type": "string", - "description": "WeCom robot message template source." + "type": [ + "string", + "null" + ], + "description": "WeCom robot message template source. Omit to keep the current content; send an empty string to clear it." }, "feishu": { - "type": "string", - "description": "Feishu robot message template source." + "type": [ + "string", + "null" + ], + "description": "Feishu robot message template source. Omit to keep the current content; send an empty string to clear it." }, "feishu_app": { - "type": "string", - "description": "Feishu app message template source." + "type": [ + "string", + "null" + ], + "description": "Feishu app message template source. Omit to keep the current content; send an empty string to clear it." }, "feishu_app_card_v2_table_enabled": { "type": [ @@ -28297,32 +28323,53 @@ "description": "When set, enable or disable table rendering for alert labels in Feishu app cards. Omit to keep the existing setting." }, "dingtalk_app": { - "type": "string", - "description": "DingTalk app message template source." + "type": [ + "string", + "null" + ], + "description": "DingTalk app message template source. Omit to keep the current content; send an empty string to clear it." }, "wecom_app": { - "type": "string", - "description": "WeCom app message template source." + "type": [ + "string", + "null" + ], + "description": "WeCom app message template source. Omit to keep the current content; send an empty string to clear it." }, "slack_app": { - "type": "string", - "description": "Slack app message template source." + "type": [ + "string", + "null" + ], + "description": "Slack app message template source. Omit to keep the current content; send an empty string to clear it." }, "teams_app": { - "type": "string", - "description": "Microsoft Teams app message template source." + "type": [ + "string", + "null" + ], + "description": "Microsoft Teams app message template source. Omit to keep the current content; send an empty string to clear it." }, "telegram": { - "type": "string", - "description": "Telegram bot message template source." + "type": [ + "string", + "null" + ], + "description": "Telegram bot message template source. Omit to keep the current content; send an empty string to clear it." }, "slack": { - "type": "string", - "description": "Slack robot message template source." + "type": [ + "string", + "null" + ], + "description": "Slack robot message template source. Omit to keep the current content; send an empty string to clear it." }, "zoom": { - "type": "string", - "description": "Zoom bot message template source." + "type": [ + "string", + "null" + ], + "description": "Zoom bot message template source. Omit to keep the current content; send an empty string to clear it." }, "incident_card_hidden_fields": { "$ref": "#/components/schemas/IncidentCardHiddenFields", diff --git a/api-reference/on-call.openapi.zh.json b/api-reference/on-call.openapi.zh.json index 32f36d3..3491b2a 100644 --- a/api-reference/on-call.openapi.zh.json +++ b/api-reference/on-call.openapi.zh.json @@ -4569,12 +4569,12 @@ "post": { "operationId": "template-write-update", "summary": "更新模板", - "description": "替换指定模板在所有通道上的内容。", + "description": "更新指定模板。仅写入请求中出现的字段：省略的通道保持当前内容，显式传空字符串表示清空该通道。", "tags": [ "On-call/通知模板" ], "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **模板管理**（`on-call`） |\n\n## 使用说明\n\n- 请求中的每个通道字段会覆盖存储值——想清空某通道时，把该字段设置为空字符串即可。\n- 调用者必须对目标模板所属团队拥有数据权限，否则返回 `AccessDenied`。\n- 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。", + "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **模板管理**（`on-call`） |\n\n## 使用说明\n\n- 仅写入请求中出现的字段：省略的通道保持当前内容；想清空某通道，把该字段显式设置为空字符串。\n- 调用者必须对目标模板所属团队拥有数据权限，否则返回 `AccessDenied`。\n- 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。", "href": "/zh/api-reference/on-call/notification-templates/template-write-update", "metadata": { "sidebarTitle": "更新模板" @@ -28236,10 +28236,12 @@ "example": "6605a1b2c3d4e5f6a7b8c9d0" }, "team_id": { - "type": "integer", + "type": [ + "integer", + "null" + ], "format": "int64", - "description": "团队归属。0 表示账户全局共享。", - "default": 0 + "description": "团队归属。0 表示账户全局共享。省略时保持模板当前的团队归属。" }, "template_name": { "type": "string", @@ -28248,37 +28250,61 @@ "description": "模板名称，长度 1–39 个字符。" }, "description": { - "type": "string", + "type": [ + "string", + "null" + ], "maxLength": 500, - "description": "自定义描述。最多 500 字符。" + "description": "自定义描述。最多 500 字符。省略时保持当前内容；传空字符串表示清空。" }, "email": { - "type": "string", - "description": "邮件正文模板源（Go `html/template` 语法）。" + "type": [ + "string", + "null" + ], + "description": "邮件正文模板源（Go `html/template` 语法）。省略时保持当前内容；传空字符串表示清空。" }, "sms": { - "type": "string", - "description": "短信模板源（Go `text/template` 语法）。" + "type": [ + "string", + "null" + ], + "description": "短信模板源（Go `text/template` 语法）。省略时保持当前内容；传空字符串表示清空。" }, "voice": { - "type": "string", - "description": "语音呼叫脚本模板源。" + "type": [ + "string", + "null" + ], + "description": "语音呼叫脚本模板源。省略时保持当前内容；传空字符串表示清空。" }, "dingtalk": { - "type": "string", - "description": "钉钉群机器人消息模板源。" + "type": [ + "string", + "null" + ], + "description": "钉钉群机器人消息模板源。省略时保持当前内容；传空字符串表示清空。" }, "wecom": { - "type": "string", - "description": "企业微信群机器人消息模板源。" + "type": [ + "string", + "null" + ], + "description": "企业微信群机器人消息模板源。省略时保持当前内容；传空字符串表示清空。" }, "feishu": { - "type": "string", - "description": "飞书群机器人消息模板源。" + "type": [ + "string", + "null" + ], + "description": "飞书群机器人消息模板源。省略时保持当前内容；传空字符串表示清空。" }, "feishu_app": { - "type": "string", - "description": "飞书应用消息模板源。" + "type": [ + "string", + "null" + ], + "description": "飞书应用消息模板源。省略时保持当前内容；传空字符串表示清空。" }, "feishu_app_card_v2_table_enabled": { "type": [ @@ -28288,32 +28314,53 @@ "description": "设置后开启或关闭飞书应用卡片中的告警标签表格渲染；省略时保持当前设置。" }, "dingtalk_app": { - "type": "string", - "description": "钉钉应用消息模板源。" + "type": [ + "string", + "null" + ], + "description": "钉钉应用消息模板源。省略时保持当前内容；传空字符串表示清空。" }, "wecom_app": { - "type": "string", - "description": "企业微信应用消息模板源。" + "type": [ + "string", + "null" + ], + "description": "企业微信应用消息模板源。省略时保持当前内容；传空字符串表示清空。" }, "slack_app": { - "type": "string", - "description": "Slack 应用消息模板源。" + "type": [ + "string", + "null" + ], + "description": "Slack 应用消息模板源。省略时保持当前内容；传空字符串表示清空。" }, "teams_app": { - "type": "string", - "description": "Microsoft Teams 应用消息模板源。" + "type": [ + "string", + "null" + ], + "description": "Microsoft Teams 应用消息模板源。省略时保持当前内容；传空字符串表示清空。" }, "telegram": { - "type": "string", - "description": "Telegram 机器人消息模板源。" + "type": [ + "string", + "null" + ], + "description": "Telegram 机器人消息模板源。省略时保持当前内容；传空字符串表示清空。" }, "slack": { - "type": "string", - "description": "Slack 机器人消息模板源。" + "type": [ + "string", + "null" + ], + "description": "Slack 机器人消息模板源。省略时保持当前内容；传空字符串表示清空。" }, "zoom": { - "type": "string", - "description": "Zoom 机器人消息模板源。" + "type": [ + "string", + "null" + ], + "description": "Zoom 机器人消息模板源。省略时保持当前内容；传空字符串表示清空。" }, "incident_card_hidden_fields": { "$ref": "#/components/schemas/IncidentCardHiddenFields", diff --git a/api-reference/openapi.en.json b/api-reference/openapi.en.json index d397044..5536d93 100644 --- a/api-reference/openapi.en.json +++ b/api-reference/openapi.en.json @@ -9168,12 +9168,12 @@ "post": { "operationId": "template-write-update", "summary": "Update a template", - "description": "Replace the content of every channel on an existing template.", + "description": "Update an existing template. Only the fields present in the request are written: a channel you omit keeps its current content, and an explicit empty string clears it.", "tags": [ "On-call/Notification templates" ], "x-mint": { - "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Templates Manage** (`on-call`) |\n\n## Usage\n\n- Every channel field in the request overwrites the stored value — send an empty string to clear a channel.\n- The caller needs data-permission on the template's team; otherwise the response is `AccessDenied`.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.", + "content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Templates Manage** (`on-call`) |\n\n## Usage\n\n- Only the fields present in the request are written. A channel you omit keeps its current content; send it as an empty string to clear it.\n- The caller needs data-permission on the template's team; otherwise the response is `AccessDenied`.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.", "href": "/en/api-reference/on-call/notification-templates/template-write-update", "metadata": { "sidebarTitle": "Update a template" @@ -39963,10 +39963,12 @@ "example": "6605a1b2c3d4e5f6a7b8c9d0" }, "team_id": { - "type": "integer", + "type": [ + "integer", + "null" + ], "format": "int64", - "description": "Team scope. 0 for account-wide.", - "default": 0 + "description": "Team scope. 0 for account-wide. Omit to keep the template's current team." }, "template_name": { "type": "string", @@ -39975,37 +39977,61 @@ "description": "Template name. 1–39 characters." }, "description": { - "type": "string", + "type": [ + "string", + "null" + ], "maxLength": 500, - "description": "Free-form description. Up to 500 characters." + "description": "Free-form description. Up to 500 characters. Omit to keep the current content; send an empty string to clear it." }, "email": { - "type": "string", - "description": "Email body template source (Go `html/template` syntax)." + "type": [ + "string", + "null" + ], + "description": "Email body template source (Go `html/template` syntax). Omit to keep the current content; send an empty string to clear it." }, "sms": { - "type": "string", - "description": "SMS template source (Go `text/template` syntax)." + "type": [ + "string", + "null" + ], + "description": "SMS template source (Go `text/template` syntax). Omit to keep the current content; send an empty string to clear it." }, "voice": { - "type": "string", - "description": "Voice call script template source." + "type": [ + "string", + "null" + ], + "description": "Voice call script template source. Omit to keep the current content; send an empty string to clear it." }, "dingtalk": { - "type": "string", - "description": "DingTalk robot message template source." + "type": [ + "string", + "null" + ], + "description": "DingTalk robot message template source. Omit to keep the current content; send an empty string to clear it." }, "wecom": { - "type": "string", - "description": "WeCom robot message template source." + "type": [ + "string", + "null" + ], + "description": "WeCom robot message template source. Omit to keep the current content; send an empty string to clear it." }, "feishu": { - "type": "string", - "description": "Feishu robot message template source." + "type": [ + "string", + "null" + ], + "description": "Feishu robot message template source. Omit to keep the current content; send an empty string to clear it." }, "feishu_app": { - "type": "string", - "description": "Feishu app message template source." + "type": [ + "string", + "null" + ], + "description": "Feishu app message template source. Omit to keep the current content; send an empty string to clear it." }, "feishu_app_card_v2_table_enabled": { "type": [ @@ -40015,32 +40041,53 @@ "description": "When set, enable or disable table rendering for alert labels in Feishu app cards. Omit to keep the existing setting." }, "dingtalk_app": { - "type": "string", - "description": "DingTalk app message template source." + "type": [ + "string", + "null" + ], + "description": "DingTalk app message template source. Omit to keep the current content; send an empty string to clear it." }, "wecom_app": { - "type": "string", - "description": "WeCom app message template source." + "type": [ + "string", + "null" + ], + "description": "WeCom app message template source. Omit to keep the current content; send an empty string to clear it." }, "slack_app": { - "type": "string", - "description": "Slack app message template source." + "type": [ + "string", + "null" + ], + "description": "Slack app message template source. Omit to keep the current content; send an empty string to clear it." }, "teams_app": { - "type": "string", - "description": "Microsoft Teams app message template source." + "type": [ + "string", + "null" + ], + "description": "Microsoft Teams app message template source. Omit to keep the current content; send an empty string to clear it." }, "telegram": { - "type": "string", - "description": "Telegram bot message template source." + "type": [ + "string", + "null" + ], + "description": "Telegram bot message template source. Omit to keep the current content; send an empty string to clear it." }, "slack": { - "type": "string", - "description": "Slack robot message template source." + "type": [ + "string", + "null" + ], + "description": "Slack robot message template source. Omit to keep the current content; send an empty string to clear it." }, "zoom": { - "type": "string", - "description": "Zoom bot message template source." + "type": [ + "string", + "null" + ], + "description": "Zoom bot message template source. Omit to keep the current content; send an empty string to clear it." }, "incident_card_hidden_fields": { "$ref": "#/components/schemas/IncidentCardHiddenFields", diff --git a/api-reference/openapi.zh.json b/api-reference/openapi.zh.json index ab97e67..8c68fbf 100644 --- a/api-reference/openapi.zh.json +++ b/api-reference/openapi.zh.json @@ -9168,12 +9168,12 @@ "post": { "operationId": "template-write-update", "summary": "更新模板", - "description": "替换指定模板在所有通道上的内容。", + "description": "更新指定模板。仅写入请求中出现的字段：省略的通道保持当前内容，显式传空字符串表示清空该通道。", "tags": [ "On-call/通知模板" ], "x-mint": { - "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **模板管理**（`on-call`） |\n\n## 使用说明\n\n- 请求中的每个通道字段会覆盖存储值——想清空某通道时，把该字段设置为空字符串即可。\n- 调用者必须对目标模板所属团队拥有数据权限，否则返回 `AccessDenied`。\n- 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。", + "content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**；**50 次/秒** |\n| 权限要求 | **模板管理**（`on-call`） |\n\n## 使用说明\n\n- 仅写入请求中出现的字段：省略的通道保持当前内容；想清空某通道，把该字段显式设置为空字符串。\n- 调用者必须对目标模板所属团队拥有数据权限，否则返回 `AccessDenied`。\n- 每次调用都会记录到账户审计日志，请不要把敏感信息放在请求字段中。", "href": "/zh/api-reference/on-call/notification-templates/template-write-update", "metadata": { "sidebarTitle": "更新模板" @@ -39954,10 +39954,12 @@ "example": "6605a1b2c3d4e5f6a7b8c9d0" }, "team_id": { - "type": "integer", + "type": [ + "integer", + "null" + ], "format": "int64", - "description": "团队归属。0 表示账户全局共享。", - "default": 0 + "description": "团队归属。0 表示账户全局共享。省略时保持模板当前的团队归属。" }, "template_name": { "type": "string", @@ -39966,37 +39968,61 @@ "description": "模板名称，长度 1–39 个字符。" }, "description": { - "type": "string", + "type": [ + "string", + "null" + ], "maxLength": 500, - "description": "自定义描述。最多 500 字符。" + "description": "自定义描述。最多 500 字符。省略时保持当前内容；传空字符串表示清空。" }, "email": { - "type": "string", - "description": "邮件正文模板源（Go `html/template` 语法）。" + "type": [ + "string", + "null" + ], + "description": "邮件正文模板源（Go `html/template` 语法）。省略时保持当前内容；传空字符串表示清空。" }, "sms": { - "type": "string", - "description": "短信模板源（Go `text/template` 语法）。" + "type": [ + "string", + "null" + ], + "description": "短信模板源（Go `text/template` 语法）。省略时保持当前内容；传空字符串表示清空。" }, "voice": { - "type": "string", - "description": "语音呼叫脚本模板源。" + "type": [ + "string", + "null" + ], + "description": "语音呼叫脚本模板源。省略时保持当前内容；传空字符串表示清空。" }, "dingtalk": { - "type": "string", - "description": "钉钉群机器人消息模板源。" + "type": [ + "string", + "null" + ], + "description": "钉钉群机器人消息模板源。省略时保持当前内容；传空字符串表示清空。" }, "wecom": { - "type": "string", - "description": "企业微信群机器人消息模板源。" + "type": [ + "string", + "null" + ], + "description": "企业微信群机器人消息模板源。省略时保持当前内容；传空字符串表示清空。" }, "feishu": { - "type": "string", - "description": "飞书群机器人消息模板源。" + "type": [ + "string", + "null" + ], + "description": "飞书群机器人消息模板源。省略时保持当前内容；传空字符串表示清空。" }, "feishu_app": { - "type": "string", - "description": "飞书应用消息模板源。" + "type": [ + "string", + "null" + ], + "description": "飞书应用消息模板源。省略时保持当前内容；传空字符串表示清空。" }, "feishu_app_card_v2_table_enabled": { "type": [ @@ -40006,32 +40032,53 @@ "description": "设置后开启或关闭飞书应用卡片中的告警标签表格渲染；省略时保持当前设置。" }, "dingtalk_app": { - "type": "string", - "description": "钉钉应用消息模板源。" + "type": [ + "string", + "null" + ], + "description": "钉钉应用消息模板源。省略时保持当前内容；传空字符串表示清空。" }, "wecom_app": { - "type": "string", - "description": "企业微信应用消息模板源。" + "type": [ + "string", + "null" + ], + "description": "企业微信应用消息模板源。省略时保持当前内容；传空字符串表示清空。" }, "slack_app": { - "type": "string", - "description": "Slack 应用消息模板源。" + "type": [ + "string", + "null" + ], + "description": "Slack 应用消息模板源。省略时保持当前内容；传空字符串表示清空。" }, "teams_app": { - "type": "string", - "description": "Microsoft Teams 应用消息模板源。" + "type": [ + "string", + "null" + ], + "description": "Microsoft Teams 应用消息模板源。省略时保持当前内容；传空字符串表示清空。" }, "telegram": { - "type": "string", - "description": "Telegram 机器人消息模板源。" + "type": [ + "string", + "null" + ], + "description": "Telegram 机器人消息模板源。省略时保持当前内容；传空字符串表示清空。" }, "slack": { - "type": "string", - "description": "Slack 机器人消息模板源。" + "type": [ + "string", + "null" + ], + "description": "Slack 机器人消息模板源。省略时保持当前内容；传空字符串表示清空。" }, "zoom": { - "type": "string", - "description": "Zoom 机器人消息模板源。" + "type": [ + "string", + "null" + ], + "description": "Zoom 机器人消息模板源。省略时保持当前内容；传空字符串表示清空。" }, "incident_card_hidden_fields": { "$ref": "#/components/schemas/IncidentCardHiddenFields",