Add document for dynamic tool #10402
Conversation
Signed-off-by: zane-neo <[email protected]>
zane-neo
requested review from
kolchfa-aws,
AMoo-Miki,
natebower,
dlvenable,
epugh and
sumobrian
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
Signed-off-by: Fanit Kolchina <[email protected]>
| |:---|:---|:---|:---| | ||
| | `method` | String | Required | The HTTP method used by the API (for example, `GET`, `POST`). | | ||
| | `uri` | String | Required | The API URI. Supports `${placeholder}` syntax. Placeholders are replaced at runtime with values from the agent request body. | | ||
| | `request_body` | String | Optional | The API request body. Supports `{placeholder}` syntax. Placeholders are replaced at runtime with values from the agent request body. | |
There was a problem hiding this comment.
@zane-neo Should this be ${placeholder}?
There was a problem hiding this comment.
It should be Placeholders since it refers to all the ${placeholder} mentioned before.
There was a problem hiding this comment.
@zane-neo: Is this correct when mentioning {placeholder}?
| request_body | String | Optional | The API request body. Supports {placeholder} syntax. Placeholders are replaced at runtime with values from the agent request body. |
Or should it be ${placeholder}?
| request_body | String | Optional | The API request body. Supports ${placeholder} syntax. Placeholders are replaced at runtime with values from the agent request body. |
There was a problem hiding this comment.
Thank you, @zane-neo! Doc review complete. Please answer my question, and this will be ready for editorial review.
kolchfa-aws
added
Doc review
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
kolchfa-aws
force-pushed
the
dynamic-tool
branch
from
1fef73f to
b13d296
Compare
kolchfa-aws
added
Editorial review
Signed-off-by: Nathan Bower <[email protected]>
Description
Documentation for dynamic tool
Issues Resolved
opensearch-project/skills#459
Version
>= 3.2Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.