[DOC] refresh index: clarify whether the HTTP request returns immediately or waits for the refresh to finish

[rursprung]

What do you want to do?

• Request a change to existing documentation
• Add new documentation
• Report a technical problem with the documentation
• Other

Tell us about your request.
the refresh index documentation states that an API call will trigger a refresh of the index (what a surprise). what it doesn't say is whether the HTTP request will just trigger this and return immediately or whether the request will only return once the refresh is done. in the latter case one can issue that request and wait for it to terminate and be sure that the refresh is then done, in the former case one has to wait an unknown amount of time.

other APIs which allow triggering a refresh (e.g. the refresh parameter in index document) force the API call to only terminate once the refresh is done.

it'd be good if the documentation of the refresh API clearly states which behaviour this API has.
i'd presume that it waits for the refresh to finish but have neither tested this nor looked at the code.

Version: n/a (all of them)

What other resources are available? n/a

[dblock]

[Catch All Triage - 1, 2, 3]