Add documentation for parameter substitution when provisioning workflows #6547
Conversation
dbwiddis
requested review from
hdhalter,
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable and
stephen-crawford
as code owners
|
Thanks, @dbwiddis! Is this ready for doc review? |
|
Yes, but there will be other 2.13 features. Would you prefer to wait and have all at once? |
|
Flipping this to draft as we may be implementing a different feature which will slightly change this. |
dbwiddis
force-pushed
the
param-substitution
branch
from
091e104 to
c9d9860
Compare
dbwiddis
force-pushed
the
param-substitution
branch
from
c9d9860 to
134be1b
Compare
|
Hey @hdhalter since this feature has expanded a little more I will have a good amount more added to this PR for the issue we have here: opensearch-project/flow-framework#496. We talked offline about this but I might only have more of the edits later in tonight (11:00PM PST) as I am merging a bug fix for the RC at 4pm. Is it okay to be adding extra documentation to here by then? Should I make a new PR? |
No problem, @amitgalitz. Feel free to add to this PR, and we'll review it when it's ready. Thanks! |
Signed-off-by: Daniel Widdis <[email protected]>
Signed-off-by: Daniel Widdis <[email protected]>
dbwiddis
force-pushed
the
param-substitution
branch
from
134be1b to
c94a04d
Compare
|
@hdhalter I understand @amitgalitz will be submitting a separate PR, so this one should be good to review/merge as-is. |
Yes, he submitted one yesterday. I'll put this forward for doc review. Thanks, @dbwiddis ! |
hdhalter
added
4 - Doc review
|
Thank you, @dbwiddis! This PR is my queue for review. |
There was a problem hiding this comment.
Thank you for providing this documentation, @dbwiddis! A couple of style suggestions. Please review, and then we'll be ready to move the PR to editorial review. Thanks!
|
|
||
| | Parameter | Data type | Description | | ||
| | :--- | :--- | :--- | | ||
| | `provision` | Boolean | Whether to provision the workflow as part of the request. Default is `false`. | | ||
| | `validation` | String | Whether to validate the workflow. Valid values are `all` (validate the template) and `none` (do not validate the template). Default is `all`. | | ||
| | User-provided | String | Parameters matching substitutions in the template. Optional. | |
There was a problem hiding this comment.
Instead of "user-provided", can we say something like "User-provided parameters that vary depending on the step type" or something like that?
There was a problem hiding this comment.
Some of that is in the description field (and it only varies based on the user template, not step type). I made an attempt in a918a6b that I hope works.
We also may wish to link to the provision-workflow.md file "Query Paremeters" section, which should probably include the identical text here.... just added that as fda9311
There was a problem hiding this comment.
@dbwiddis Done. Please take a look.
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]>
Signed-off-by: Daniel Widdis <[email protected]>
|
|
||
| | Parameter | Data type | Description | | ||
| | :--- | :--- | :--- | | ||
| | User-provided | String | Parameters that match substitutions in the template. Optional. | |
There was a problem hiding this comment.
| | User-provided | String | Parameters that match substitutions in the template. Optional. | | |
| | User-provided substitution expressions | String | Parameters that match substitutions in the template. Optional. | |
There was a problem hiding this comment.
I was already making a similar edit in fda9311 :)
There was a problem hiding this comment.
The wording that you chose is perfect, thank you 😄 Let me add links
Signed-off-by: Daniel Widdis <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
| #### Example request | ||
| ## Query parameters | ||
|
|
||
| If you have included a substitution expression in the template, you may pass it as a query parameter or as a string value of a request body field. For example, if you specified a credential field in a template as `openAI_key: '${{ openai_key }}'`, then you can include the `openai_key` parameter as a query parameter or body field so it can be substituted during provisioning. |
There was a problem hiding this comment.
Should this end in a colon?
There was a problem hiding this comment.
Added an intro sentence to the example.
Signed-off-by: kolchfa-aws <[email protected]>
|
Anything else needed on this? Looks like all comments have been addressed. |
hdhalter
added
3 - Done
Description
opensearch-project/flow-framework#525 added the ability to substitute expressions with API parameters during workflow provisioning.
This PR updates the documentation for this new feature.
This will be part of the 2.13 release.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.