Skip to content

Commit a196aa4

Browse files
committed
Address Kevin's feedback.
1 parent d32705a commit a196aa4

File tree

2 files changed

+21
-21
lines changed

2 files changed

+21
-21
lines changed

src/main/java/com/google/firebase/auth/AbstractFirebaseAuth.java

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -447,8 +447,8 @@ protected UserRecord execute() throws FirebaseAuthException {
447447
}
448448

449449
/**
450-
* Gets a page of users starting from the specified {@code pageToken}. Page size will be limited
451-
* to 1000 users.
450+
* Gets a page of users starting from the specified {@code pageToken}. Page size is limited to
451+
* 1000 users.
452452
*
453453
* @param pageToken A non-empty page token string, or null to retrieve the first page of users.
454454
* @return A {@link ListUsersPage} instance.
@@ -1077,8 +1077,8 @@ protected String execute() throws FirebaseAuthException {
10771077
}
10781078

10791079
/**
1080-
* Creates a new OIDC Auth provider config with the attributes contained in the specified
1081-
* {@link OidcProviderConfig.CreateRequest}.
1080+
* Creates a new OpenID Connect auth provider config with the attributes contained in the
1081+
* specified {@link OidcProviderConfig.CreateRequest}.
10821082
*
10831083
* @param request A non-null {@link OidcProviderConfig.CreateRequest} instance.
10841084
* @return An {@link OidcProviderConfig} instance corresponding to the newly created provider
@@ -1124,8 +1124,8 @@ protected OidcProviderConfig execute() throws FirebaseAuthException {
11241124
}
11251125

11261126
/**
1127-
* Updates an existing OIDC Auth provider config with the attributes contained in the specified
1128-
* {@link OidcProviderConfig.UpdateRequest}.
1127+
* Updates an existing OpenID Connect auth provider config with the attributes contained in the
1128+
* specified {@link OidcProviderConfig.UpdateRequest}.
11291129
*
11301130
* @param request A non-null {@link OidcProviderConfig.UpdateRequest} instance.
11311131
* @return A {@link OidcProviderConfig} instance corresponding to the updated provider config.
@@ -1169,7 +1169,7 @@ protected OidcProviderConfig execute() throws FirebaseAuthException {
11691169
}
11701170

11711171
/**
1172-
* Gets the provider OIDC Auth config corresponding to the specified provider ID.
1172+
* Gets the OpenID Connect auth provider corresponding to the specified provider ID.
11731173
*
11741174
* @param providerId A provider ID string.
11751175
* @return An {@link OidcProviderConfig} instance.
@@ -1184,7 +1184,7 @@ public OidcProviderConfig getOidcProviderConfig(@NonNull String providerId)
11841184

11851185
/**
11861186
* Similar to {@link #getOidcProviderConfig(String)} but performs the operation asynchronously.
1187-
* Page size will be limited to 100 provider configs.
1187+
* Page size is limited to 100 provider configs.
11881188
*
11891189
* @param providerId A provider ID string.
11901190
* @return An {@code ApiFuture} which will complete successfully with an
@@ -1212,8 +1212,8 @@ protected OidcProviderConfig execute() throws FirebaseAuthException {
12121212
}
12131213

12141214
/**
1215-
* Gets a page of OIDC Auth provider configs starting from the specified {@code pageToken}. Page
1216-
* size will be limited to 100 provider configs.
1215+
* Gets a page of OpenID Connect auth provider configs starting from the specified
1216+
* {@code pageToken}. Page size is limited to 100 provider configs.
12171217
*
12181218
* @param pageToken A non-empty page token string, or null to retrieve the first page of provider
12191219
* configs.
@@ -1228,7 +1228,8 @@ public ListProviderConfigsPage<OidcProviderConfig> listOidcProviderConfigs(
12281228
}
12291229

12301230
/**
1231-
* Gets a page of OIDC Auth provider configs starting from the specified {@code pageToken}.
1231+
* Gets a page of OpenID Connect auth provider configs starting from the specified
1232+
* {@code pageToken}.
12321233
*
12331234
* @param pageToken A non-empty page token string, or null to retrieve the first page of provider
12341235
* configs.
@@ -1246,7 +1247,7 @@ public ListProviderConfigsPage<OidcProviderConfig> listOidcProviderConfigs(
12461247

12471248
/**
12481249
* Similar to {@link #listOidcProviderConfigs(String)} but performs the operation asynchronously.
1249-
* Page size will be limited to 100 provider configs.
1250+
* Page size is limited to 100 provider configs.
12501251
*
12511252
* @param pageToken A non-empty page token string, or null to retrieve the first page of provider
12521253
* configs.
@@ -1299,7 +1300,7 @@ protected ListProviderConfigsPage<OidcProviderConfig> execute()
12991300
}
13001301

13011302
/**
1302-
* Deletes the OIDC Auth provider config identified by the specified provider ID.
1303+
* Deletes the OpenID Connect auth provider config identified by the specified provider ID.
13031304
*
13041305
* @param providerId A provider ID string.
13051306
* @throws IllegalArgumentException If the provider ID string is null or empty, or is not prefixed
@@ -1431,7 +1432,7 @@ protected SamlProviderConfig execute() throws FirebaseAuthException {
14311432
}
14321433

14331434
/**
1434-
* Gets the SAML provider Auth config corresponding to the specified provider ID.
1435+
* Gets the SAML Auth provider config corresponding to the specified provider ID.
14351436
*
14361437
* @param providerId A provider ID string.
14371438
* @return An {@link SamlProviderConfig} instance.
@@ -1446,7 +1447,7 @@ public SamlProviderConfig getSamlProviderConfig(@NonNull String providerId)
14461447

14471448
/**
14481449
* Similar to {@link #getSamlProviderConfig(String)} but performs the operation asynchronously.
1449-
* Page size will be limited to 100 provider configs.
1450+
* Page size is limited to 100 provider configs.
14501451
*
14511452
* @param providerId A provider ID string.
14521453
* @return An {@code ApiFuture} which will complete successfully with an
@@ -1475,7 +1476,7 @@ protected SamlProviderConfig execute() throws FirebaseAuthException {
14751476

14761477
/**
14771478
* Gets a page of SAML Auth provider configs starting from the specified {@code pageToken}. Page
1478-
* size will be limited to 100 provider configs.
1479+
* size is limited to 100 provider configs.
14791480
*
14801481
* @param pageToken A non-empty page token string, or null to retrieve the first page of provider
14811482
* configs.
@@ -1509,7 +1510,7 @@ public ListProviderConfigsPage<SamlProviderConfig> listSamlProviderConfigs(
15091510

15101511
/**
15111512
* Similar to {@link #listSamlProviderConfigs(String)} but performs the operation asynchronously.
1512-
* Page size will be limited to 100 provider configs.
1513+
* Page size is limited to 100 provider configs.
15131514
*
15141515
* @param pageToken A non-empty page token string, or null to retrieve the first page of provider
15151516
* configs.

src/main/java/com/google/firebase/auth/OidcProviderConfig.java

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,7 @@ public static final class CreateRequest extends AbstractCreateRequest<CreateRequ
7272
* Creates a new {@link CreateRequest}, which can be used to create a new OIDC Auth provider.
7373
*
7474
* <p>The returned object should be passed to
75-
* {@link AbstractFirebaseAuth#createOidcProviderConfig(CreateRequest)} to register the provider
76-
* information persistently.
75+
* {@link AbstractFirebaseAuth#createOidcProviderConfig(CreateRequest)} to save the config.
7776
*/
7877
public CreateRequest() { }
7978

@@ -135,8 +134,8 @@ public static final class UpdateRequest extends AbstractUpdateRequest<UpdateRequ
135134
* provider.
136135
*
137136
* <p>The returned object should be passed to
138-
* {@link AbstractFirebaseAuth#updateOidcProviderConfig(CreateRequest)} to update the provider
139-
* information persistently.
137+
* {@link AbstractFirebaseAuth#updateOidcProviderConfig(CreateRequest)} to save the updated
138+
* config.
140139
*
141140
* @param providerId A non-null, non-empty provider ID string.
142141
* @throws IllegalArgumentException If the provider ID is null or empty, or is not prefixed with

0 commit comments

Comments
 (0)