Skip to content

Commit 94f6b4f

Browse files
committed
Improve Key's method description
1 parent 5c5ce8d commit 94f6b4f

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

‎src/main/java/com/meilisearch/sdk/Client.java‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ public void waitForTask(int uid) throws MeilisearchException {
265265
* https://docs.meilisearch.com/reference/api/keys.html#get-one-key
266266
*
267267
* @param uid Identifier of the requested Key
268-
* @return Key Instance
268+
* @return Meilisearch API response as Key Instance
269269
* @throws MeilisearchException if an error occurs
270270
*/
271271
public Key getKey(String uid) throws MeilisearchException {
@@ -275,7 +275,7 @@ public Key getKey(String uid) throws MeilisearchException {
275275
/**
276276
* Retrieves list of keys https://docs.meilisearch.com/reference/api/keys.html#get-all-keys
277277
*
278-
* @return List of keys in the Meilisearch client
278+
* @return Results containing a list of Key from the Meilisearch API
279279
* @throws MeilisearchException if an error occurs
280280
*/
281281
public Results<Key> getKeys() throws MeilisearchException {
@@ -285,19 +285,19 @@ public Results<Key> getKeys() throws MeilisearchException {
285285
/**
286286
* Get list of all API keys https://docs.meilisearch.com/reference/api/keys.html#get-all-keys
287287
*
288-
* @param query parameters accepted by the get keys route
289-
* @return List of keys in the Meilisearch client
288+
* @param params query parameters accepted by the get keys route
289+
* @return Results containing a list of Key from the Meilisearch API
290290
* @throws MeilisearchException if an error occurs
291291
*/
292-
public Results<Key> getKeys(KeysQuery param) throws MeilisearchException {
293-
return this.keysHandler.getKeys(param);
292+
public Results<Key> getKeys(KeysQuery params) throws MeilisearchException {
293+
return this.keysHandler.getKeys(params);
294294
}
295295

296296
/**
297297
* Creates a key https://docs.meilisearch.com/reference/api/keys.html#create-a-key
298298
*
299299
* @param options Key containing the options of the key
300-
* @return Key Instance
300+
* @return Meilisearch API response as Key Instance
301301
* @throws MeilisearchException if an error occurs
302302
*/
303303
public Key createKey(Key options) throws MeilisearchException {
@@ -309,8 +309,8 @@ public Key createKey(Key options) throws MeilisearchException {
309309
*
310310
* @param key String containing the key
311311
* @param options String containing the options to update
312-
* @return Key Instance
313-
* @throws MeilisearchException if client request causes an error
312+
* @return Meilisearch API response as Key Instance
313+
* @throws MeilisearchException if an error occurs
314314
*/
315315
public Key updateKey(String key, KeyUpdate options) throws MeilisearchException {
316316
return this.keysHandler.updateKey(key, options);

0 commit comments

Comments
 (0)