-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Changed API Key from tuple to encoding in the docs #2477
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.
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
Conversation
replace tuple with encoding version of API Key
replaced API Key tuple with encoding
A documentation preview will be available soon. Request a new doc build by commenting
If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great, thanks!
docs/guide/connecting.asciidoc
Outdated
cluster. Note that you need the API Key credential representing the Base64-encoding of the id and api_key value | ||
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html[generated from the API Key]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good and I don't want to delay this pull request further, but for future work I think we should encourage users going to Kibana instead which has a clear UI and docs (https://www.elastic.co/guide/en/kibana/current/api-keys.html) and displays the correct encoding by default:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here's the result: https://elasticsearch-py_bk_2477.docs-preview.app.elstc.co/guide/en/elasticsearch/client/python-api/master/connecting.html#auth-apikey.
I don't understand the sentence:
You can configure the client to use Elasticsearch’s API Key for connecting to your cluster. Note that you need the API Key encoding you can generated in Kibana.
We also need to keep the Elasticsearch link for users that don't have Kibana. This all could have been done in a future pull request
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed to include both methods
Also added the same change in the init so it shows up on https://elasticsearch-py.readthedocs.io/en/latest/api/elasticsearch.html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! LGTM.
(cherry picked from commit cafeba0)
still to be added - the mention in the readthedocs indexno longer applicable with the redirect from master to latest