Document Legacy Grant Types & Method deprecations #126
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
660c4b2 to
0a67b43
Compare
|
Should |
0a67b43 to
6c66dda
Compare
hzalaz
suggested changes
Jun 21, 2017
Auth0/Authentication.swift
Outdated
| @@ -223,6 +224,7 @@ public protocol Authentication: Trackable, Loggable { | |||
|
|
|||
| - returns: an authentication request that will yield Auth0 user credentials after creating the user. | |||
| */ | |||
| @available(*, deprecated, message: "see createUser(email: String, username: String?, password: String, connection: String, userMetadata: [String: Any]?)") | |||
There was a problem hiding this comment.
This is not enough since we should tell them to chain the calls right? Why dont we add more info in the comment?
Auth0/Authentication.swift
Outdated
| @@ -251,6 +253,7 @@ public protocol Authentication: Trackable, Loggable { | |||
| - parameter parameters: additional authentication parameters added for Web link. Ignored in other types | |||
|
|
|||
| - returns: a request | |||
| - warning: disabled for OIDC-conformant clients, an alternative will be added in a future release | |||
There was a problem hiding this comment.
Add info of what grant type needs to be enabled and a link to the docs about grant type
Auth0/Authentication.swift
Outdated
| @@ -278,6 +281,7 @@ public protocol Authentication: Trackable, Loggable { | |||
| - parameter connection: name of the passwordless connection. By default is 'sms' | |||
|
|
|||
| - returns: a request | |||
| - warning: disabled for OIDC-conformant clients, an alternative will be added in a future release | |||
Auth0/Authentication.swift
Outdated
| @@ -311,7 +315,7 @@ public protocol Authentication: Trackable, Loggable { | |||
| - parameter token: token obtained by authenticating the user | |||
|
|
|||
| - returns: a request that will yield user information | |||
| - important: If you are using an OIDC Conformant client please see `userClaimInfo` | |||
| - warning: for OIDC-conformant clients please use `userInfo(withAccessToken accessToken: String)` | |||
| @@ -358,6 +362,7 @@ public protocol Authentication: Trackable, Loggable { | |||
| - parameter parameters: additional parameters sent during authentication | |||
|
|
|||
| - returns: a request that will yield Auth0 user's credentials | |||
| - warning: disabled for OIDC-conformant clients, an alternative will be added in a future release | |||
There was a problem hiding this comment.
Add info of what grant type needs to be enabled and a link to the docs about grant type
Auth0/Authentication.swift
Outdated
| @@ -682,6 +687,7 @@ public extension Authentication { | |||
| - parameter parameters: additional authentication parameters added for Web link. Ignored in other types | |||
|
|
|||
| - returns: a request | |||
| - warning: disabled for OIDC-conformant clients, an alternative will be added in a future release | |||
There was a problem hiding this comment.
Add info of what grant type needs to be enabled and a link to the docs about grant type
Auth0/Authentication.swift
Outdated
| @@ -710,6 +716,7 @@ public extension Authentication { | |||
| - parameter connection: name of the passwordless connection. By default is 'sms' | |||
|
|
|||
| - returns: a request | |||
| - warning: disabled for OIDC-conformant clients, an alternative will be added in a future release | |||
| @@ -740,6 +747,7 @@ public extension Authentication { | |||
| - parameter parameters: additional parameters sent during authentication | |||
|
|
|||
| - returns: a request that will yield Auth0 user's credentials | |||
| - warning: disabled for OIDC-conformant clients, an alternative will be added in a future release | |||
There was a problem hiding this comment.
Add info of what grant type needs to be enabled and a link to the docs about grant type
Auth0/Authentication.swift
Outdated
| @@ -83,6 +83,7 @@ public protocol Authentication: Trackable, Loggable { | |||
| - returns: authentication request that will yield Auth0 User Credentials | |||
| - seeAlso: Credentials | |||
| */ | |||
| @available(*, deprecated, message: "see login(usernameOrEmail username: String, password: String, realm: String, audience: String?, scope: String?)") | |||
| // swiftlint:disable:next function_parameter_count | |||
| func login(usernameOrEmail username: String, password: String, multifactorCode: String?, connection: String, scope: String, parameters: [String: Any]) -> Request<Credentials, AuthenticationError> | |||
There was a problem hiding this comment.
Add info of what grant type needs to be enabled and a link to the docs about grant type
6bc7066 to
a9375e8
Compare
a9375e8 to
f8ff086
Compare
hzalaz
previously approved these changes
Jun 25, 2017
hzalaz
approved these changes
Jun 25, 2017
|
All good @cocojoe |
Merged
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.
Warnings added