Skip to content

docs(api): daily audit 2026-10-14 — schedule cycles, release_limited, work-item status enums #1052

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 14, 2026
Merged

docs(api): daily audit 2026-10-14 — schedule cycles, release_limited, work-item status enums #1052

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
53 changes: 45 additions & 8 deletions api-reference/on-call.openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16889,7 +16889,8 @@
"created_at": 0,
"updated_at": 0
}
]
],
"release_limited": false
}
}
}
Expand Down Expand Up @@ -18319,7 +18320,8 @@
"description": "People with active fixed or temporary On-call licenses.",
"required": [
"total",
"items"
"items",
"release_limited"
],
"properties": {
"total": {
Expand All @@ -18333,6 +18335,10 @@
"items": {
"$ref": "#/components/schemas/LicensePersonItem"
}
},
"release_limited": {
"type": "boolean",
"description": "Whether the account has used up its license release quota for the current 30-day window. While `true`, releasing a seat fails with error code `NoLicense`."
}
}
},
Expand Down Expand Up @@ -27727,14 +27733,24 @@
"properties": {
"cycle": {
"type": "string",
"description": "Notification cycle; only `day` is supported.",
"description": "Notification cycle: `day` sends every day; `week` sends on the weekdays listed in `days`; `month` sends on the day-of-month values listed in `days`.",
"enum": [
"day"
"day",
"week",
"month"
]
},
"start": {
"type": "string",
"description": "Time of day to send, format `HH:MM` (24-hour)."
},
"days": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Days the notification fires on, read in the schedule's timezone. For `week`, weekday numbers 0-6 (0 = Sunday); for `month`, day-of-month numbers 1-31, and a month without that date is skipped. Required when `cycle` is `week` or `month`; ignored when `cycle` is `day`."
}
}
},
Expand Down Expand Up @@ -33607,8 +33623,14 @@
},
"status": {
"type": "string",
"enum": [
"open",
"in_progress",
"done",
"cancelled"
],
"maxLength": 64,
"description": "Optional client-defined initial status (max 64 characters)."
"description": "Initial status. One of `open`, `in_progress`, `done`, `cancelled`; defaults to `open` when omitted or blank."
},
"priority": {
"type": "string",
Expand Down Expand Up @@ -33687,7 +33709,13 @@
"string",
"null"
],
"description": "New client-defined status (max 64 characters).",
"enum": [
"open",
"in_progress",
"done",
"cancelled"
],
"description": "New status. One of `open`, `in_progress`, `done`, `cancelled`.",
"maxLength": 64
},
"priority": {
Expand Down Expand Up @@ -33742,8 +33770,11 @@
},
"target_status": {
"type": "string",
"enum": [
"done"
],
"maxLength": 64,
"description": "Client-defined status to set (max 64 characters). There is no fixed state machine."
"description": "Target status. Must be `done`; any other value is rejected."
},
"idempotency_key": {
"type": "string",
Expand Down Expand Up @@ -33777,7 +33808,13 @@
"string",
"null"
],
"description": "Optional client-defined status to set on the converted follow-up (max 64 characters).",
"enum": [
"open",
"in_progress",
"done",
"cancelled"
],
"description": "Optional status to set on the converted follow-up. One of `open`, `in_progress`, `done`, `cancelled`.",
"maxLength": 64
},
"idempotency_key": {
Expand Down
53 changes: 45 additions & 8 deletions api-reference/on-call.openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16889,7 +16889,8 @@
"created_at": 0,
"updated_at": 0
}
]
],
"release_limited": false
}
}
}
Expand Down Expand Up @@ -18319,7 +18320,8 @@
"description": "当前账户中持有固定或临时 On-call 许可的人员。",
"required": [
"total",
"items"
"items",
"release_limited"
],
"properties": {
"total": {
Expand All @@ -18333,6 +18335,10 @@
"items": {
"$ref": "#/components/schemas/LicensePersonItem"
}
},
"release_limited": {
"type": "boolean",
"description": "当前 30 天窗口内的许可释放配额是否已用尽。为 `true` 时释放席位会返回错误码 `NoLicense`。"
}
}
},
Expand Down Expand Up @@ -27727,14 +27733,24 @@
"properties": {
"cycle": {
"type": "string",
"description": "通知周期，仅支持 `day`（按天）。",
"description": "通知周期：`day` 每天发送；`week` 在 `days` 列出的星期发送；`month` 在 `days` 列出的每月日期发送。",
"enum": [
"day"
"day",
"week",
"month"
]
},
"start": {
"type": "string",
"description": "发送时间，格式 `HH:MM`（24 小时制）。"
},
"days": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "通知发送日，按值班表时区的墙钟计算。`week` 为星期几（0-6，0 表示周日）；`month` 为每月第几日（1-31，当月没有该日则跳过）。`cycle` 为 `week` 或 `month` 时必填，为 `day` 时忽略。"
}
}
},
Expand Down Expand Up @@ -33607,8 +33623,14 @@
},
"status": {
"type": "string",
"enum": [
"open",
"in_progress",
"done",
"cancelled"
],
"maxLength": 64,
"description": "可选的客户端自定义初始状态（最长 64 字符）。"
"description": "可选，客户端自定义的初始状态，取 `open`、`in_progress`、`done`、`cancelled` 之一；省略或为空时默认为 `open`。"
},
"priority": {
"type": "string",
Expand Down Expand Up @@ -33687,7 +33709,13 @@
"string",
"null"
],
"description": "新的客户端自定义状态（最长 64 字符）。",
"enum": [
"open",
"in_progress",
"done",
"cancelled"
],
"description": "新的客户端自定义状态，取 `open`、`in_progress`、`done`、`cancelled` 之一。",
"maxLength": 64
},
"priority": {
Expand Down Expand Up @@ -33742,8 +33770,11 @@
},
"target_status": {
"type": "string",
"enum": [
"done"
],
"maxLength": 64,
"description": "要设置的客户端自定义状态（最长 64 字符），没有固定状态机。"
"description": "要设置的目标状态，必须为 `done`，其他取值一律拒绝。"
},
"idempotency_key": {
"type": "string",
Expand Down Expand Up @@ -33777,7 +33808,13 @@
"string",
"null"
],
"description": "可选，设置在转化后后续行动上的客户端自定义状态（最长 64 字符）。",
"enum": [
"open",
"in_progress",
"done",
"cancelled"
],
"description": "可选，设置在转化后后续行动上的状态，取 `open`、`in_progress`、`done`、`cancelled` 之一。",
"maxLength": 64
},
"idempotency_key": {
Expand Down
51 changes: 44 additions & 7 deletions api-reference/openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4991,7 +4991,10 @@
"type": "string"
},
"target_status": {
"description": "Client-defined status to set (max 64 characters). There is no fixed state machine.",
"description": "Target status. Must be `done`; any other value is rejected.",
"enum": [
"done"
],
"maxLength": 64,
"type": "string"
},
Expand Down Expand Up @@ -5057,7 +5060,13 @@
"type": "string"
},
"target_status": {
"description": "Optional client-defined status to set on the converted follow-up (max 64 characters).",
"description": "Optional status to set on the converted follow-up. One of `open`, `in_progress`, `done`, `cancelled`.",
"enum": [
"open",
"in_progress",
"done",
"cancelled"
],
"maxLength": 64,
"type": [
"string",
Expand Down Expand Up @@ -6649,7 +6658,13 @@
"type": "string"
},
"status": {
"description": "Optional client-defined initial status (max 64 characters).",
"description": "Initial status. One of `open`, `in_progress`, `done`, `cancelled`; defaults to `open` when omitted or blank.",
"enum": [
"open",
"in_progress",
"done",
"cancelled"
],
"maxLength": 64,
"type": "string"
},
Expand Down Expand Up @@ -13348,6 +13363,10 @@
},
"type": "array"
},
"release_limited": {
"description": "Whether the account has used up its license release quota for the current 30-day window. While `true`, releasing a seat fails with error code `NoLicense`.",
"type": "boolean"
},
"total": {
"description": "Number of people holding an active license.",
"format": "int64",
Expand All @@ -13356,7 +13375,8 @@
},
"required": [
"total",
"items"
"items",
"release_limited"
],
"type": "object"
},
Expand Down Expand Up @@ -22640,12 +22660,22 @@
"description": "Fixed-time notification config.",
"properties": {
"cycle": {
"description": "Notification cycle; only `day` is supported.",
"description": "Notification cycle: `day` sends every day; `week` sends on the weekdays listed in `days`; `month` sends on the day-of-month values listed in `days`.",
"enum": [
"day"
"day",
"week",
"month"
],
"type": "string"
},
"days": {
"description": "Days the notification fires on, read in the schedule's timezone. For `week`, weekday numbers 0-6 (0 = Sunday); for `month`, day-of-month numbers 1-31, and a month without that date is skipped. Required when `cycle` is `week` or `month`; ignored when `cycle` is `day`.",
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"start": {
"description": "Time of day to send, format `HH:MM` (24-hour).",
"type": "string"
Expand Down Expand Up @@ -27760,7 +27790,13 @@
]
},
"status": {
"description": "New client-defined status (max 64 characters).",
"description": "New status. One of `open`, `in_progress`, `done`, `cancelled`.",
"enum": [
"open",
"in_progress",
"done",
"cancelled"
],
"maxLength": 64,
"type": [
"string",
Expand Down Expand Up @@ -48975,6 +49011,7 @@
"updated_by": 0
}
],
"release_limited": false,
"total": 2
},
"request_id": "01J0D5Y31GY2TWAHRP3Q8K4M6N"
Expand Down
Loading
Loading