Skip to content

Commit 2c6a3d0

Browse files
committed
fixed some typos
1 parent 63d30e3 commit 2c6a3d0

5 files changed

Lines changed: 8 additions & 7 deletions

File tree

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ public RelationshipTupleRead[] list(String subject, String relation, String obje
114114
* @param object The object of the relationship (a resource instance key).
115115
* @param page The page number of the results.
116116
* @return An array of RelationshipTupleRead objects representing the relationship tuples.
117-
* @throws IOException If an I/Oerror occurs during the HTTP request.
117+
* @throws IOException If an I/O error occurs during the HTTP request.
118118
* @throws PermitApiError If the Permit API returns a response with an error status code.
119119
* @throws PermitContextError If the configured {@link io.permit.sdk.PermitContext} does not match the required endpoint context.
120120
*/
@@ -129,7 +129,7 @@ public RelationshipTupleRead[] list(String subject, String relation, String obje
129129
* @param relation The relation between the two resource instances.
130130
* @param object The object of the relationship (a resource instance key).
131131
* @return An array of RelationshipTupleRead objects representing the relationship tuples.
132-
* @throws IOException If an I/Oerror occurs during the HTTP request.
132+
* @throws IOException If an I/O error occurs during the HTTP request.
133133
* @throws PermitApiError If the Permit API returns a response with an error status code.
134134
* @throws PermitContextError If the configured {@link io.permit.sdk.PermitContext} does not match the required endpoint context.
135135
*/
@@ -141,7 +141,7 @@ public RelationshipTupleRead[] list(String subject, String relation, String obje
141141
* Lists all relationship tuples with the default pagination parameters.
142142
*
143143
* @return An array of RelationshipTupleRead objects representing the relationship tuples.
144-
* @throws IOException If an I/Oerror occurs during the HTTP request.
144+
* @throws IOException If an I/O error occurs during the HTTP request.
145145
* @throws PermitApiError If the Permit API returns a response with an error status code.
146146
* @throws PermitContextError If the configured {@link io.permit.sdk.PermitContext} does not match the required endpoint context.
147147
*/

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,7 @@ public ResourceInstanceRead get(String instanceKey) throws IOException, PermitAp
146146

147147
/**
148148
* Retrieves a resource instance by its key.
149+
* This is an alias for the {@link #get} method.
149150
*
150151
* @param instanceKey The key of the resource instance.
151152
* @return A ResourceInstanceRead object representing the retrieved resource instance.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ public RelationRead getById(UUID resourceId, UUID relationId) throws IOException
172172

173173
/**
174174
* Creates a new relation under the specified resource.
175-
* Since resource respresents a type, the relation itself represents a type and not a value.
175+
* Since resource represents a type, the relation itself represents a type and not a value.
176176
*
177177
* @param resourceKey The key of the resource.
178178
* @param relationData The {@link RelationCreate} object containing the data for the new resource relation.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ public PaginatedResultUserRead list() throws IOException, PermitApiError, Permit
135135
/**
136136
* Retrieves a user by its key.
137137
*
138-
* @param userKey The key of theuser.
138+
* @param userKey The key of the user.
139139
* @return A UserRead object representing the retrieved user.
140140
* @throws IOException If an I/O error occurs during the HTTP request.
141141
* @throws PermitApiError If the Permit API returns a response with an error status code.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ void testResourcesApi() {
8585
Permit permit = new Permit(this.config);
8686
Gson gson = new Gson();
8787

88-
// roles lifecycle
88+
// users lifecycle
8989
try {
9090
logger.info("check original resource length");
9191
int originalLength = permit.api.resources.list().length;
@@ -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 role -> 404");
114+
logger.info("get non existing user -> 404");
115115
PermitApiError notFoundError = assertThrows(PermitApiError.class, () -> {
116116
permit.api.resources.get("group");
117117
});

0 commit comments

Comments
 (0)