Added doc fields for aws_v4 auth

redpanda-data · May 10, 2024 · e740e40 · e740e40
1 parent 002529e
commit e740e40
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 13 deletions.
diff --git a/internal/httpclient/auth.go b/internal/httpclient/auth.go
@@ -365,7 +365,8 @@ func awsV4FieldSpec() *service.ConfigField {
 		service.NewStringField(av4FieldService).
 			Description("Optional service name to use for the request").
 			Default(""),
-	)
+	).Advanced().
+		Description("Allows you to specify AWS V4 authentication.")
 }
 
 func awsV4FromParsed(conf *service.ParsedConfig) (res AWSV4Config, err error) {

diff --git a/website/docs/components/inputs/http_client.md b/website/docs/components/inputs/http_client.md
@@ -33,9 +33,6 @@ input:
     url: "" # No default (required)
     verb: GET
     headers: {}
-    aws_v4:
-      enabled: false
-      service: ""
     rate_limit: "" # No default (optional)
     timeout: 5s
     payload: "" # No default (optional)
@@ -484,7 +481,7 @@ Default: `{}`
 
 ### `aws_v4`
 
-Sorry! This field is missing documentation.
+Allows you to specify AWS V4 authentication.
 
 
 Type: `object`  

diff --git a/website/docs/components/outputs/http_client.md b/website/docs/components/outputs/http_client.md
@@ -33,9 +33,6 @@ output:
     url: "" # No default (required)
     verb: POST
     headers: {}
-    aws_v4:
-      enabled: false
-      service: ""
     rate_limit: "" # No default (optional)
     timeout: 5s
     max_in_flight: 64
@@ -456,7 +453,7 @@ Default: `{}`
 
 ### `aws_v4`
 
-Sorry! This field is missing documentation.
+Allows you to specify AWS V4 authentication.
 
 
 Type: `object`  

diff --git a/website/docs/components/processors/http.md b/website/docs/components/processors/http.md
@@ -32,9 +32,6 @@ http:
   url: "" # No default (required)
   verb: POST
   headers: {}
-  aws_v4:
-    enabled: false
-    service: ""
   rate_limit: "" # No default (optional)
   timeout: 5s
   parallel: false
@@ -476,7 +473,7 @@ Default: `{}`
 
 ### `aws_v4`
 
-Sorry! This field is missing documentation.
+Allows you to specify AWS V4 authentication.
 
 
 Type: `object`