iSharkFly-Docs
/
opensearch-docs-cn
mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add documentation for Search Workflow State API (#6546) 

* Add documentation for Search Workflow State API

Signed-off-by: Daniel Widdis <widdis@gmail.com>

* Improve wording per review suggestions

Signed-off-by: Daniel Widdis <widdis@gmail.com>

* Match indendation on example queries

Signed-off-by: Daniel Widdis <widdis@gmail.com>

---------

Signed-off-by: Daniel Widdis <widdis@gmail.com>
This commit is contained in:
Daniel Widdis 2024-03-05 10:32:24 -08:00 committed by GitHub
parent 9a647c3e68
commit 1fbdd03a71
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 72 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
_automating-configurations/api/get-workflow-status.md
View File

@ -83,7 +83,8 @@ While provisioning is in progress, OpenSearch returns a partial resource list:
{
"workflow_step_name": "create_connector",
"workflow_step_id": "create_connector_1",
"connector_id": "NdjCQYwBLmvn802B0IwE"
"resource_type": "connector_id",
"resource_id": "NdjCQYwBLmvn802B0IwE"
}
]
}
@ -99,12 +100,14 @@ Upon provisioning completion, OpenSearch returns the full resource list:
{
"workflow_step_name": "create_connector",
"workflow_step_id": "create_connector_1",
"connector_id": "NdjCQYwBLmvn802B0IwE"
"resource_type": "connector_id",
"resource_id": "NdjCQYwBLmvn802B0IwE"
},
{
"workflow_step_name": "register_remote_model",
"workflow_step_id": "register_model_2",
"model_id": "N9jCQYwBLmvn802B0oyh"
"resource_type": "model_id",
"resource_id": "N9jCQYwBLmvn802B0oyh"
}
]
}

1
_automating-configurations/api/index.md
View File

@ -19,5 +19,6 @@ OpenSearch supports the following workflow APIs:
* [Get workflow status]({{site.url}}{{site.baseurl}}/automating-configurations/api/get-workflow-status/)
* [Get workflow steps]({{site.url}}{{site.baseurl}}/automating-configurations/api/get-workflow-steps/)
* [Search workflow]({{site.url}}{{site.baseurl}}/automating-configurations/api/search-workflow/)
* [Search workflow state]({{site.url}}{{site.baseurl}}/automating-configurations/api/search-workflow-state/)
* [Deprovision workflow]({{site.url}}{{site.baseurl}}/automating-configurations/api/deprovision-workflow/)
* [Delete workflow]({{site.url}}{{site.baseurl}}/automating-configurations/api/delete-workflow/)

63
_automating-configurations/api/search-workflow-state.md Normal file
View File

@ -0,0 +1,63 @@
---
layout: default
title: Search for a workflow state
parent: Workflow APIs
nav_order: 65
---
# Search for a workflow
This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated [GitHub issue](https://github.com/opensearch-project/flow-framework/issues/475).
{: .warning}
You can search for resources created by workflows by matching a query to a field. The fields you can search correspond to those returned by the [Get Workflow Status API]({{site.url}}{{site.baseurl}}/automating-configurations/api/get-workflow-status/).
## Path and HTTP methods
```json
GET /_plugins/_flow_framework/workflow/state/_search
POST /_plugins/_flow_framework/workflow/state/_search
```
#### Example request: All workflows with a state of `NOT_STARTED`
```json
GET /_plugins/_flow_framework/workflow/state/_search
{
"query": {
"match": {
"state": "NOT_STARTED"
}
}
}
```
{% include copy-curl.html %}
#### Example request: All workflows that have a `resources_created` field with a `workflow_step_id` of `register_model_2`
```json
GET /_plugins/_flow_framework/workflow/state/_search
{
"query": {
"nested": {
"path": "resources_created",
"query": {
"bool": {
"must": [
{
"match": {
"resources_created.workflow_step_id": "register_model_2"
}
}
]
}
}
}
}
}
```
{% include copy-curl.html %}
#### Example response
The response contains documents matching the search parameters.