fix: Documentation references of client_auth in flow http client. (#5884

) (#5886) (cherry picked from commit 82428ff) Co-authored-by: Devin Trejo <[email protected]>
grafana · Nov 29, 2023 · 643e817 · 643e817
1 parent 71bde9a
commit 643e817
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/docs/sources/flow/reference/config-blocks/http.md b/docs/sources/flow/reference/config-blocks/http.md
@@ -80,7 +80,7 @@ Name | Type | Description | Default | Required
 `key_file` | `string` | Path to the server TLS key on disk. | `""` | conditionally
 `client_ca_pem` | `string` | PEM data of the client CA to validate requests against. | `""` | no
 `client_ca_file` | `string` | Path to the client CA file on disk to validate requests against. | `""` | no
-`client_auth` | `string` | Client authentication to use. | `"NoClientCert"` | no
+`client_auth_type` | `string` | Client authentication to use. | `"NoClientCert"` | no
 `cipher_suites` | `list(string)` | Set of cipher suites to use. | `[]` | no
 `curve_preferences` | `list(string)` | Set of elliptic curves to use in a handshake. | `[]` | no
 `min_version` | `string` | Oldest TLS version to accept from clients. | `""` | no
@@ -97,12 +97,12 @@ configured at a time:
 * `key_pem` and `key_file`
 * `client_ca_pem` and `client_ca_file`
 
-The `client_auth` argument determines whether to validate client certificates.
+The `client_auth_type` argument determines whether to validate client certificates.
 The default value, `NoClientCert`, indicates that the client certificate is not
 validated. The `client_ca_pem` and `client_ca_file` arguments may only
-be configured when `client_auth` is not `NoClientCert`.
+be configured when `client_auth_type` is not `NoClientCert`.
 
-The following values are accepted for `client_auth`:
+The following values are accepted for `client_auth_type`:
 
 * `NoClientCert`: client certificates are neither requested nor validated.
 * `RequestClientCert`: requests clients to send an optional certificate. Certificates provided by clients are not validated.
@@ -111,7 +111,7 @@ The following values are accepted for `client_auth`:
 * `RequireAndVerifyClientCert`: requires clients to send a valid certificate.
 
 The `client_ca_pem` or `client_ca_file` arguments may be used to perform client
-certificate validation. These arguments may only be provided when `client_auth`
+certificate validation. These arguments may only be provided when `client_auth_type`
 is not set to `NoClientCert`.
 
 The `cipher_suites` argument determines what cipher suites to use. If not