Merge #1067

1067: Make key description optional r=curquiza a=ellnix

Fixes #1038


Co-authored-by: ellnix <[email protected]>

Author: meili-bors[bot]

meilisearch/models/key.py

@@ -10,7 +10,7 @@
 class _KeyBase(CamelBase):
     uid: str
     name: Optional[str] = None
-    description: str
+    description: Optional[str]
     actions: List[str]
     indexes: List[str]
     expires_at: Optional[datetime] = None

tests/client/test_client_key_meilisearch.py

@@ -46,6 +46,15 @@ def test_create_keys_default(client, test_key_info):
     assert key.indexes == test_key_info["indexes"]
 
 
+def test_create_keys_without_desc(client, test_nondescript_key_info):
+    """Tests the creation of a key with no optional argument."""
+    key = client.create_key(test_nondescript_key_info)
+    print(key)
+
+    assert key.name == "keyWithoutDescription"
+    assert key.description is None
+
+
 def test_create_keys_with_options(client, test_key_info):
     """Tests the creation of a key with arguments."""
     key = client.create_key(

tests/conftest.py

@@ -205,6 +205,27 @@ def test_key_info(client):
         pass
 
 
+@fixture(scope="function")
+def test_nondescript_key_info(client):
+    key_info = {
+        "name": "keyWithoutDescription",
+        "actions": ["search"],
+        "indexes": [common.INDEX_UID],
+        "expiresAt": None,
+    }
+
+    yield key_info
+
+    try:
+        keys = client.get_keys().results
+        key = next(x for x in keys if x.name == key_info["name"])
+        client.delete_key(key.key)
+    except MeilisearchApiError:
+        pass
+    except StopIteration:
+        pass
+
+
 @fixture(scope="function")
 def get_private_key(client):
     keys = client.get_keys().results