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

[DOCS] Improve enrich policy execute 'wait_for_completion' docs #102291

Merged
merged 2 commits into from
Nov 27, 2023
Merged

[DOCS] Improve enrich policy execute 'wait_for_completion' docs #102291

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9bd0069
[DOCS] Improve enrich policy execute 'wait_for_completion' docs
abdonpijpelink Nov 16, 2023
cb5002b
Update docs/reference/ingest/apis/enrich/execute-enrich-policy.asciidoc
abdonpijpelink Nov 16, 2023
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
19 changes: 13 additions & 6 deletions docs/reference/ingest/apis/enrich/execute-enrich-policy.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,9 @@ PUT /_enrich/policy/my-policy

[source,console]
--------------------------------------------------
PUT /_enrich/policy/my-policy/_execute
PUT /_enrich/policy/my-policy/_execute?wait_for_completion=false
--------------------------------------------------
// TEST[s/\?wait_for_completion=false//]

////
[source,console]
Expand Down Expand Up @@ -93,8 +94,13 @@ The previous enrich index will deleted with a delayed maintenance job.
By default this is done every 15 minutes.
// end::update-enrich-index[]

Because this API request performs several operations,
it may take a while to return a response.
By default, this API is synchronous: It returns when a policy has been executed.
Because executing a policy performs several operations, it may take a while to
return a response, especially when the source indices are large. This can lead
to timeouts. To prevent timeouts, set the `wait_for_completion` parameter to
`false`. This runs the request asynchronously in the background, and returns a
task ID. You can use the task ID to manage the request with the <<tasks,task
management API>>.

[[execute-enrich-policy-api-path-params]]
==== {api-path-parms-title}
Expand All @@ -107,6 +113,7 @@ Enrich policy to execute.
==== {api-query-parms-title}

`wait_for_completion`::
(Required, Boolean)
If `true`, the request blocks other enrich policy execution requests until
complete. Defaults to `true`.
(Optional, Boolean)
If `true`, the request blocks until execution is complete. If `false`, the
request returns immediately and execution runs asynchronously in the background.
Defaults to `true`.
3 changes: 2 additions & 1 deletion docs/reference/ingest/geo-match-enrich-policy-type-ex.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,9 @@ enrich index for the policy.

[source,console]
----
POST /_enrich/policy/postal_policy/_execute
POST /_enrich/policy/postal_policy/_execute?wait_for_completion=false
----
// TEST[s/\?wait_for_completion=false//]
// TEST[continued]

Use the <<put-pipeline-api,create or update pipeline API>> to create an ingest
Expand Down
3 changes: 2 additions & 1 deletion docs/reference/ingest/match-enrich-policy-type-ex.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,9 @@ enrich index for the policy.

[source,console]
----
POST /_enrich/policy/users-policy/_execute
POST /_enrich/policy/users-policy/_execute?wait_for_completion=false
----
// TEST[s/\?wait_for_completion=false//]
// TEST[continued]


Expand Down
3 changes: 2 additions & 1 deletion docs/reference/ingest/range-enrich-policy-type-ex.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,9 @@ enrich index for the policy.

[source,console]
----
POST /_enrich/policy/networks-policy/_execute
POST /_enrich/policy/networks-policy/_execute?wait_for_completion=false
----
// TEST[s/\?wait_for_completion=false//]
// TEST[continued]


Expand Down
3 changes: 2 additions & 1 deletion docs/reference/tab-widgets/esql/esql-getting-started-enrich-policy.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,9 @@ PUT /_enrich/policy/clientip_policy
}
}

PUT /_enrich/policy/clientip_policy/_execute
PUT /_enrich/policy/clientip_policy/_execute?wait_for_completion=false
----
// TEST[s/\?wait_for_completion=false//]

////
[source,console]
Expand Down