Skip to content

Commit f22bca0

Browse files
authored
api docs (authorization): rephrase comment and fix typo (#365)
1 parent 638b2cf commit f22bca0

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

src/Saturn.Extensions.Authorization/OAuth.fs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ let private addCookie state (c : AuthenticationBuilder) = if not state.CookiesAl
1717

1818
type Saturn.Application.ApplicationBuilder with
1919
/// Enables default Google OAuth authentication.
20-
/// `jsonToClaimMap` should contain sequance of tuples where first element is a name of the of the key in JSON object and second element is a name of the claim.
20+
/// `jsonToClaimMap` should contain a sequence of tuples where the first element is the name of the key in the JSON object and the second element is the name of the claim.
2121
/// For example: `["id", ClaimTypes.NameIdentifier; "displayName", ClaimTypes.Name]` where `id` and `displayName` are names of fields in the Google JSON response (https://developers.google.com/+/web/api/rest/latest/people#resource).
2222
[<CustomOperation("use_google_oauth")>]
2323
member __.UseGoogleAuth(state: ApplicationState, clientId : string, clientSecret : string, callbackPath : string, jsonToClaimMap : (string * string) seq) =
@@ -71,7 +71,7 @@ type Saturn.Application.ApplicationBuilder with
7171
}
7272

7373
/// Enables default GitHub OAuth authentication.
74-
/// `jsonToClaimMap` should contain sequance of tuples where first element is a name of the of the key in JSON object and second element is a name of the claim.
74+
/// `jsonToClaimMap` should contain a sequence of tuples where the first element is the name of the key in the JSON object and the second element is the name of the claim.
7575
/// For example: `["login", "githubUsername"; "name", "fullName"]` where `login` and `name` are names of fields in GitHub JSON response (https://developer.github.com/v3/users/#get-the-authenticated-user).
7676
[<CustomOperation("use_github_oauth")>]
7777
member __.UseGithubAuth(state: ApplicationState, clientId : string, clientSecret : string, callbackPath : string, jsonToClaimMap : (string * string) seq) =
@@ -128,7 +128,7 @@ type Saturn.Application.ApplicationBuilder with
128128

129129
/// Enalbes default Azure AD OAuth authentication.
130130
/// `scopes` must be at least on of the scopes defined in https://docs.microsoft.com/en-us/graph/permissions-reference, for instance "User.Read".
131-
/// `jsonToClaimMap` should contain sequance of tuples where first element is a name of the of the key in JSON object and second element is a name of the claim.
131+
/// `jsonToClaimMap` should contain a sequence of tuples where the first element is the name of the key in the JSON object and the second element is the name of the claim.
132132
/// For example: `["name", "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name" ]` where `name` is the names of a field in Azure AD's JSON response (see https://docs.microsoft.com/en-us/azure/active-directory/develop/id-tokens or inspect tokens with https://jwt.ms).
133133
[<CustomOperation("use_azuread_oauth")>]
134134
member __.UseAzureADAuth(state: ApplicationState, tenantId : string, clientId : string, clientSecret: string, callbackPath : string, scopes : string seq, jsonToClaimMap : (string * string) seq) =

src/Saturn/Authentication.fs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ module OAuth =
3232
///OAuth User Information endpoint
3333
///For example: https://api.github.com/user
3434
UserInformationEndpoint: string
35-
///Sequance of tuples where first element is a name of the of the key in JSON object and second element is a name of the claim.
35+
///Sequence of tuples where the first element is the name of the key in the JSON object and the second element is the name of the claim.
3636
///For example: `["login", "githubUsername"; "name", "fullName"]` where `login` and `name` are names of fields in GitHub JSON response (https://developer.github.com/v3/users/#get-the-authenticated-user).
3737
Claims : (string * string) seq
3838
}

0 commit comments

Comments
 (0)