Skip to content
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.

Sign up for GitHub

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

Jump to bottom

chore(cognito): fix grammar in UserPool IDP docstrings #29255

Merged
merged 2 commits into from
Feb 27, 2024
Merged

chore(cognito): fix grammar in UserPool IDP docstrings #29255

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ded7a7
Fix grammar in UserPool IDP docstrings
douglasnaphas Feb 26, 2024
275080e
Merge branch 'main' into 29254-user-pool-idp-docstring-grammar
jfuss Feb 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/amazon.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ import { CfnUserPoolIdentityProvider } from '../cognito.generated';
*/
export interface UserPoolIdentityProviderAmazonProps extends UserPoolIdentityProviderProps {
/**
* The client id recognized by 'Login with Amazon' APIs.
* The client id recognized by Login with Amazon APIs.
* @see https://developer.amazon.com/docs/login-with-amazon/security-profile.html#client-identifier
*/
readonly clientId: string;
/**
* The client secret to be accompanied with clientId for 'Login with Amazon' APIs to authenticate the client.
* The client secret to be accompanied with clientId for Login with Amazon APIs to authenticate the client.
* @see https://developer.amazon.com/docs/login-with-amazon/security-profile.html#client-identifier
*/
readonly clientSecret: string;
Expand All @@ -26,7 +26,7 @@ export interface UserPoolIdentityProviderAmazonProps extends UserPoolIdentityPro
}

/**
* Represents a identity provider that integrates with 'Login with Amazon'
* Represents an identity provider that integrates with Login with Amazon
* @resource AWS::Cognito::UserPoolIdentityProvider
*/
export class UserPoolIdentityProviderAmazon extends UserPoolIdentityProviderBase {
Expand Down
2 changes: 1 addition & 1 deletion packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/apple.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export interface UserPoolIdentityProviderAppleProps extends UserPoolIdentityProv
}

/**
* Represents a identity provider that integrates with 'Apple'
* Represents an identity provider that integrates with Apple
* @resource AWS::Cognito::UserPoolIdentityProvider
*/
export class UserPoolIdentityProviderApple extends UserPoolIdentityProviderBase {
Expand Down
6 changes: 3 additions & 3 deletions packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/facebook.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ export interface UserPoolIdentityProviderFacebookProps extends UserPoolIdentityP
*/
readonly clientId: string;
/**
* The client secret to be accompanied with clientUd for Facebook to authenticate the client.
* The client secret to be accompanied with clientId for Facebook to authenticate the client.
* @see https://developers.facebook.com/docs/facebook-login/security#appsecret
*/
readonly clientSecret: string;
/**
* The list of facebook permissions to obtain for getting access to the Facebook profile.
* The list of Facebook permissions to obtain for getting access to the Facebook profile.
* @see https://developers.facebook.com/docs/facebook-login/permissions
* @default [ public_profile ]
*/
Expand All @@ -30,7 +30,7 @@ export interface UserPoolIdentityProviderFacebookProps extends UserPoolIdentityP
}

/**
* Represents a identity provider that integrates with 'Facebook Login'
* Represents an identity provider that integrates with Facebook Login
* @resource AWS::Cognito::UserPoolIdentityProvider
*/
export class UserPoolIdentityProviderFacebook extends UserPoolIdentityProviderBase {
Expand Down
4 changes: 2 additions & 2 deletions packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/google.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ export interface UserPoolIdentityProviderGoogleProps extends UserPoolIdentityPro
*/
readonly clientSecretValue?: SecretValue;
/**
* The list of google permissions to obtain for getting access to the google profile
* The list of Google permissions to obtain for getting access to the Google profile
* @see https://developers.google.com/identity/sign-in/web/sign-in
* @default [ profile ]
*/
readonly scopes?: string[];
}

/**
* Represents a identity provider that integrates with 'Google'
* Represents an identity provider that integrates with Google
* @resource AWS::Cognito::UserPoolIdentityProvider
*/
export class UserPoolIdentityProviderGoogle extends UserPoolIdentityProviderBase {
Expand Down
2 changes: 1 addition & 1 deletion packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/oidc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ export enum OidcAttributeRequestMethod {
}

/**
* Represents a identity provider that integrates with OpenID Connect
* Represents an identity provider that integrates with OpenID Connect
* @resource AWS::Cognito::UserPoolIdentityProvider
*/
export class UserPoolIdentityProviderOidc extends UserPoolIdentityProviderBase {
Expand Down
2 changes: 1 addition & 1 deletion packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/saml.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ export class UserPoolIdentityProviderSamlMetadata {
}

/**
* Represents a identity provider that integrates with SAML.
* Represents an identity provider that integrates with SAML.
* @resource AWS::Cognito::UserPoolIdentityProvider
*/
export class UserPoolIdentityProviderSaml extends UserPoolIdentityProviderBase {
Expand Down
Loading