Skip to content

feat: model /template/update fields as nullable so channels can be patched#63

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 2 commits into from
Aug 24, 2026
Merged

feat: model /template/update fields as nullable so channels can be patched #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
345cc25
feat: model /template/update fields as nullable so channels can be pa…
ysyneu Aug 23, 2026
524b4bc
chore: carry the /template/update usage note from the docs spec
ysyneu Aug 24, 2026
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
27 changes: 22 additions & 5 deletions flashduty_test.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -507,6 +507,15 @@ func TestNullableRequestFieldsSendExplicitZero(t *testing.T) {
at: []string{"feishu_app_card_v2_table_enabled"},
want: false,
},
{
// Clearing a channel is an explicit empty string. It must survive
// the encoder: dropping it would silently mean "leave as is".
name: "template update clears a channel",
path: "/template/update",
body: &TemplateUpdateRequest{TemplateID: "t-1", TemplateName: "t", DingtalkApp: String("")},
at: []string{"dingtalk_app"},
want: "",
},
}

for _, tt := range tests {
Expand DownExpand Up@@ -560,11 +569,19 @@ func TestNullableRequestFieldsOmitUnsetValues(t *testing.T) {
present: []string{`"scopes"`},
},
{
name: "template update leaves the feishu card table alone",
path: "/template/update",
body: &TemplateUpdateRequest{TemplateID: "t-1", TemplateName: "t"},
absent: []string{`"feishu_app_card_v2_table_enabled"`},
present: []string{`"template_id":"t-1"`},
// An update that touches one channel must not carry the others:
// on the wire, a channel that is present is a channel that gets
// written.
name: "template update carries only the channel it changes",
path: "/template/update",
body: &TemplateUpdateRequest{TemplateID: "t-1", TemplateName: "t", Feishu: String("{{ .title }}")},
absent: []string{
`"feishu_app_card_v2_table_enabled"`, `"description"`, `"team_id"`,
`"email"`, `"sms"`, `"voice"`, `"dingtalk"`, `"wecom"`, `"feishu_app"`,
`"dingtalk_app"`, `"wecom_app"`, `"slack_app"`, `"teams_app"`,
`"telegram"`, `"slack"`, `"zoom"`,
},
present: []string{`"template_id":"t-1"`, `"feishu":"{{ .title }}"`},
},
}

Expand Down
64 changes: 32 additions & 32 deletions models_gen.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion notification_templates.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

117 changes: 82 additions & 35 deletions openapi/openapi.en.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9171,12 +9171,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"
Expand DownExpand Up@@ -39972,10 +39972,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",
Expand All@@ -39984,37 +39986,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": [
Expand All@@ -40024,32 +40050,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",
Expand Down
Loading