Update key management v0.28

README.md

@@ -626,11 +626,11 @@ Using the index object:
 
 - [Create a key](https://docs.meilisearch.com/reference/api/keys.html#create-a-key):
 
-`client.createKey(options: KeyPayload): Promise<Key>`
+`client.createKey(options: KeyCreation): Promise<Key>`
 
 - [Update a key](https://docs.meilisearch.com/reference/api/keys.html#update-a-key):
 
-`client.updateKey(key: string, options: KeyPayload): Promise<Key>`
+`client.updateKey(key: string, options: KeyUpdate): Promise<Key>`
 
 - [Delete a key](https://docs.meilisearch.com/reference/api/keys.html#delete-a-key):
 

src/clients/client.ts

@@ -9,7 +9,7 @@
 
 import { Index } from '../indexes'
 import {
-  KeyPayload,
+  KeyCreation,
   Config,
   IndexOptions,
   IndexResponse,
@@ -26,6 +26,7 @@ import {
   TokenOptions,
   TaskParams,
   WaitOptions,
+  KeyUpdate,
 } from '../types'
 import { HttpRequests } from '../http-requests'
 import { TaskClient } from '../task'
@@ -257,11 +258,11 @@ class Client {
    * @memberof MeiliSearch
    * @method getKey
    *
-   * @param {string} key - Key
+   * @param {string} keyOrUid - Key or uid of the API key
    * @returns {Promise<Keys>} Promise returning a key
    */
-  async getKey(key: string): Promise<Key> {
-    const url = `keys/${key}`
+  async getKey(keyOrUid: string): Promise<Key> {
+    const url = `keys/${keyOrUid}`
     return await this.httpRequest.get<Key>(url)
   }
 
@@ -270,10 +271,10 @@ class Client {
    * @memberof MeiliSearch
    * @method createKey
    *
-   * @param {KeyPayload} options - Key options
+   * @param {KeyCreation} options - Key options
    * @returns {Promise<Key>} Promise returning an object with keys
    */
-  async createKey(options: KeyPayload): Promise<Key> {
+  async createKey(options: KeyCreation): Promise<Key> {
     const url = `keys`
     return await this.httpRequest.post(url, options)
   }
@@ -284,10 +285,10 @@ class Client {
    * @method updateKey
    *
    * @param {string} key - Key
-   * @param {KeyPayload} options - Key options
+   * @param {KeyUpdate} options - Key options
    * @returns {Promise<Key>} Promise returning an object with keys
    */
-  async updateKey(key: string, options: KeyPayload): Promise<Key> {
+  async updateKey(key: string, options: KeyUpdate): Promise<Key> {
     const url = `keys/${key}`
     return await this.httpRequest.patch(url, options)
   }

src/types/types.ts

@@ -297,7 +297,9 @@ export type Stats = {
  */
 
 export type Key = {
+  uid: string
   description: string
+  name: string | null
   key: string
   actions: string[]
   indexes: string[]
@@ -306,13 +308,20 @@ export type Key = {
   updateAt: string
 }
 
-export type KeyPayload = {
+export type KeyCreation = {
+  uid?: string
+  name?: string
   description?: string
   actions: string[]
   indexes: string[]
   expiresAt: string | null
 }
 
+export type KeyUpdate = {
+  name?: string
+  description?: string
+}
+
 /*
  ** version
  */