Skip to content

Commit

Permalink
Document reprovision param for Update Workflow API
Browse files Browse the repository at this point in the history 
Signed-off-by: Daniel Widdis <[email protected]>
  • Loading branch information
@dbwiddis
dbwiddis committed Sep 4, 2024
1 parent ef8abd7 commit 79ae861
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion _automating-configurations/api/create-workflow.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ POST /_plugins/_flow_framework/workflow?validation=none
```
{% include copy-curl.html %}

You cannot update a full workflow once it has been provisioned, but you can update fields other than the `workflows` field, such as `name` and `description`:
In a workflow that has not been provisioned, you can update fields other than the `workflows` field, such as `name` and `description`:

```json
PUT /_plugins/_flow_framework/workflow/<workflow_id>?update_fields=true
Expand All @@ -72,12 +72,26 @@ PUT /_plugins/_flow_framework/workflow/<workflow_id>?update_fields=true
You cannot specify both the `provision` and `update_fields` parameters at the same time.
{: .note}

If a workflow has been provisioned, you can update and reprovision the full template:

Check failure on line 75 in _automating-configurations/api/create-workflow.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: reprovision. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: reprovision. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_automating-configurations/api/create-workflow.md", "range": {"start": {"line": 75, "column": 56}}}, "severity": "ERROR"}

```json
PUT /_plugins/_flow_framework/workflow/<workflow_id>?reprovision=true
{
<updated complete template>
}
```
{% include copy-curl.html %}

You can add new steps to the workflow but not delete them. Only steps for index settings, search pipelines, and ingest pipelines are currently supported for updating.
{: .note}

The following table lists the available query parameters. All query parameters are optional. User-provided parameters are only allowed if the `provision` parameter is set to `true`.

| Parameter | Data type | Description |
| :--- | :--- | :--- |
| `provision` | Boolean | Whether to provision the workflow as part of the request. Default is `false`. |
| `update_fields` | Boolean | Whether to update only the fields included in the request body. Default is `false`. |
| `reprovision` | Boolean | Whether to reprovision the entire template, if it has already been provisioned. A complete template must be provided in the request body. Default is `false`. |

Check failure on line 94 in _automating-configurations/api/create-workflow.md

View workflow job for this annotation

GitHub Actions / style-job 

[vale] reported by reviewdog 🐶
[OpenSearch.Spelling] Error: reprovision. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.

Raw Output:
{"message": "[OpenSearch.Spelling] Error: reprovision. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_automating-configurations/api/create-workflow.md", "range": {"start": {"line": 94, "column": 4}}}, "severity": "ERROR"}
| `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 substitution expressions | String | Parameters matching substitution expressions in the template. Only allowed if `provision` is set to `true`. Optional. If `provision` is set to `false`, you can pass these parameters in the [Provision Workflow API query parameters]({{site.url}}{{site.baseurl}}/automating-configurations/api/provision-workflow/#query-parameters). |

Expand Down

0 comments on commit 79ae861

Please sign in to comment.