Add foreach processor documentation #5981
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
vagimeli
requested review from
AMoo-Miki,
Naarcha-AWS,
hdhalter,
kolchfa-aws and
natebower
as code owners
|
@hdhalter We need a dev to take the first pass at drafting this content. I can support them in refining the content and getting it through the documentation process. The ingest processor template is provided with this PR, so it should help the dev get started. Thanks! |
45 tasks
vagimeli
requested review from
dlvenable,
epugh and
stephen-crawford
as code owners
vagimeli
changed the title
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
vagimeli
commented
May 22, 2024
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
vagimeli
commented
May 22, 2024
gaobinlong
reviewed
May 23, 2024
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
natebower
approved these changes
May 24, 2024
| |-----------|-----------|-----------| | ||
| `field` | Required | The array field to iterate over. | ||
| `processor` | Required | The processor to execute against each field. | ||
| `ignore_missing` | Optional | If `true` and the specified field does not exist or is null, the processor will quietly exit without modifying the document. |
There was a problem hiding this comment.
Is "quietly" necessary here? If it's a technical term and adds context, then fine as is.
There was a problem hiding this comment.
It's a technical expression that means hat the processor will terminate or exit its execution without performing any further actions or modifications to the document and without producing any errors or notifications.
|
|
||
| #### Response | ||
|
|
||
| The following example response confirms that the pipeline is working as expected, showing the four elements have been lowercased: |
There was a problem hiding this comment.
"that" should precede either "the four" or "have been", depending on the meaning.
| ] | ||
| } | ||
| } | ||
| gaobinlong1 day ago |
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
May 28, 2024
* Add foreach processor documentation Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Add pipeline example requests and responses Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Add pipeline examples Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Address tech review comments Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/foreach.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Update _ingest-pipelines/processors/foreach.md Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Address editorial review comments Signed-off-by: Melissa Vagi <vagimeli@amazon.com> --------- Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Co-authored-by: Nathan Bower <nbower@amazon.com> (cherry picked from commit fe979d5) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Closes content gap
Issues Resolved
#4647
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.