address tech review feedback (#1685)

Author: Xiaoshouzi-gh

src/auth/auth-config.ts

@@ -1594,19 +1594,18 @@ export class SmsRegionsAuthConfig {
     }
   }
 }
-
 /**
- * Enforcement state of reCAPTCHA protection.
- *   - 'OFF': Unenforced.
- *   - 'AUDIT': Assessment is created but result is not used to enforce.
- *   - 'ENFORCE': Assessment is created and result is used to enforce.
- */
+* Enforcement state of reCAPTCHA protection.
+*   - 'OFF': Unenforced.
+*   - 'AUDIT': Create assessment but don't enforce the result.
+*   - 'ENFORCE': Create assessment and enforce the result.
+*/
 export type RecaptchaProviderEnforcementState =  'OFF' | 'AUDIT' | 'ENFORCE';
 
 /**
- * The actions for reCAPTCHA-protected requests.
- *   - 'BLOCK': The reCAPTCHA-protected request will be blocked.
- */
+* The actions to take for reCAPTCHA-protected requests.
+*   - 'BLOCK': The reCAPTCHA-protected request will be blocked.
+*/
 export type RecaptchaAction = 'BLOCK';
 
 /**
@@ -1624,7 +1623,7 @@ export interface RecaptchaManagedRule {
 }
 
 /**
- * The key's platform type: only web supported now.
+ * The key's platform type: only web is currently supported.
  */
 export type RecaptchaKeyClientType = 'WEB';
 
@@ -1651,7 +1650,7 @@ export interface RecaptchaKey {
  */
 export interface RecaptchaConfig {
   /**
-  * The enforcement state of email password provider.
+  * The enforcement state of the email password provider.
   */
   emailPasswordEnforcementState?: RecaptchaProviderEnforcementState;
   /**

src/auth/project-config-manager.ts

@@ -20,10 +20,7 @@ import {
 } from './auth-api-request';
 
 /**
- * Defines the project config manager used to help manage project config related operations.
- * This includes:
- * <ul>
- * <li>The ability to update and get project config.</li>
+ * Manages (gets and updates) the current project config.
  */
 export class ProjectConfigManager {
   private readonly authRequestHandler: AuthRequestHandler;

src/auth/project-config.ts

@@ -32,26 +32,26 @@ export interface UpdateProjectConfigRequest {
    */
   smsRegionConfig?: SmsRegionConfig;
   /**
-   * The recaptcha configuration to update on the project.
-   * By enabling reCAPTCHA Enterprise Integration you are
-   * agreeing to reCAPTCHA Enterprise
+   * The reCAPTCHA configuration to update on the project.
+   * By enabling reCAPTCHA Enterprise integration, you are
+   * agreeing to the reCAPTCHA Enterprise
    * {@link https://cloud.google.com/terms/service-terms | Term of Service}.
    */
   recaptchaConfig?: RecaptchaConfig;
 }
 
 /**
- * Response received from getting or updating a project config.
- * This object currently exposes only the SMS Region config.
+ * Response received when getting or updating the project config.
+ * Currently only includes the reCAPTCHA and SMS Region config.
  */
 export interface ProjectConfigServerResponse {
   smsRegionConfig?: SmsRegionConfig;
   recaptchaConfig?: RecaptchaConfig;
 }
 
 /**
- * Request sent to update project config.
- * This object currently exposes only the SMS Region config.
+ * Request to update the project config.
+ * Currently only includes the reCAPTCHA and SMS Region config.
  */
 export interface ProjectConfigClientRequest {
   smsRegionConfig?: SmsRegionConfig;
@@ -68,10 +68,10 @@ export class ProjectConfig {
    * This is based on the calling code of the destination phone number.
    */
   public readonly smsRegionConfig?: SmsRegionConfig;
-  /**
-   * The recaptcha configuration to update on the project config.
-   * By enabling reCAPTCHA Enterprise Integration you are
-   * agreeing to reCAPTCHA Enterprise
+   /**
+   * The reCAPTCHA configuration to update on the project.
+   * By enabling reCAPTCHA Enterprise integration, you are
+   * agreeing to the reCAPTCHA Enterprise
    * {@link https://cloud.google.com/terms/service-terms | Term of Service}.
    */
   private readonly recaptchaConfig_?: RecaptchaAuthConfig;
@@ -125,7 +125,7 @@ export class ProjectConfig {
   }
 
   /**
-   * The recaptcha configuration.
+   * The reCAPTCHA configuration.
    */
   get recaptchaConfig(): RecaptchaConfig | undefined {
     return this.recaptchaConfig_;

src/auth/tenant.ts

@@ -61,9 +61,9 @@ export interface UpdateTenantRequest {
   smsRegionConfig?: SmsRegionConfig;
 
   /**
-   * The recaptcha configuration to update on the tenant.
-   * By enabling reCAPTCHA Enterprise Integration you are
-   * agreeing to reCAPTCHA Enterprise
+   * The reCAPTCHA configuration to update on the tenant.
+   * By enabling reCAPTCHA Enterprise integration, you are
+   * agreeing to the reCAPTCHA Enterprise
    * {@link https://cloud.google.com/terms/service-terms | Term of Service}.
    */
   recaptchaConfig?: RecaptchaConfig;