Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for optional param for get workflow step API #6736

Merged
merged 6 commits into from
Mar 21, 2024
Merged

Add documentation for optional param for get workflow step API #6736

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4dc2a6d
Added documentaion for optional param for get workflow step API
owaiskazi19 Mar 20, 2024
935823f
Addressed PR comment
owaiskazi19 Mar 20, 2024
f177c0a
Doc review
kolchfa-aws Mar 20, 2024
3f95b03
Apply suggestions from code review
kolchfa-aws Mar 21, 2024
0f47c3c
Resolved merge conflicts
kolchfa-aws Mar 21, 2024
f2b320b
Merge branch 'optional-param' of github.com:owaiskazi19/documentation…
kolchfa-aws Mar 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions _automating-configurations/api/get-workflow-steps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,21 @@ OpenSearch validates workflows by using the validation template that lists the r
}
```

The Get Workflow Steps API retrieves this file.
The Get Workflow Steps API retrieves [this](https://github.com/opensearch-project/flow-framework/blob/2.x/src/main/java/org/opensearch/flowframework/workflow/WorkflowStepFactory.java#L120-L229) enum.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The line numbers on this link may change in the future. It's also not very explanatory. Should be something like, "Returns a list of Workflow Steps including their required inputs, outputs, default timeout value, ...." etc.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed the description. Also, added link of 2.13 release branch to avoid changes later.


## Path and HTTP methods

To fetch all the workflow steps to figure out their inputs, outputs, required plugin for the workflow step and the timeout use the following request.

```json
GET /_plugins/_flow_framework/workflow/_steps
```

To fetch specific workflow steps, pass the step names to the request as a parameter.
#### Example request

```json
GET /_plugins/_flow_framework/workflow/_steps
GET /_plugins/_flow_framework/workflow/_step?workflow_step=create_connector,delete_model,deploy_model
```
{% include copy-curl.html %}

Expand All @@ -53,11 +56,11 @@ OpenSearch responds with the validation template containing the steps. The order
To retrieve the template in YAML format, specify `Content-Type: application/yaml` in the request header:

```bash
curl -XGET "http://localhost:9200/_plugins/_flow_framework/workflow/8xL8bowB8y25Tqfenm50" -H 'Content-Type: application/yaml'
curl -XGET "http://localhost:9200/_plugins/_flow_framework/workflow/_steps" -H 'Content-Type: application/yaml'
```

To retrieve the template in JSON format, specify `Content-Type: application/json` in the request header:

```bash
curl -XGET "http://localhost:9200/_plugins/_flow_framework/workflow/8xL8bowB8y25Tqfenm50" -H 'Content-Type: application/json'
curl -XGET "http://localhost:9200/_plugins/_flow_framework/workflow/_steps" -H 'Content-Type: application/json'
```
Loading