Skip to content

Commit e30f4d8

Browse files
ysyneugithub-actions[bot]
authored andcommitted
chore: sync OpenAPI spec from flashduty-docs + regenerate
1 parent 89f501b commit e30f4d8

3 files changed

Lines changed: 9 additions & 9 deletions

File tree

data_sources.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

openapi/openapi.en.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14644,12 +14644,12 @@
1464414644
"post": {
1464514645
"operationId": "monit-datasource-read-info",
1464614646
"summary": "Get datasource detail",
14647-
"description": "Retrieve full details of a single data source by its ID, including the `payload` configuration.",
14647+
"description": "Retrieve full details of a single data source by its ID, including the `payload` configuration, with credential fields masked as `******`.",
1464814648
"tags": [
1464914649
"Monitors/Data sources"
1465014650
],
1465114651
"x-mint": {
14652-
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Datasources Read** (`monit`) |",
14652+
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Datasources Read** (`monit`) |\n\n## Credential fields\n\nThe `info` / `create` / `update` responses never return credentials in cleartext. `password`, `basic_auth_password`, `api_key`, `service_token`, `access_key_secret`, `tls_key`, `tls_key_pwd` and their siblings come back as the placeholder `******`; a field that was never configured still comes back as an empty string. `sls.access_key_id` is an identifier rather than a credential and is returned as-is.\n\nOn update, submitting `******` unchanged means **keep the stored value**, and an empty string is treated the same way. To rotate a credential, submit the new value directly.\n\nOn create there is no stored value to keep — submitting a `******` copied from another response stores the literal string `******`, and the data source will fail to connect.",
1465314653
"href": "/en/api-reference/monitors/data-sources/monit-datasource-read-info",
1465414654
"metadata": {
1465514655
"sidebarTitle": "Get datasource detail"
@@ -14737,7 +14737,7 @@
1473714737
"Monitors/Data sources"
1473814738
],
1473914739
"x-mint": {
14740-
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Datasources Manage** (`monit`) |\n\n## Usage\n\n- `type_ident` must be one of: `prometheus`, `loki`, `mysql`, `oracle`, `postgres`, `clickhouse`, `elasticsearch`, `sls`, `victorialogs`.\n- `edge_cluster_name` specifies which Monitors edge cluster evaluates rules using this datasource.\n- For `elasticsearch`, set `payload.elasticsearch.deployment` to `cloud` or `self-managed`.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.",
14740+
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Datasources Manage** (`monit`) |\n\n## Usage\n\n- `type_ident` must be one of: `prometheus`, `loki`, `mysql`, `oracle`, `postgres`, `clickhouse`, `elasticsearch`, `sls`, `victorialogs`.\n- `edge_cluster_name` specifies which Monitors edge cluster evaluates rules using this datasource.\n- For `elasticsearch`, set `payload.elasticsearch.deployment` to `cloud` or `self-managed`.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.\n\n## Credential fields\n\nThe `info` / `create` / `update` responses never return credentials in cleartext. `password`, `basic_auth_password`, `api_key`, `service_token`, `access_key_secret`, `tls_key`, `tls_key_pwd` and their siblings come back as the placeholder `******`; a field that was never configured still comes back as an empty string. `sls.access_key_id` is an identifier rather than a credential and is returned as-is.\n\nOn update, submitting `******` unchanged means **keep the stored value**, and an empty string is treated the same way. To rotate a credential, submit the new value directly.\n\nOn create there is no stored value to keep — submitting a `******` copied from another response stores the literal string `******`, and the data source will fail to connect.",
1474114741
"href": "/en/api-reference/monitors/data-sources/monit-datasource-write-create",
1474214742
"metadata": {
1474314743
"sidebarTitle": "Create datasource"
@@ -14823,7 +14823,7 @@
1482314823
"Monitors/Data sources"
1482414824
],
1482514825
"x-mint": {
14826-
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Datasources Manage** (`monit`) |\n\n## Usage\n\n- Every call is recorded in the account audit log. Don't put secrets in request fields.",
14826+
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Datasources Manage** (`monit`) |\n\n## Usage\n\n- Every call is recorded in the account audit log. Don't put secrets in request fields.\n\n## Credential fields\n\nThe `info` / `create` / `update` responses never return credentials in cleartext. `password`, `basic_auth_password`, `api_key`, `service_token`, `access_key_secret`, `tls_key`, `tls_key_pwd` and their siblings come back as the placeholder `******`; a field that was never configured still comes back as an empty string. `sls.access_key_id` is an identifier rather than a credential and is returned as-is.\n\nOn update, submitting `******` unchanged means **keep the stored value**, and an empty string is treated the same way. To rotate a credential, submit the new value directly.\n\nOn create there is no stored value to keep — submitting a `******` copied from another response stores the literal string `******`, and the data source will fail to connect.",
1482714827
"href": "/en/api-reference/monitors/data-sources/monit-datasource-write-update",
1482814828
"metadata": {
1482914829
"sidebarTitle": "Update datasource"

openapi/openapi.zh.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14636,12 +14636,12 @@
1463614636
"post": {
1463714637
"operationId": "monit-datasource-read-info",
1463814638
"summary": "查看数据源详情",
14639-
"description": "通过 ID 获取单个数据源的完整信息,包括 `payload` 配置。",
14639+
"description": "通过 ID 获取单个数据源的完整信息,包括 `payload` 配置(凭据字段以 `******` 脱敏返回)。",
1464014640
"tags": [
1464114641
"Monitors/告警数据源"
1464214642
],
1464314643
"x-mint": {
14644-
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**;**50 次/秒** |\n| 权限要求 | **数据源查看**(`monit`) |",
14644+
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**;**50 次/秒** |\n| 权限要求 | **数据源查看**(`monit`) |\n\n## 凭据字段\n\n`info` / `create` / `update` 的响应不返回凭据明文。`password`、`basic_auth_password`、`api_key`、`service_token`、`access_key_secret`、`tls_key`、`tls_key_pwd` 等字段一律以 `******` 占位返回;原本就没配置的字段仍返回空字符串。`sls.access_key_id` 是标识而非凭据,照常返回真实值。\n\n更新时把 `******` 原样提交表示**沿用已存值**,留空同样按沿用处理;要轮换凭据就直接提交新值。\n\n创建时没有可沿用的旧值——若把从别处读来的 `******` 当作真实口令提交,存下来的就是字面量 `******`,数据源会连不上。",
1464514645
"href": "/zh/api-reference/monitors/data-sources/monit-datasource-read-info",
1464614646
"metadata": {
1464714647
"sidebarTitle": "查看数据源详情"
@@ -14729,7 +14729,7 @@
1472914729
"Monitors/告警数据源"
1473014730
],
1473114731
"x-mint": {
14732-
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**;**50 次/秒** |\n| 权限要求 | **数据源管理**(`monit`) |\n\n## 使用说明\n\n- `type_ident` 必须为以下之一:`prometheus`、`loki`、`mysql`、`oracle`、`postgres`、`clickhouse`、`elasticsearch`、`sls`、`victorialogs`。\n- `edge_cluster_name` 指定使用该数据源进行规则评估的 Monitors Edge 集群。\n- 对于 `elasticsearch`,`payload.elasticsearch.deployment` 须设为 `cloud` 或 `self-managed`。\n- 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。",
14732+
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**;**50 次/秒** |\n| 权限要求 | **数据源管理**(`monit`) |\n\n## 使用说明\n\n- `type_ident` 必须为以下之一:`prometheus`、`loki`、`mysql`、`oracle`、`postgres`、`clickhouse`、`elasticsearch`、`sls`、`victorialogs`。\n- `edge_cluster_name` 指定使用该数据源进行规则评估的 Monitors Edge 集群。\n- 对于 `elasticsearch`,`payload.elasticsearch.deployment` 须设为 `cloud` 或 `self-managed`。\n- 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。\n\n## 凭据字段\n\n`info` / `create` / `update` 的响应不返回凭据明文。`password`、`basic_auth_password`、`api_key`、`service_token`、`access_key_secret`、`tls_key`、`tls_key_pwd` 等字段一律以 `******` 占位返回;原本就没配置的字段仍返回空字符串。`sls.access_key_id` 是标识而非凭据,照常返回真实值。\n\n更新时把 `******` 原样提交表示**沿用已存值**,留空同样按沿用处理;要轮换凭据就直接提交新值。\n\n创建时没有可沿用的旧值——若把从别处读来的 `******` 当作真实口令提交,存下来的就是字面量 `******`,数据源会连不上。",
1473314733
"href": "/zh/api-reference/monitors/data-sources/monit-datasource-write-create",
1473414734
"metadata": {
1473514735
"sidebarTitle": "创建数据源"
@@ -14815,7 +14815,7 @@
1481514815
"Monitors/告警数据源"
1481614816
],
1481714817
"x-mint": {
14818-
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**;**50 次/秒** |\n| 权限要求 | **数据源管理**(`monit`) |\n\n## 使用说明\n\n- 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。",
14818+
"content": "## 限制说明\n\n| 项目 | 说明 |\n| ---- | ---- |\n| 速率限制 | 每个账户 **1,000 次/分钟**;**50 次/秒** |\n| 权限要求 | **数据源管理**(`monit`) |\n\n## 使用说明\n\n- 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。\n\n## 凭据字段\n\n`info` / `create` / `update` 的响应不返回凭据明文。`password`、`basic_auth_password`、`api_key`、`service_token`、`access_key_secret`、`tls_key`、`tls_key_pwd` 等字段一律以 `******` 占位返回;原本就没配置的字段仍返回空字符串。`sls.access_key_id` 是标识而非凭据,照常返回真实值。\n\n更新时把 `******` 原样提交表示**沿用已存值**,留空同样按沿用处理;要轮换凭据就直接提交新值。\n\n创建时没有可沿用的旧值——若把从别处读来的 `******` 当作真实口令提交,存下来的就是字面量 `******`,数据源会连不上。",
1481914819
"href": "/zh/api-reference/monitors/data-sources/monit-datasource-write-update",
1482014820
"metadata": {
1482114821
"sidebarTitle": "更新数据源"

0 commit comments

Comments
 (0)