Skip to content

Commit ed23994

Browse files
authored
Update parameter naming in keys routes (#1283)
1 parent d06422b commit ed23994

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -629,11 +629,11 @@ Using the index object:
629629

630630
- [Update a key](https://docs.meilisearch.com/reference/api/keys.html#update-a-key):
631631

632-
`client.updateKey(key: string, options: KeyUpdate): Promise<Key>`
632+
`client.updateKey(keyOrUid: string, options: KeyUpdate): Promise<Key>`
633633

634634
- [Delete a key](https://docs.meilisearch.com/reference/api/keys.html#delete-a-key):
635635

636-
`client.deleteKey(key: string): Promise<void>`
636+
`client.deleteKey(keyOrUid: string): Promise<void>`
637637

638638
### isHealthy <!-- omit in toc -->
639639

src/clients/client.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -300,12 +300,12 @@ class Client {
300300
* @memberof MeiliSearch
301301
* @method updateKey
302302
*
303-
* @param {string} key - Key
303+
* @param {string} keyOrUid - Key
304304
* @param {KeyUpdate} options - Key options
305305
* @returns {Promise<Key>} Promise returning an object with keys
306306
*/
307-
async updateKey(key: string, options: KeyUpdate): Promise<Key> {
308-
const url = `keys/${key}`
307+
async updateKey(keyOrUid: string, options: KeyUpdate): Promise<Key> {
308+
const url = `keys/${keyOrUid}`
309309
return await this.httpRequest.patch(url, options)
310310
}
311311

@@ -314,11 +314,11 @@ class Client {
314314
* @memberof MeiliSearch
315315
* @method deleteKey
316316
*
317-
* @param {string} key - Key
317+
* @param {string} keyOrUid - Key
318318
* @returns {Promise<Void>}
319319
*/
320-
async deleteKey(key: string): Promise<void> {
321-
const url = `keys/${key}`
320+
async deleteKey(keyOrUid: string): Promise<void> {
321+
const url = `keys/${keyOrUid}`
322322
return await this.httpRequest.delete<any>(url)
323323
}
324324

0 commit comments

Comments
 (0)