Skip to content

Commit 3ccf685

Browse files
committed
fixed some documentations mismatch
1 parent d879a6d commit 3ccf685

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

src/main/java/io/permit/sdk/api/GroupsApi.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ private String getGroupsUrl(String url) {
6161
*
6262
* @param page The page number of the result set to retrieve.
6363
* @param perPage The number of items per page.
64-
* @return An array of GroupRead objects representing the retrieved groups.
64+
* @return An array of {@link GroupRead} objects representing the retrieved groups.
6565
* @throws IOException If an I/O error occurs during the HTTP request.
6666
* @throws PermitApiError If the Permit API returns a response with an error status code.
6767
* @throws PermitContextError If the configured {@link io.permit.sdk.PermitContext} does not match the required endpoint context.
@@ -90,10 +90,10 @@ public GroupRead[] list(int page, int perPage) throws IOException, PermitApiErro
9090
}
9191

9292
/**
93-
* Retrieves a paginated result of groups with the default number of items per page.
93+
* Retrieves a paginated result of groups with default pagination.
9494
*
9595
* @param page The page number of the result set to retrieve.
96-
* @return A PaginatedResultUserRead object representing the retrieved paginated result of groups.
96+
* @return A list of {@link GroupRead} objects representing the retrieved paginated result of groups.
9797
* @throws IOException If an I/O error occurs during the HTTP request.
9898
* @throws PermitApiError If the Permit API returns a response with an error status code.
9999
* @throws PermitContextError If the configured {@link io.permit.sdk.PermitContext} does not match the required endpoint context.
@@ -106,7 +106,7 @@ public GroupRead[] list(int page) throws IOException, PermitApiError, PermitCont
106106
/**
107107
* Retrieves a paginated result of groups with default pagination.
108108
*
109-
* @return A PaginatedResultUserRead object representing the retrieved paginated result of groups.
109+
* @return A list of {@link GroupRead} objects representing the retrieved paginated result of groups.
110110
* @throws IOException If an I/O error occurs during the HTTP request.
111111
* @throws PermitApiError If the Permit API returns a response with an error status code.
112112
* @throws PermitContextError If the configured {@link io.permit.sdk.PermitContext} does not match the required endpoint context.

src/test/java/io/permit/sdk/endpoints/ResourcesApiE2ETest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ void testResourcesApi() {
111111
logger.info("verify can find new resource in the new list");
112112
assertTrue(Arrays.stream(resources).map(r -> r.key).collect(Collectors.toList()).contains(documentData.key));
113113

114-
logger.info("get non existing user -> 404");
114+
logger.info("get non existing resource -> 404");
115115
PermitApiError notFoundError = assertThrows(PermitApiError.class, () -> {
116116
permit.api.resources.get("group");
117117
});

0 commit comments

Comments
 (0)