Add convenience API key param to remote reindex #135949
Draft
+121
−10
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a
source.remote.api_key
parameter to the reindex API. This is equivalent to usingsource.remote.headers
withAuthorization
set toApiKey <api_key>
. It is a convenience for the user.Note on docs changes: The example request using an API key now uses an
applies-switch
to show both the pre-9.3 and post-9.3 / serverless versions. There are a few drive-by improvements to the docs, including:Adding some subsections, as suggested by a tech writer.
Fixing the bug which meant that
<OTHER_HOST_URL>
was previously not being rendered, because<
is a control character.Repeating the note about using HTTPS for basic auth in the API key section, as we wouldn't recommend sending API keys over plain HTTP either.
A nit, but writing
<OTHER_HOST_URL>:9200
is strange, since we have a placeholder URL, and the port is part of the URL, so that's fixed.