Add documentation for new workflow steps #6740
Merged
Conversation
This file contains 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
owaiskazi19
requested review from
hdhalter,
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable and
stephen-crawford
as code owners
Signed-off-by: Owais Kazi <[email protected]>
owaiskazi19
force-pushed
the
new-workflow-steps
branch
from
fba084f
to
9ec2fa2
Compare
ohltyler
approved these changes
Mar 20, 2024
minalsha
approved these changes
Mar 20, 2024
kolchfa-aws
added
release-notes
dbwiddis
reviewed
Mar 20, 2024
Comment on lines
45
to
47
| |`create_index`|[Create Index]({{site.url}}{{site.baseurl}}/api-reference/index-apis/create-index/) | Creates a new OpenSearch index. The inputs include `index_name`, which should be the name of the index to be created, and `configurations`, which contains the payload body of a regular REST request for creating an index. | ||
| |`create_ingest_pipeline`|[Create Ingest Pipeline]({{site.url}}{{site.baseurl}}/ingest-pipelines/create-ingest/) | Creates or updates an ingest pipeline. The inputs include `pipeline_id`, which should be the id of the pipeline, and `configurations`, which contains the payload body of a regular REST request for creating an ingest pipeline. | ||
| |`create_search_pipeline`|[Create Search Pipeline]({{site.url}}{{site.baseurl}}/search-plugins/search-pipelines/creating-search-pipeline/) | Creates or updates a search pipeline. The inputs include `pipeline_id`, which should be the id of the pipeline, and `configurations`, which contains the payload body of a regular REST request for creating a search pipeline. |
There was a problem hiding this comment.
None of the other step types in this table detail the inputs unless they have special behavior (register+deploy).
There was a problem hiding this comment.
These steps does have special behavior. We are passing the complete rest payload under a new field called configurations.
kolchfa-aws
approved these changes
Mar 20, 2024
natebower
approved these changes
Mar 21, 2024
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>
CaptainDredge
pushed a commit
to CaptainDredge/documentation-website
that referenced
this pull request
Mar 22, 2024
* Added documentation for new workflow steps Signed-off-by: Owais Kazi <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: Owais Kazi <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
hdhalter
added
3 - Done
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
Create Search Pipeline - opensearch-project/flow-framework#569
Create Index - opensearch-project/flow-framework#574
Create Ingest Pipeline - opensearch-project/flow-framework#558
Issues Resolved
Part of opensearch-project/flow-framework#541
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.