Skip to content
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.

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

docs: fix list item description #790

Merged
merged 1 commit into from
Jul 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/docs/api-reference/cassandra.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ cassandra configuration values.

_Appears on [`spec.userConfig`](#spec.userConfig)._

Allow incoming connections from CIDR address block, e.g. `10.20.0.0/16`.
CIDR address block, either as a string, or in a dict with an optional description field.

**Required**

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/api-reference/clickhouse.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ OpenSearch specific user configuration options.

_Appears on [`spec.userConfig`](#spec.userConfig)._

Allow incoming connections from CIDR address block, e.g. `10.20.0.0/16`.
CIDR address block, either as a string, or in a dict with an optional description field.

**Required**

Expand Down
10 changes: 6 additions & 4 deletions docs/docs/api-reference/clickhousegrant.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,8 @@ Authentication reference to Aiven token in a secret.

_Appears on [`spec`](#spec)._

Configuration to grant a privilege. Privileges not in the manifest are revoked. Existing privileges are retained; new ones are granted.
PrivilegeGrant represents the privileges to be granted to users or roles.
See https://clickhouse.com/docs/en/sql-reference/statements/grant#granting-privilege-syntax.

**Required**

Expand All @@ -223,7 +224,7 @@ See https://clickhouse.com/docs/en/sql-reference/statements/grant#granting-privi

_Appears on [`spec.privilegeGrants`](#spec.privilegeGrants)._

List of grantees (users or roles) to grant the privilege to.
Grantee represents a user or a role to which privileges or roles are granted.

**Optional**

Expand All @@ -234,7 +235,8 @@ List of grantees (users or roles) to grant the privilege to.

_Appears on [`spec`](#spec)._

Configuration to grant a role. Role grants not in the manifest are revoked. Existing role grants are retained; new ones are granted.
RoleGrant represents the roles to be assigned to users or roles.
See https://clickhouse.com/docs/en/sql-reference/statements/grant#assigning-role-syntax.

**Required**

Expand All @@ -250,7 +252,7 @@ See https://clickhouse.com/docs/en/sql-reference/statements/grant#admin-option.

_Appears on [`spec.roleGrants`](#spec.roleGrants)._

List of grantees (users or roles) to grant the privilege to.
Grantee represents a user or a role to which privileges or roles are granted.

**Optional**

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/api-reference/grafana.md
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,7 @@ External image store settings.

_Appears on [`spec.userConfig`](#spec.userConfig)._

Allow incoming connections from CIDR address block, e.g. `10.20.0.0/16`.
CIDR address block, either as a string, or in a dict with an optional description field.

**Required**

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/api-reference/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ Kafka specific user configuration options.

_Appears on [`spec.userConfig`](#spec.userConfig)._

Allow incoming connections from CIDR address block, e.g. `10.20.0.0/16`.
CIDR address block, either as a string, or in a dict with an optional description field.

**Required**

Expand Down Expand Up @@ -335,7 +335,7 @@ Kafka Connect configuration values.

_Appears on [`spec.userConfig`](#spec.userConfig)._

Configure external secret providers in order to reference external secrets in connector configuration. Currently Hashicorp Vault (provider: vault, auth_method: token) and AWS Secrets Manager (provider: aws, auth_method: credentials) are supported. Secrets can be referenced in connector config with ${<provider_name>:<secret_path>:<key_name>}.
SecretProvider.

**Required**

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/api-reference/kafkaconnect.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ KafkaConnect specific user configuration options.

_Appears on [`spec.userConfig`](#spec.userConfig)._

Allow incoming connections from CIDR address block, e.g. `10.20.0.0/16`.
CIDR address block, either as a string, or in a dict with an optional description field.

**Required**

Expand Down Expand Up @@ -224,7 +224,7 @@ Allow access to selected service ports from the public Internet.

_Appears on [`spec.userConfig`](#spec.userConfig)._

Configure external secret providers in order to reference external secrets in connector configuration. Currently Hashicorp Vault (provider: vault, auth_method: token) and AWS Secrets Manager (provider: aws, auth_method: credentials) are supported. Secrets can be referenced in connector config with ${<provider_name>:<secret_path>:<key_name>}.
SecretProvider.

**Required**

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/api-reference/mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ MySQL specific user configuration options.

_Appears on [`spec.userConfig`](#spec.userConfig)._

Allow incoming connections from CIDR address block, e.g. `10.20.0.0/16`.
CIDR address block, either as a string, or in a dict with an optional description field.

**Required**

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/api-reference/opensearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ OpenSearch specific user configuration options.

_Appears on [`spec.userConfig`](#spec.userConfig)._

Index patterns.
Allows you to create glob style patterns and set a max number of indexes matching this pattern you want to keep. Creating indexes exceeding this value will cause the oldest one to get deleted. You could for example create a pattern looking like `logs.?` and then create index logs.1, logs.2 etc, it will delete logs.1 once you create logs.6. Do note `logs.?` does not apply to logs.10. Note: Setting max_index_count to 0 will do nothing and the pattern gets ignored.

**Required**

Expand All @@ -245,7 +245,7 @@ Template settings for all new indexes.

_Appears on [`spec.userConfig`](#spec.userConfig)._

Allow incoming connections from CIDR address block, e.g. `10.20.0.0/16`.
CIDR address block, either as a string, or in a dict with an optional description field.

**Required**

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/api-reference/postgresql.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ PostgreSQL specific user configuration options.

_Appears on [`spec.userConfig`](#spec.userConfig)._

Allow incoming connections from CIDR address block, e.g. `10.20.0.0/16`.
CIDR address block, either as a string, or in a dict with an optional description field.

**Required**

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/api-reference/redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ Redis specific user configuration options.

_Appears on [`spec.userConfig`](#spec.userConfig)._

Allow incoming connections from CIDR address block, e.g. `10.20.0.0/16`.
CIDR address block, either as a string, or in a dict with an optional description field.

**Required**

Expand Down
14 changes: 7 additions & 7 deletions docs/docs/api-reference/serviceintegration.md
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ Clickhouse Kafka configuration values.

_Appears on [`spec.clickhouseKafka`](#spec.clickhouseKafka)._

Tables to create.
Table to create.

**Required**

Expand All @@ -320,7 +320,7 @@ Tables to create.

_Appears on [`spec.clickhouseKafka.tables`](#spec.clickhouseKafka.tables)._

Table columns.
Table column.

**Required**

Expand All @@ -331,7 +331,7 @@ Table columns.

_Appears on [`spec.clickhouseKafka.tables`](#spec.clickhouseKafka.tables)._

Kafka topics.
Kafka topic.

**Required**

Expand All @@ -351,7 +351,7 @@ Clickhouse PostgreSQL configuration values.

_Appears on [`spec.clickhousePostgresql`](#spec.clickhousePostgresql)._

Databases to expose.
Database to expose.

**Optional**

Expand Down Expand Up @@ -383,7 +383,7 @@ Datadog specific user configuration options.

_Appears on [`spec.datadog`](#spec.datadog)._

Custom tags provided by user.
Datadog tag defined by user.

**Required**

Expand Down Expand Up @@ -431,7 +431,7 @@ External AWS CloudWatch Metrics integration Logs configuration values.

_Appears on [`spec.externalAWSCloudwatchMetrics`](#spec.externalAWSCloudwatchMetrics)._

Metrics to not send to AWS CloudWatch (takes precedence over extra_metrics).
Metric name and subfield.

**Required**

Expand All @@ -442,7 +442,7 @@ Metrics to not send to AWS CloudWatch (takes precedence over extra_metrics).

_Appears on [`spec.externalAWSCloudwatchMetrics`](#spec.externalAWSCloudwatchMetrics)._

Metrics to allow through to AWS CloudWatch (in addition to default metrics).
Metric name and subfield.

**Required**

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/api-reference/serviceintegrationendpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ Datadog configuration values.

_Appears on [`spec.datadog`](#spec.datadog)._

Custom tags provided by user.
Datadog tag defined by user.

**Required**

Expand Down
5 changes: 4 additions & 1 deletion generators/docs/generator.go
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,10 @@ func (s *schemaType) init() {
s.Items.Name = s.Name
s.Items.level = s.level
s.Items.parent = s.parent
s.Items.Description = s.Description
if s.Items.Description == "" {
// Takes parent description if doesn't have one
s.Items.Description = s.Description
}
s.Items.init()
}

Expand Down
Loading