[DOCS] Edits the get tokens API #45312
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lcawl
added
>docs
|
Pinging @elastic/es-docs |
|
Pinging @elastic/es-security |
jkakavas
reviewed
Aug 12, 2019
| for an access token and (possibly) a refresh token. The request needs to be made | ||
| by an authenticated user but happens _on behalf_ of another authenticated user | ||
| (the one whose credentials are passed as request parameters). This grant type is | ||
| not suitable or designed for the self-service user creation of tokens. | ||
|
|
||
| `password`:: |
There was a problem hiding this comment.
I'm not sure what is the best way to convey that these are Required but only when the appropriate grant is selected with the (Optional/Required, <parameter_type> template. I can make arguments both for Optional, as in it is optional depending on the grant type parameter selected and for Required` since these are required parameters for the relevant grant type. I'll defer to @lcawl when she is back from holidays to make the decision
There was a problem hiding this comment.
I chatted with the other folks working on this new API template and we propose using "Optional*" and clarify that it's required in XXX situation. I've made that change in this PR.
lcawl
added a commit
that referenced
this pull request
Nov 15, 2019
lcawl
added a commit
that referenced
this pull request
Nov 15, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Related to #36946
This PR adds a "Prerequisites" section to the get tokens API reference. It also moves descriptions of the grant types into the appropriate parameter definitions.