Skip to content

Commit bc69dc2

Browse files
authored
Merge pull request #219 from flashcatcloud/fix/spec-timezone-and-grouping-window-units
fix(api-reference): correct automation timezone and channel grouping window units
2 parents 3fe436c + 226f3e2 commit bc69dc2

4 files changed

Lines changed: 6 additions & 6 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18565,7 +18565,7 @@
1856518565
"time_window": {
1856618566
"type": "integer",
1856718567
"minimum": 0,
18568-
"description": "Grouping time window in seconds."
18568+
"description": "Grouping time window in minutes. Default max is 1440 minutes (24 h); extended accounts may allow up to 43200 minutes (30 days)."
1856918569
},
1857018570
"window_type": {
1857118571
"type": "string",

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18557,7 +18557,7 @@
1855718557
"time_window": {
1855818558
"type": "integer",
1855918559
"minimum": 0,
18560-
"description": "聚合时间窗口,单位秒。"
18560+
"description": "聚合时间窗口,单位分钟。默认最大值为 1440 分钟(24 小时);开启扩展功能的账号最大可设置 43200 分钟(30 天)。"
1856118561
},
1856218562
"window_type": {
1856318563
"type": "string",

api-reference/safari.openapi.en.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -657,7 +657,7 @@
657657
}
658658
],
659659
"x-mint": {
660-
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **300 requests/minute**; **20 requests/second** per account |\n| Permissions | Valid `app_key`; management operations require the caller to manage the target rule |\n\n## Usage\n\n- A caller may create personal rules and rules for any team in the current account; `team_id` is immutable after creation.\n- `cron_expr` is evaluated in `timezone` if provided, else the caller's member timezone, else the account timezone, else UTC.\n- `http_post_trigger_enabled=true` creates and enables an HTTP POST trigger; the response's `http_post_token` is a one-time value returned only on creation — save it immediately.\n- `oncall_incident_trigger_enabled=true` requires at least one `oncall_incident_channel_ids` entry and one `oncall_incident_severities` value; matching incidents run with `trigger_kind=oncall_incident`.\n- Every call is recorded in the account audit log.\n",
660+
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **300 requests/minute**; **20 requests/second** per account |\n| Permissions | Valid `app_key`; management operations require the caller to manage the target rule |\n\n## Usage\n\n- A caller may create personal rules and rules for any team in the current account; `team_id` is immutable after creation.\n- `cron_expr` is evaluated in `timezone` if provided, else the caller's member timezone, else the account timezone, else the server default (Asia/Shanghai).\n- `http_post_trigger_enabled=true` creates and enables an HTTP POST trigger; the response's `http_post_token` is a one-time value returned only on creation — save it immediately.\n- `oncall_incident_trigger_enabled=true` requires at least one `oncall_incident_channel_ids` entry and one `oncall_incident_severities` value; matching incidents run with `trigger_kind=oncall_incident`.\n- Every call is recorded in the account audit log.\n",
661661
"href": "/en/api-reference/ai-sre/automations/automation-rule-write-create",
662662
"metadata": {
663663
"sidebarTitle": "Create Automation rule"
@@ -3807,7 +3807,7 @@
38073807
},
38083808
"timezone": {
38093809
"type": "string",
3810-
"description": "IANA timezone `cron_expr` is evaluated in, e.g. `Asia/Shanghai`. Must be a timezone name loadable by the server; an invalid value is rejected. Defaults to the caller's member timezone, then the account timezone, then UTC when omitted."
3810+
"description": "IANA timezone `cron_expr` is evaluated in, e.g. `Asia/Shanghai`. Must be a timezone name loadable by the server; an invalid value is rejected. Defaults to the caller's member timezone, then the account timezone, then the server default (Asia/Shanghai) when omitted."
38113811
},
38123812
"schedule_trigger_enabled": {
38133813
"type": [

api-reference/safari.openapi.zh.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -657,7 +657,7 @@
657657
}
658658
],
659659
"x-mint": {
660-
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **300 次/分钟**;**20 次/秒** |\n| 权限要求 | 有效 `app_key`;管理操作要求调用者可管理目标规则 |\n\n## 使用说明\n\n- 可以创建个人规则,也可以创建当前账户下任意团队的规则;`team_id` 创建后不可修改。\n- `cron_expr` 按 `timezone`(如提供)计算;未提供时依次回退到调用者的成员时区、账户时区,最后是 UTC\n- `http_post_trigger_enabled=true` 会创建并启用 HTTP POST 触发器;响应中的 `http_post_token` 是仅在创建时返回的一次性值,请立即保存。\n- `oncall_incident_trigger_enabled=true` 时,`oncall_incident_channel_ids` 和 `oncall_incident_severities` 至少各需一项;匹配的故障会以 `trigger_kind=oncall_incident` 运行。\n- 每次调用都会记录到账户审计日志。\n",
660+
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **300 次/分钟**;**20 次/秒** |\n| 权限要求 | 有效 `app_key`;管理操作要求调用者可管理目标规则 |\n\n## 使用说明\n\n- 可以创建个人规则,也可以创建当前账户下任意团队的规则;`team_id` 创建后不可修改。\n- `cron_expr` 按 `timezone`(如提供)计算;未提供时依次回退到调用者的成员时区、账户时区,最后是服务端默认时区(Asia/Shanghai)\n- `http_post_trigger_enabled=true` 会创建并启用 HTTP POST 触发器;响应中的 `http_post_token` 是仅在创建时返回的一次性值,请立即保存。\n- `oncall_incident_trigger_enabled=true` 时,`oncall_incident_channel_ids` 和 `oncall_incident_severities` 至少各需一项;匹配的故障会以 `trigger_kind=oncall_incident` 运行。\n- 每次调用都会记录到账户审计日志。\n",
661661
"href": "/zh/api-reference/ai-sre/automations/automation-rule-write-create",
662662
"metadata": {
663663
"sidebarTitle": "创建自动化规则"
@@ -3807,7 +3807,7 @@
38073807
},
38083808
"timezone": {
38093809
"type": "string",
3810-
"description": "`cron_expr` 计算所用的 IANA 时区,例如 `Asia/Shanghai`。必须是服务端可加载的合法时区名,非法值会被拒绝。省略时依次回退到调用者的成员时区、账户时区,最后是 UTC"
3810+
"description": "`cron_expr` 计算所用的 IANA 时区,例如 `Asia/Shanghai`。必须是服务端可加载的合法时区名,非法值会被拒绝。省略时依次回退到调用者的成员时区、账户时区,最后是服务端默认时区(Asia/Shanghai)"
38113811
},
38123812
"schedule_trigger_enabled": {
38133813
"type": [

0 commit comments

Comments
 (0)