Update docs

wmarmot · Jun 22, 2022 · 6959c4f · 6959c4f
1 parent 9c80497
commit 6959c4f
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,6 +19,7 @@ All notable changes to this project will be documented in this file.
 - The `redis_streams` output field `stream` field now supports interpolation functions.
 - The `kafka_franz` input and outputs now support `AWS_MSK_IAM` as a SASL mechanism.
 - New `pusher` output.
+- Field `input_batches` added to config unit tests for injecting a series of message batches.
 
 ### Fixed
 

diff --git a/internal/cli/test/docs/docs.go b/internal/cli/test/docs/docs.go
@@ -66,7 +66,7 @@ It is also possible to target processors in a separate file by prefixing the tar
  },
  ).Map().Optional(),
  docs.FieldObject(
- "input_batch", "",
+ "input_batch", "Define a batch of messages to feed into your test, specify either an `input_batch` or a series of `input_batches`.",
  ).Array().Optional().WithChildren(
  docs.FieldString("content", "The raw content of the input message.").HasDefault(""),
  docs.FieldAnything(`json_content`, "Sets the raw content of the message to a JSON document matching the structure of the value.", map[string]interface{}{
@@ -82,7 +82,7 @@ It is also possible to target processors in a separate file by prefixing the tar
  docs.FieldString("metadata", "A map of metadata key/values to add to the input message.").Map().Optional(),
  ),
  docs.FieldObject(
- "input_batches", "",
+ "input_batches", "Define a series of batches of messages to feed into your test, specify either an `input_batch` or a series of `input_batches`.",
  ).ArrayOfArrays().Optional().WithChildren(
  docs.FieldString("content", "The raw content of the input message.").HasDefault(""),
  docs.FieldAnything(`json_content`, "Sets the raw content of the message to a JSON document matching the structure of the value.", map[string]interface{}{

diff --git a/website/docs/configuration/unit_testing.md b/website/docs/configuration/unit_testing.md
@@ -375,7 +375,7 @@ mocks:
 
 ### `tests[].input_batch`
 
-Sorry! This field is missing documentation.
+Define a batch of messages to feed into your test, specify either an `input_batch` or a series of `input_batches`.
 
 
 Type: list of `object` 
@@ -427,7 +427,7 @@ Type: map of `string`
 
 ### `tests[].input_batches`
 
-Sorry! This field is missing documentation.
+Define a series of batches of messages to feed into your test, specify either an `input_batch` or a series of `input_batches`.
 
 
 Type: `object`