Skip to content

Commit cb92047

Browse files
ysyneuysyneu
authored
Merge pull request #263 from flashcatcloud/fix/zero-value-request-fields
fix(api): make zero-value request fields nullable, fix wrong property name
2 parents fa2e6bf + 261ffb3 commit cb92047

6 files changed

Lines changed: 132 additions & 60 deletions

File tree

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

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26947,9 +26947,12 @@
2694726947
],
2694826948
"properties": {
2694926949
"advance_in_time": {
26950-
"type": "integer",
26950+
"type": [
26951+
"integer",
26952+
"null"
26953+
],
2695126954
"format": "int64",
26952-
"description": "Advance notification lead time (seconds)."
26955+
"description": "Advance notification lead time in seconds. `0` notifies exactly at shift start; omitting disables advance notification."
2695326956
},
2695426957
"fixed_time": {
2695526958
"$ref": "#/components/schemas/ScheduleFixedTimeNotifyInfo"
@@ -27781,7 +27784,7 @@
2778127784
"type": "string",
2778227785
"description": "Feishu app message template source."
2778327786
},
27784-
"feishu_app_card_table_enabled": {
27787+
"feishu_app_card_v2_table_enabled": {
2778527788
"type": "boolean",
2778627789
"default": false,
2778727790
"description": "Render alert labels as a table in Feishu app cards."
@@ -27870,7 +27873,7 @@
2787027873
"wecom",
2787127874
"feishu",
2787227875
"feishu_app",
27873-
"feishu_app_card_table_enabled",
27876+
"feishu_app_card_v2_table_enabled",
2787427877
"dingtalk_app",
2787527878
"wecom_app",
2787627879
"slack_app",
@@ -27937,7 +27940,7 @@
2793727940
"type": "string",
2793827941
"description": "Feishu app message template source."
2793927942
},
27940-
"feishu_app_card_table_enabled": {
27943+
"feishu_app_card_v2_table_enabled": {
2794127944
"type": "boolean",
2794227945
"description": "Whether alert labels use table rendering in Feishu app cards."
2794327946
},
@@ -28154,7 +28157,7 @@
2815428157
"type": "string",
2815528158
"description": "Feishu app message template source."
2815628159
},
28157-
"feishu_app_card_table_enabled": {
28160+
"feishu_app_card_v2_table_enabled": {
2815828161
"type": [
2815928162
"boolean",
2816028163
"null"

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

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26938,9 +26938,12 @@
2693826938
],
2693926939
"properties": {
2694026940
"advance_in_time": {
26941-
"type": "integer",
26941+
"type": [
26942+
"integer",
26943+
"null"
26944+
],
2694226945
"format": "int64",
26943-
"description": "提前通知时间（秒）。"
26946+
"description": "提前通知时间（秒）；为 `0` 时在排班开始时通知；不传则不发送提前通知。"
2694426947
},
2694526948
"fixed_time": {
2694626949
"$ref": "#/components/schemas/ScheduleFixedTimeNotifyInfo"
@@ -27772,7 +27775,7 @@
2777227775
"type": "string",
2777327776
"description": "飞书应用消息模板源。"
2777427777
},
27775-
"feishu_app_card_table_enabled": {
27778+
"feishu_app_card_v2_table_enabled": {
2777627779
"type": "boolean",
2777727780
"default": false,
2777827781
"description": "是否在飞书应用卡片中以表格渲染告警标签，默认关闭。"
@@ -27861,7 +27864,7 @@
2786127864
"wecom",
2786227865
"feishu",
2786327866
"feishu_app",
27864-
"feishu_app_card_table_enabled",
27867+
"feishu_app_card_v2_table_enabled",
2786527868
"dingtalk_app",
2786627869
"wecom_app",
2786727870
"slack_app",
@@ -27928,7 +27931,7 @@
2792827931
"type": "string",
2792927932
"description": "飞书应用消息模板源。"
2793027933
},
27931-
"feishu_app_card_table_enabled": {
27934+
"feishu_app_card_v2_table_enabled": {
2793227935
"type": "boolean",
2793327936
"description": "是否在飞书应用卡片中以表格渲染告警标签。"
2793427937
},
@@ -28145,7 +28148,7 @@
2814528148
"type": "string",
2814628149
"description": "飞书应用消息模板源。"
2814728150
},
28148-
"feishu_app_card_table_enabled": {
28151+
"feishu_app_card_v2_table_enabled": {
2814928152
"type": [
2815028153
"boolean",
2815128154
"null"

‎api-reference/openapi.en.json‎

Lines changed: 33 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -38521,9 +38521,12 @@
3852138521
],
3852238522
"properties": {
3852338523
"advance_in_time": {
38524-
"type": "integer",
38524+
"type": [
38525+
"integer",
38526+
"null"
38527+
],
3852538528
"format": "int64",
38526-
"description": "Advance notification lead time (seconds)."
38529+
"description": "Advance notification lead time in seconds. `0` notifies exactly at shift start; omitting disables advance notification."
3852738530
},
3852838531
"fixed_time": {
3852938532
"$ref": "#/components/schemas/ScheduleFixedTimeNotifyInfo"
@@ -39469,7 +39472,7 @@
3946939472
"wecom",
3947039473
"feishu",
3947139474
"feishu_app",
39472-
"feishu_app_card_table_enabled",
39475+
"feishu_app_card_v2_table_enabled",
3947339476
"dingtalk_app",
3947439477
"wecom_app",
3947539478
"slack_app",
@@ -39536,7 +39539,7 @@
3953639539
"type": "string",
3953739540
"description": "Feishu app message template source."
3953839541
},
39539-
"feishu_app_card_table_enabled": {
39542+
"feishu_app_card_v2_table_enabled": {
3954039543
"type": "boolean",
3954139544
"description": "Whether alert labels use table rendering in Feishu app cards."
3954239545
},
@@ -39761,7 +39764,7 @@
3976139764
"type": "string",
3976239765
"description": "Feishu app message template source."
3976339766
},
39764-
"feishu_app_card_table_enabled": {
39767+
"feishu_app_card_v2_table_enabled": {
3976539768
"type": "boolean",
3976639769
"default": false,
3976739770
"description": "Render alert labels as a table in Feishu app cards."
@@ -39879,7 +39882,7 @@
3987939882
"type": "string",
3988039883
"description": "Feishu app message template source."
3988139884
},
39882-
"feishu_app_card_table_enabled": {
39885+
"feishu_app_card_v2_table_enabled": {
3988339886
"type": [
3988439887
"boolean",
3988539888
"null"
@@ -44527,7 +44530,10 @@
4452744530
"description": "Alert settings for the application.",
4452844531
"properties": {
4452944532
"enabled": {
44530-
"type": "boolean",
44533+
"type": [
44534+
"boolean",
44535+
"null"
44536+
],
4453144537
"description": "Whether alerting is enabled."
4453244538
},
4453344539
"channel_ids": {
@@ -44908,16 +44914,25 @@
4490844914
"description": "Owning team ID. Get team IDs via `POST /team/list`. Omit to leave unchanged."
4490944915
},
4491044916
"is_private": {
44911-
"type": "boolean",
44912-
"description": "Restrict access to members of the owning team. Omit to leave unchanged."
44917+
"type": [
44918+
"boolean",
44919+
"null"
44920+
],
44921+
"description": "Restrict access to members of the owning team; `false` explicitly makes the application public. Omit to leave unchanged."
4491344922
},
4491444923
"no_ip": {
44915-
"type": "boolean",
44916-
"description": "When `true`, stop collecting user IP addresses. Omit to leave unchanged."
44924+
"type": [
44925+
"boolean",
44926+
"null"
44927+
],
44928+
"description": "When `true`, stop collecting user IP addresses; when `false`, resume collecting them. Omit to leave unchanged."
4491744929
},
4491844930
"no_geo": {
44919-
"type": "boolean",
44920-
"description": "When `true`, stop inferring geographic location from IP. Omit to leave unchanged."
44931+
"type": [
44932+
"boolean",
44933+
"null"
44934+
],
44935+
"description": "When `true`, stop inferring geographic location from IP; when `false`, resume inferring it. Omit to leave unchanged."
4492144936
},
4492244937
"alerting": {
4492344938
"$ref": "#/components/schemas/RumApplicationAlerting",
@@ -49792,8 +49807,11 @@
4979249807
"description": "Filter by RUM data scopes. Valid values: `session`, `view`, `action`, `error`, `resource`, `long_task`, `vital`, `issue`, `sourcemap`."
4979349808
},
4979449809
"is_facet": {
49795-
"type": "boolean",
49796-
"description": "When true, return only facet-enabled fields. When false or omitted, return all fields."
49810+
"type": [
49811+
"boolean",
49812+
"null"
49813+
],
49814+
"description": "When omitted or `null`, return all fields. When `true`, return only facet-enabled fields. When `false`, return only fields that are not facet-enabled."
4979749815
}
4979849816
}
4979949817
},

‎api-reference/openapi.zh.json‎

Lines changed: 33 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -38512,9 +38512,12 @@
3851238512
],
3851338513
"properties": {
3851438514
"advance_in_time": {
38515-
"type": "integer",
38515+
"type": [
38516+
"integer",
38517+
"null"
38518+
],
3851638519
"format": "int64",
38517-
"description": "提前通知时间（秒）。"
38520+
"description": "提前通知时间（秒）；为 `0` 时在排班开始时通知；不传则不发送提前通知。"
3851838521
},
3851938522
"fixed_time": {
3852038523
"$ref": "#/components/schemas/ScheduleFixedTimeNotifyInfo"
@@ -39460,7 +39463,7 @@
3946039463
"wecom",
3946139464
"feishu",
3946239465
"feishu_app",
39463-
"feishu_app_card_table_enabled",
39466+
"feishu_app_card_v2_table_enabled",
3946439467
"dingtalk_app",
3946539468
"wecom_app",
3946639469
"slack_app",
@@ -39527,7 +39530,7 @@
3952739530
"type": "string",
3952839531
"description": "飞书应用消息模板源。"
3952939532
},
39530-
"feishu_app_card_table_enabled": {
39533+
"feishu_app_card_v2_table_enabled": {
3953139534
"type": "boolean",
3953239535
"description": "是否在飞书应用卡片中以表格渲染告警标签。"
3953339536
},
@@ -39752,7 +39755,7 @@
3975239755
"type": "string",
3975339756
"description": "飞书应用消息模板源。"
3975439757
},
39755-
"feishu_app_card_table_enabled": {
39758+
"feishu_app_card_v2_table_enabled": {
3975639759
"type": "boolean",
3975739760
"default": false,
3975839761
"description": "是否在飞书应用卡片中以表格渲染告警标签，默认关闭。"
@@ -39870,7 +39873,7 @@
3987039873
"type": "string",
3987139874
"description": "飞书应用消息模板源。"
3987239875
},
39873-
"feishu_app_card_table_enabled": {
39876+
"feishu_app_card_v2_table_enabled": {
3987439877
"type": [
3987539878
"boolean",
3987639879
"null"
@@ -44518,7 +44521,10 @@
4451844521
"description": "应用的告警配置。",
4451944522
"properties": {
4452044523
"enabled": {
44521-
"type": "boolean",
44524+
"type": [
44525+
"boolean",
44526+
"null"
44527+
],
4452244528
"description": "是否启用告警。"
4452344529
},
4452444530
"channel_ids": {
@@ -44899,16 +44905,25 @@
4489944905
"description": "应用所属团队 ID，可通过 `POST /team/list` 获取；不传则保持不变。"
4490044906
},
4490144907
"is_private": {
44902-
"type": "boolean",
44903-
"description": "是否仅限所属团队成员访问；不传则保持不变。"
44908+
"type": [
44909+
"boolean",
44910+
"null"
44911+
],
44912+
"description": "是否仅限所属团队成员访问；`false` 显式改为公开访问；不传则保持不变。"
4490444913
},
4490544914
"no_ip": {
44906-
"type": "boolean",
44907-
"description": "为 `true` 时停止采集用户 IP 地址；不传则保持不变。"
44915+
"type": [
44916+
"boolean",
44917+
"null"
44918+
],
44919+
"description": "为 `true` 时停止采集用户 IP 地址，为 `false` 时恢复采集；不传则保持不变。"
4490844920
},
4490944921
"no_geo": {
44910-
"type": "boolean",
44911-
"description": "为 `true` 时不再基于 IP 推断地理位置；不传则保持不变。"
44922+
"type": [
44923+
"boolean",
44924+
"null"
44925+
],
44926+
"description": "为 `true` 时不再基于 IP 推断地理位置，为 `false` 时恢复推断；不传则保持不变。"
4491244927
},
4491344928
"alerting": {
4491444929
"$ref": "#/components/schemas/RumApplicationAlerting",
@@ -49783,8 +49798,11 @@
4978349798
"description": "按 RUM 数据 scope 过滤。合法值：`session`、`view`、`action`、`error`、`resource`、`long_task`、`vital`、`issue`、`sourcemap`。"
4978449799
},
4978549800
"is_facet": {
49786-
"type": "boolean",
49787-
"description": "为 true 时只返回支持分面查询的字段；为 false 或不传时返回所有字段。"
49801+
"type": [
49802+
"boolean",
49803+
"null"
49804+
],
49805+
"description": "不传或为 `null` 时返回所有字段；为 `true` 时只返回支持分面查询的字段；为 `false` 时只返回不支持分面查询的字段。"
4978849806
}
4978949807
}
4979049808
},

‎api-reference/rum.openapi.en.json‎

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3715,7 +3715,10 @@
37153715
"description": "Alert settings for the application.",
37163716
"properties": {
37173717
"enabled": {
3718-
"type": "boolean",
3718+
"type": [
3719+
"boolean",
3720+
"null"
3721+
],
37193722
"description": "Whether alerting is enabled."
37203723
},
37213724
"channel_ids": {
@@ -4135,16 +4138,25 @@
41354138
"description": "Owning team ID. Get team IDs via `POST /team/list`. Omit to leave unchanged."
41364139
},
41374140
"is_private": {
4138-
"type": "boolean",
4139-
"description": "Restrict access to members of the owning team. Omit to leave unchanged."
4141+
"type": [
4142+
"boolean",
4143+
"null"
4144+
],
4145+
"description": "Restrict access to members of the owning team; `false` explicitly makes the application public. Omit to leave unchanged."
41404146
},
41414147
"no_ip": {
4142-
"type": "boolean",
4143-
"description": "When `true`, stop collecting user IP addresses. Omit to leave unchanged."
4148+
"type": [
4149+
"boolean",
4150+
"null"
4151+
],
4152+
"description": "When `true`, stop collecting user IP addresses; when `false`, resume collecting them. Omit to leave unchanged."
41444153
},
41454154
"no_geo": {
4146-
"type": "boolean",
4147-
"description": "When `true`, stop inferring geographic location from IP. Omit to leave unchanged."
4155+
"type": [
4156+
"boolean",
4157+
"null"
4158+
],
4159+
"description": "When `true`, stop inferring geographic location from IP; when `false`, resume inferring it. Omit to leave unchanged."
41484160
},
41494161
"alerting": {
41504162
"$ref": "#/components/schemas/RumApplicationAlerting",
@@ -4583,8 +4595,11 @@
45834595
"description": "Filter by RUM data scopes. Valid values: `session`, `view`, `action`, `error`, `resource`, `long_task`, `vital`, `issue`, `sourcemap`."
45844596
},
45854597
"is_facet": {
4586-
"type": "boolean",
4587-
"description": "When true, return only facet-enabled fields. When false or omitted, return all fields."
4598+
"type": [
4599+
"boolean",
4600+
"null"
4601+
],
4602+
"description": "When omitted or `null`, return all fields. When `true`, return only facet-enabled fields. When `false`, return only fields that are not facet-enabled."
45884603
}
45894604
}
45904605
},

0 commit comments

Comments
 (0)