fix: spellcheck and update checker repo version

This commit is contained in:
JimMoen 2022-08-09 09:49:14 +08:00
parent 7305c3c04c
commit d51ca2672a
9 changed files with 43 additions and 14 deletions

View File

@ -205,7 +205,7 @@ jobs:
- emqx - emqx
- emqx-enterprise - emqx-enterprise
runs-on: aws-amd64 runs-on: aws-amd64
container: "ghcr.io/emqx/emqx-schema-validate:0.3.3" container: "ghcr.io/emqx/emqx-schema-validate:0.3.5"
steps: steps:
- uses: actions/download-artifact@v2 - uses: actions/download-artifact@v2
name: Download schema dump name: Download schema dump

View File

@ -21,7 +21,7 @@ will be forwarded.
write_syntax { write_syntax {
desc { desc {
en: """ en: """
Conf of InfluxDB line protocol to write data points. It is a text-based format that provides the measurement, tag set, field set, and timestamp of a data point, and placeHolder supported. Conf of InfluxDB line protocol to write data points. It is a text-based format that provides the measurement, tag set, field set, and timestamp of a data point, and placeholder supported.
See also [InfluxDB 2.3 Line Protocol](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/line-protocol/) and See also [InfluxDB 2.3 Line Protocol](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/line-protocol/) and
[InfluxDB 1.8 Line Protocol](https://docs.influxdata.com/influxdb/v1.8/write_protocols/line_protocol_tutorial/) </br> [InfluxDB 1.8 Line Protocol](https://docs.influxdata.com/influxdb/v1.8/write_protocols/line_protocol_tutorial/) </br>
TLDR: TLDR:
@ -97,6 +97,7 @@ TLDR:
zh: "桥接名字" zh: "桥接名字"
} }
} }
desc_connector { desc_connector {
desc { desc {
en: """Generic configuration for the connector.""" en: """Generic configuration for the connector."""

View File

@ -131,7 +131,13 @@ type_name_field(Type) ->
desc("config") -> desc("config") ->
?DESC("desc_config"); ?DESC("desc_config");
desc(Method) when Method =:= "get"; Method =:= "put"; Method =:= "post" -> desc(Method) when Method =:= "get"; Method =:= "put"; Method =:= "post" ->
["Configuration for HStream using `", string:to_upper(Method), "` method."]; ["Configuration for InfluxDB using `", string:to_upper(Method), "` method."];
desc(influxdb_udp) ->
?DESC(emqx_ee_connector_influxdb, "influxdb_udp");
desc(influxdb_api_v1) ->
?DESC(emqx_ee_connector_influxdb, "influxdb_api_v1");
desc(influxdb_api_v2) ->
?DESC(emqx_ee_connector_influxdb, "influxdb_api_v2");
desc(_) -> desc(_) ->
undefined. undefined.

View File

@ -1,5 +1,15 @@
emqx_ee_connector_hstreamdb { emqx_ee_connector_hstreamdb {
config {
desc {
en: "HStreamDB connection config"
zh: "HStreamDB 连接配置。"
}
label: {
en: "Connection config"
zh: "连接配置"
}
}
type { type {
desc { desc {
en: "The Connector Type." en: "The Connector Type."

View File

@ -1,4 +1,3 @@
emqx_ee_connector_influxdb { emqx_ee_connector_influxdb {
type { type {
desc { desc {
@ -43,7 +42,7 @@ emqx_ee_connector_influxdb {
} }
protocol { protocol {
desc { desc {
en: """InfluxDB protocol. UDP or HTTP API or HTTP API V2""" en: """InfluxDB's protocol. UDP or HTTP API or HTTP API V2"""
zh: """InfluxDB 协议。UDP 或 HTTP API 或 HTTP API V2""" zh: """InfluxDB 协议。UDP 或 HTTP API 或 HTTP API V2"""
} }
label: { label: {
@ -51,9 +50,9 @@ emqx_ee_connector_influxdb {
zh: """协议""" zh: """协议"""
} }
} }
protocol_udp { influxdb_udp {
desc { desc {
en: """InfluxDB protocol.""" en: """InfluxDB's UDP protocol."""
zh: """InfluxDB UDP 协议""" zh: """InfluxDB UDP 协议"""
} }
label: { label: {
@ -61,9 +60,9 @@ emqx_ee_connector_influxdb {
zh: """UDP 协议""" zh: """UDP 协议"""
} }
} }
protocol_api_v1 { influxdb_api_v1 {
desc { desc {
en: """InfluxDB protocol. Support InfluxDB v1.8 and before.""" en: """InfluxDB's protocol. Support InfluxDB v1.8 and before."""
zh: """InfluxDB HTTP API 协议。支持 Influxdb v1.8 以及之前的版本""" zh: """InfluxDB HTTP API 协议。支持 Influxdb v1.8 以及之前的版本"""
} }
label: { label: {
@ -71,9 +70,9 @@ emqx_ee_connector_influxdb {
zh: """HTTP API 协议""" zh: """HTTP API 协议"""
} }
} }
protocol_api_v2 { influxdb_api_v2 {
desc { desc {
en: """InfluxDB protocol. Support InfluxDB v2.0 and after.""" en: """InfluxDB's protocol. Support InfluxDB v2.0 and after."""
zh: """InfluxDB HTTP API V2 协议。支持 Influxdb v2.0 以及之后的版本""" zh: """InfluxDB HTTP API V2 协议。支持 Influxdb v2.0 以及之后的版本"""
} }
label: { label: {
@ -123,7 +122,7 @@ emqx_ee_connector_influxdb {
} }
org { org {
desc { desc {
en: """InfluxDB organization name.""" en: """Organization name of InfluxDB."""
zh: """InfluxDB 组织名称。""" zh: """InfluxDB 组织名称。"""
} }
label: { label: {

View File

@ -27,6 +27,7 @@
namespace/0, namespace/0,
roots/0, roots/0,
fields/1, fields/1,
desc/1,
connector_examples/1 connector_examples/1
]). ]).
@ -123,6 +124,9 @@ values(put) ->
values(_) -> values(_) ->
#{}. #{}.
desc(config) ->
?DESC("config").
%% ------------------------------------------------------------------------------------------------- %% -------------------------------------------------------------------------------------------------
%% internal functions %% internal functions
start_client(InstId, Config) -> start_client(InstId, Config) ->

View File

@ -22,6 +22,7 @@
-export([ -export([
namespace/0, namespace/0,
fields/1, fields/1,
desc/1,
connector_examples/1 connector_examples/1
]). ]).
@ -161,6 +162,14 @@ values(api_v2, put) ->
token => <<"my_token">>, token => <<"my_token">>,
ssl => #{enable => false} ssl => #{enable => false}
}. }.
desc(influxdb_udp) ->
?DESC("influxdb_udp");
desc(influxdb_api_v1) ->
?DESC("influxdb_api_v1");
desc(influxdb_api_v2) ->
?DESC("influxdb_api_v2").
%% ------------------------------------------------------------------------------------------------- %% -------------------------------------------------------------------------------------------------
%% internal functions %% internal functions

View File

@ -7,7 +7,7 @@ else
SCHEMA="$1" SCHEMA="$1"
fi fi
docker run -d --name langtool "ghcr.io/emqx/emqx-schema-validate:0.3.3" docker run -d --name langtool "ghcr.io/emqx/emqx-schema-validate:0.3.5"
docker exec -i langtool ./emqx_schema_validate - < "${SCHEMA}" docker exec -i langtool ./emqx_schema_validate - < "${SCHEMA}"
success="$?" success="$?"