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

Document reprovision param for Update Workflow API #8172

Merged
merged 5 commits into from
Sep 11, 2024
Merged

Document reprovision param for Update Workflow API #8172

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
79ae861
Document reprovision param for Update Workflow API
dbwiddis Sep 4, 2024
cfb2862
Update _automating-configurations/api/create-workflow.md
dbwiddis Sep 5, 2024
bfe6e58
Update _automating-configurations/api/create-workflow.md
dbwiddis Sep 5, 2024
67eb5ac
Update _automating-configurations/api/create-workflow.md
dbwiddis Sep 5, 2024
cf55dbc
Update _automating-configurations/api/create-workflow.md
dbwiddis Sep 11, 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
16 changes: 15 additions & 1 deletion _automating-configurations/api/create-workflow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
```
{% 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`:
dbwiddis marked this conversation as resolved.
Show resolved Hide resolved

```json
PUT /_plugins/_flow_framework/workflow/<workflow_id>?update_fields=true
Expand All @@ -72,12 +72,26 @@
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"}
Copy link
Member Author

Choose a reason for hiding this comment

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

I expect this section to create a merge conflict when #8171 is merged. This section should go above that new content as it's directly related to updating. I'll resolve conflicts when the time comes.


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

Choose a reason for hiding this comment

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

can be removed I assume

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll leave that to doc reviewers. I see the <placeholder> stuff used in other copy/paste.

Copy link
Member

Choose a reason for hiding this comment

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

Yeah I see that now in other locations

Copy link
Collaborator

Choose a reason for hiding this comment

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

We typically want to spell out everything in the documentation in order to avoid confusion. This request clearly shows the reprovision query parameter and specifies that it needs to be a complete template, so we should keep this here. The template is very big so it's fine to use a descriptive placeholder.

dbwiddis marked this conversation as resolved.
Show resolved Hide resolved

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.
dbwiddis marked this conversation as resolved.
Show resolved Hide resolved
{: .note}
Copy link
Member

Choose a reason for hiding this comment

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

The {: .note} is not producing anything specific in markdown, can we remove?

Copy link
Member Author

Choose a reason for hiding this comment

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

I think that renders on the actual documentation page, see the similar one above which renders like this:

Screenshot 2024-09-04 at 4 51 44 PM

Copy link
Member

Choose a reason for hiding this comment

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

I see, I am okay with it then

Copy link
Member Author

Choose a reason for hiding this comment

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

I anticipate we'll make this particular paragraph more detailed and link to a whole separate page (like the use case templates) for the remainder of the feature, so just trying to add the minimum this time.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Correct, the {: .note} renders as a blue callout.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Doesn't render in GitHub but does render on the doc site.


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"}
dbwiddis marked this conversation as resolved.
Show resolved Hide resolved
| `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
Loading