More detail for TokenParams and authParams with authUrl #47
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
| **** @(RSA8c1b)@ When the @authMethod@ is @POST@, the combined params are sent in the body of the @POST@ request | ||
| *** @(RSA8c2)@ @TokenParams@ take precedence over any configured @authParams@ when a name conflict occurs | ||
| *** @(RSA8c3)@ Specifying @authParams@ as part of @AuthOptions@ replaces any configured @authParams@ specified in @ClientOptions@. As the key/value pairs are not merged, this enables a developer to delete @authParams@ where necessary by providing an entire new set of @authParams@ | ||
| ** @(RSA8d)@ When @authCallback@ option is set, it will invoke the callback, passing in the @TokenParams@, and expects either a token string, a @TokenDetails@ object or a @TokenRequest@ object to be returne, which will in turn be used to request a token from Ably |
|
lgtm |
| *** @(TO3j8)@ @authHeaders@ - Headers to be included in any request made by the library to the @authUrl@ | ||
| *** @(TO3j9)@ @authParams@ - Query params to be included in any request made by the library to the @authUrl@ | ||
| *** @(TO3j9)@ @authParams@ - Additional params to be included in any request made by the library to the @authUrl@, either as query params in the case of @GET@ or in the body in the case of @POST@ |
There was a problem hiding this comment.
Will the POST body be form-encoded or JSON?
There was a problem hiding this comment.
Ah, I would say form-encoded as it's more common. WDYT?
|
A few comments above; otherwise lgtm. |
696f57c to
4ccdd3e
Compare
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.
Addresses #39 and ably/ably-js#116
@paddybyers can you please review.
@SimonWoolf please note we are switching the arguments in
requestToken,createTokenRequestandauthoriseas it's easy to do now and is better givenTokenParamsis the more important of the two arguments currently.