Skip to content

docs(api): re-sync the API reference with the current backends #299

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 4 commits into from
Aug 22, 2026
+42 −58
Merged

docs(api): re-sync the API reference with the current backends #299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
11452f5
docs(api): drop the retired priority field from channel rule schemas
ysyneu Aug 21, 2026
aa6782c
docs(api): document duty_version on the knowledge pack item
ysyneu Aug 21, 2026
4b9f976
docs(on-call): drop rules cannot be reordered
ysyneu Aug 21, 2026
4de7113
docs(api): stop requiring priority on the channel rule items
ysyneu Aug 21, 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
14 changes: 0 additions & 14 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 @@ -10024,7 +10024,6 @@
{
"account_id": 2451002751131,
"channel_id": 5967964835131,
"priority": 0,
"rule_name": "Drop test alerts",
"description": "",
"filters": [
Expand Down Expand Up @@ -10688,7 +10687,6 @@
{
"account_id": 2451002751131,
"channel_id": 5967964835131,
"priority": 0,
"rule_name": "Suppress downstream alerts",
"description": "",
"source_filters": [
Expand Down Expand Up @@ -12975,7 +12973,6 @@
{
"account_id": 2451002751131,
"channel_id": 5967964835131,
"priority": 0,
"rule_name": "Silence Info alerts",
"description": "",
"from_incident_id": "000000000000000000000000",
Expand Down Expand Up @@ -19920,10 +19917,6 @@
"format": "int64",
"description": "Owning channel ID; obtain it from `POST /channel/list`."
},
"priority": {
"type": "integer",
"description": "Evaluation priority. Lower runs first."
},
"rule_name": {
"type": "string",
"minLength": 1,
Expand Down Expand Up @@ -23613,7 +23606,6 @@
"required": [
"account_id",
"channel_id",
"priority",
"rule_name",
"description",
"source_filters",
Expand Down Expand Up @@ -27292,7 +27284,6 @@
"required": [
"account_id",
"channel_id",
"priority",
"rule_name",
"description",
"time_filters",
Expand Down Expand Up @@ -28393,7 +28384,6 @@
"required": [
"account_id",
"channel_id",
"priority",
"rule_name",
"description",
"filters",
Expand Down Expand Up @@ -28586,10 +28576,6 @@
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Drop rule ID (MongoDB ObjectID)."
},
"priority": {
"type": "integer",
"description": "Evaluation priority. Lower runs first."
},
"rule_name": {
"type": "string",
"minLength": 1,
Expand Down
14 changes: 0 additions & 14 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 @@ -10016,7 +10016,6 @@
{
"account_id": 2451002751131,
"channel_id": 5967964835131,
"priority": 0,
"rule_name": "Drop test alerts",
"description": "",
"filters": [
Expand Down Expand Up @@ -10680,7 +10679,6 @@
{
"account_id": 2451002751131,
"channel_id": 5967964835131,
"priority": 0,
"rule_name": "Suppress downstream alerts",
"description": "",
"source_filters": [
Expand Down Expand Up @@ -12967,7 +12965,6 @@
{
"account_id": 2451002751131,
"channel_id": 5967964835131,
"priority": 0,
"rule_name": "Silence Info alerts",
"description": "",
"from_incident_id": "000000000000000000000000",
Expand Down Expand Up @@ -19912,10 +19909,6 @@
"format": "int64",
"description": "所属协作空间 ID，可通过 `POST /channel/list` 获取。"
},
"priority": {
"type": "integer",
"description": "匹配优先级,数值越小越优先。"
},
"rule_name": {
"type": "string",
"minLength": 1,
Expand Down Expand Up @@ -23604,7 +23597,6 @@
"required": [
"account_id",
"channel_id",
"priority",
"rule_name",
"description",
"source_filters",
Expand Down Expand Up @@ -27283,7 +27275,6 @@
"required": [
"account_id",
"channel_id",
"priority",
"rule_name",
"description",
"time_filters",
Expand Down Expand Up @@ -28384,7 +28375,6 @@
"required": [
"account_id",
"channel_id",
"priority",
"rule_name",
"description",
"filters",
Expand Down Expand Up @@ -28577,10 +28567,6 @@
"pattern": "^[0-9a-fA-F]{24}$",
"description": "排除规则 ID（MongoDB ObjectID）。"
},
"priority": {
"type": "integer",
"description": "匹配优先级，数值越小越优先。"
},
"rule_name": {
"type": "string",
"minLength": 1,
Expand Down
24 changes: 10 additions & 14 deletions api-reference/openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3465,7 +3465,6 @@
{
"account_id": 2451002751131,
"channel_id": 5967964835131,
"priority": 0,
"rule_name": "Silence Info alerts",
"description": "",
"from_incident_id": "000000000000000000000000",
Expand Down Expand Up @@ -3960,7 +3959,6 @@
{
"account_id": 2451002751131,
"channel_id": 5967964835131,
"priority": 0,
"rule_name": "Suppress downstream alerts",
"description": "",
"source_filters": [
Expand Down Expand Up @@ -4462,7 +4460,6 @@
{
"account_id": 2451002751131,
"channel_id": 5967964835131,
"priority": 0,
"rule_name": "Drop test alerts",
"description": "",
"filters": [
Expand Down Expand Up @@ -30094,6 +30091,7 @@
"file_count": 17,
"total_bytes": 41010,
"version": 134,
"duty_version": 130,
"created_by": 2476444212131,
"created_at_ms": 1778768680053,
"updated_at_ms": 1786456567177,
Expand Down Expand Up @@ -30204,6 +30202,7 @@
"file_count": 17,
"total_bytes": 41010,
"version": 134,
"duty_version": 130,
"created_by": 2476444212131,
"created_at_ms": 1778768680053,
"updated_at_ms": 1786456567177,
Expand All @@ -30218,6 +30217,7 @@
"file_count": 4,
"total_bytes": 11159,
"version": 15,
"duty_version": 15,
"created_by": 2476444212131,
"created_at_ms": 1782201586089,
"updated_at_ms": 1785462092702,
Expand Down Expand Up @@ -30311,6 +30311,7 @@
"file_count": 17,
"total_bytes": 41010,
"version": 138,
"duty_version": 130,
"created_by": 2476444212131,
"created_at_ms": 1778768680053,
"updated_at_ms": 1786458765182,
Expand Down Expand Up @@ -30403,6 +30404,7 @@
"file_count": 4,
"total_bytes": 11159,
"version": 15,
"duty_version": 15,
"created_by": 2476444212131,
"created_at_ms": 1782201586089,
"updated_at_ms": 1785462092702,
Expand Down Expand Up @@ -35209,10 +35211,6 @@
"format": "int64",
"description": "Owning channel ID; obtain it from `POST /channel/list`."
},
"priority": {
"type": "integer",
"description": "Evaluation priority. Lower runs first."
},
"rule_name": {
"type": "string",
"minLength": 1,
Expand Down Expand Up @@ -35841,7 +35839,6 @@
"required": [
"account_id",
"channel_id",
"priority",
"rule_name",
"description",
"time_filters",
Expand Down Expand Up @@ -35939,7 +35936,6 @@
"required": [
"account_id",
"channel_id",
"priority",
"rule_name",
"description",
"source_filters",
Expand Down Expand Up @@ -36024,7 +36020,6 @@
"required": [
"account_id",
"channel_id",
"priority",
"rule_name",
"description",
"filters",
Expand Down Expand Up @@ -36471,10 +36466,6 @@
"pattern": "^[0-9a-fA-F]{24}$",
"description": "Drop rule ID (MongoDB ObjectID)."
},
"priority": {
"type": "integer",
"description": "Evaluation priority. Lower runs first."
},
"rule_name": {
"type": "string",
"minLength": 1,
Expand Down Expand Up @@ -58615,6 +58606,10 @@
"type": "integer",
"description": "Pack version, incremented on every file change."
},
"duty_version": {
"type": "integer",
"description": "Pack version at which DUTY.md was last authored or re-affirmed. When `version` is greater, DUTY.md no longer reflects every file in the pack."
},
"created_by": {
"type": "integer",
"description": "Person ID of the member who created the pack.",
Expand Down Expand Up @@ -58643,6 +58638,7 @@
"file_count",
"total_bytes",
"version",
"duty_version",
"created_by",
"created_at_ms",
"updated_at_ms",
Expand Down
24 changes: 10 additions & 14 deletions api-reference/openapi.zh.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3465,7 +3465,6 @@
{
"account_id": 2451002751131,
"channel_id": 5967964835131,
"priority": 0,
"rule_name": "Silence Info alerts",
"description": "",
"from_incident_id": "000000000000000000000000",
Expand Down Expand Up @@ -3960,7 +3959,6 @@
{
"account_id": 2451002751131,
"channel_id": 5967964835131,
"priority": 0,
"rule_name": "Suppress downstream alerts",
"description": "",
"source_filters": [
Expand Down Expand Up @@ -4462,7 +4460,6 @@
{
"account_id": 2451002751131,
"channel_id": 5967964835131,
"priority": 0,
"rule_name": "Drop test alerts",
"description": "",
"filters": [
Expand Down Expand Up @@ -30086,6 +30083,7 @@
"file_count": 17,
"total_bytes": 41010,
"version": 134,
"duty_version": 130,
"created_by": 2476444212131,
"created_at_ms": 1778768680053,
"updated_at_ms": 1786456567177,
Expand Down Expand Up @@ -30196,6 +30194,7 @@
"file_count": 17,
"total_bytes": 41010,
"version": 134,
"duty_version": 130,
"created_by": 2476444212131,
"created_at_ms": 1778768680053,
"updated_at_ms": 1786456567177,
Expand All @@ -30210,6 +30209,7 @@
"file_count": 4,
"total_bytes": 11159,
"version": 15,
"duty_version": 15,
"created_by": 2476444212131,
"created_at_ms": 1782201586089,
"updated_at_ms": 1785462092702,
Expand Down Expand Up @@ -30303,6 +30303,7 @@
"file_count": 17,
"total_bytes": 41010,
"version": 138,
"duty_version": 130,
"created_by": 2476444212131,
"created_at_ms": 1778768680053,
"updated_at_ms": 1786458765182,
Expand Down Expand Up @@ -30395,6 +30396,7 @@
"file_count": 4,
"total_bytes": 11159,
"version": 15,
"duty_version": 15,
"created_by": 2476444212131,
"created_at_ms": 1782201586089,
"updated_at_ms": 1785462092702,
Expand Down Expand Up @@ -35200,10 +35202,6 @@
"format": "int64",
"description": "所属协作空间 ID，可通过 `POST /channel/list` 获取。"
},
"priority": {
"type": "integer",
"description": "匹配优先级,数值越小越优先。"
},
"rule_name": {
"type": "string",
"minLength": 1,
Expand Down Expand Up @@ -35832,7 +35830,6 @@
"required": [
"account_id",
"channel_id",
"priority",
"rule_name",
"description",
"time_filters",
Expand Down Expand Up @@ -35930,7 +35927,6 @@
"required": [
"account_id",
"channel_id",
"priority",
"rule_name",
"description",
"source_filters",
Expand Down Expand Up @@ -36015,7 +36011,6 @@
"required": [
"account_id",
"channel_id",
"priority",
"rule_name",
"description",
"filters",
Expand Down Expand Up @@ -36462,10 +36457,6 @@
"pattern": "^[0-9a-fA-F]{24}$",
"description": "排除规则 ID（MongoDB ObjectID）。"
},
"priority": {
"type": "integer",
"description": "匹配优先级，数值越小越优先。"
},
"rule_name": {
"type": "string",
"minLength": 1,
Expand Down Expand Up @@ -58606,6 +58597,10 @@
"type": "integer",
"description": "知识包版本号，文件每次变更时递增。"
},
"duty_version": {
"type": "integer",
"description": "最后一次撰写或确认 DUTY.md 时的知识库版本。当 `version` 大于该值时，说明 DUTY.md 已不能反映知识库的全部文件。"
},
"created_by": {
"type": "integer",
"description": "创建者成员 ID。",
Expand Down Expand Up @@ -58634,6 +58629,7 @@
"file_count",
"total_bytes",
"version",
"duty_version",
"created_by",
"created_at_ms",
"updated_at_ms",
Expand Down
Loading
Loading