Skip to content

Commit

Permalink
Add more documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Gabriel Gironda committed Jan 23, 2020
1 parent fbe5940 commit 535a875
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
6 changes: 3 additions & 3 deletions lib/util/kafka/sasl.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ func SASLFieldSpec() docs.FieldSpec {
docs.FieldCommon("mechanism", "The SASL authentication mechanism.", sarama.SASLTypePlaintext, sarama.SASLTypeOAuth),
docs.FieldCommon("user", "A `"+sarama.SASLTypePlaintext+"` username. It is recommended that you use environment variables to populate this field.", "${USER}"),
docs.FieldCommon("password", "A `"+sarama.SASLTypePlaintext+"` password. It is recommended that you use environment variables to populate this field.", "${PASSWORD}"),
docs.FieldCommon("access_token", "A static `"+sarama.SASLTypeOAuth+"` access token"),
docs.FieldCommon("token_cache", "The name of a `cache` resource to fetch`"+sarama.SASLTypeOAuth+"` tokens from"),
docs.FieldCommon("token_key", "The cache key to use with `token_cache`"),
docs.FieldCommon("access_token", "A static `"+sarama.SASLTypeOAuth+"` access token."),
docs.FieldCommon("token_cache", "The name of a `cache` resource to fetch` "+sarama.SASLTypeOAuth+"` tokens from."),
docs.FieldCommon("token_key", "The cache key to use with `token_cache`."),
)
}

Expand Down
6 changes: 3 additions & 3 deletions website/docs/components/inputs/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,15 +194,15 @@ sasl.password: ${PASSWORD}

### `sasl.access_token`

`string` A static `OAUTHBEARER` access token
`string` A static `OAUTHBEARER` access token.

### `sasl.token_cache`

`string` The name of a `cache` resource to fetch`OAUTHBEARER` tokens from
`string` The name of a `cache` resource to fetch` OAUTHBEARER` tokens from.

### `sasl.token_key`

`string` The cache key to use with `token_cache`
`string` The cache key to use with `token_cache`.

### `topic`

Expand Down
6 changes: 3 additions & 3 deletions website/docs/components/inputs/kafka_balanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,15 +203,15 @@ sasl.password: ${PASSWORD}

### `sasl.access_token`

`string` A static `OAUTHBEARER` access token
`string` A static `OAUTHBEARER` access token.

### `sasl.token_cache`

`string` The name of a `cache` resource to fetch`OAUTHBEARER` tokens from
`string` The name of a `cache` resource to fetch` OAUTHBEARER` tokens from.

### `sasl.token_key`

`string` The cache key to use with `token_cache`
`string` The cache key to use with `token_cache`.

### `topics`

Expand Down
6 changes: 3 additions & 3 deletions website/docs/components/outputs/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,15 +189,15 @@ sasl.password: ${PASSWORD}

### `sasl.access_token`

`string` A static `OAUTHBEARER` access token
`string` A static `OAUTHBEARER` access token.

### `sasl.token_cache`

`string` The name of a `cache` resource to fetch`OAUTHBEARER` tokens from
`string` The name of a `cache` resource to fetch` OAUTHBEARER` tokens from.

### `sasl.token_key`

`string` The cache key to use with `token_cache`
`string` The cache key to use with `token_cache`.

### `topic`

Expand Down

0 comments on commit 535a875

Please sign in to comment.