Skip to content

Commit c5c613e

Browse files
gjtorikianclaude
andcommitted
Rename vault describe_object to get_object_metadata
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent b030245 commit c5c613e

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

src/workos/vault.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ def read_object_by_name(self, *, name: str) -> VaultObject:
302302
)
303303
return response
304304

305-
def describe_object(self, *, object_id: str) -> VaultObject:
305+
def get_object_metadata(self, *, object_id: str) -> VaultObject:
306306
"""Get a Vault object's metadata without decrypting the value."""
307307
response = self._client.request(
308308
method="get",
@@ -484,7 +484,7 @@ async def read_object_by_name(self, *, name: str) -> VaultObject:
484484
)
485485
return response
486486

487-
async def describe_object(self, *, object_id: str) -> VaultObject:
487+
async def get_object_metadata(self, *, object_id: str) -> VaultObject:
488488
response = await self._client.request(
489489
method="get",
490490
path=f"vault/v1/kv/{object_id}/metadata",

tests/test_vault.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ def test_read_object_by_name(self, workos, httpx_mock):
4444
assert request.method == "GET"
4545
assert request.url.path.endswith("/vault/v1/kv/name/my-secret")
4646

47-
def test_describe_object(self, workos, httpx_mock):
47+
def test_get_object_metadata(self, workos, httpx_mock):
4848
httpx_mock.add_response(json=load_fixture("vault_object_metadata.json"))
49-
result = workos.vault.describe_object(
49+
result = workos.vault.get_object_metadata(
5050
object_id="vault_obj_01EHDAK2BFGWCSZXP9HGZ3VK8C"
5151
)
5252
assert isinstance(result, VaultObject)
@@ -246,9 +246,9 @@ async def test_read_object_by_name(self, async_workos, httpx_mock):
246246
request = httpx_mock.get_request()
247247
assert request.url.path.endswith("/vault/v1/kv/name/my-secret")
248248

249-
async def test_describe_object(self, async_workos, httpx_mock):
249+
async def test_get_object_metadata(self, async_workos, httpx_mock):
250250
httpx_mock.add_response(json=load_fixture("vault_object_metadata.json"))
251-
result = await async_workos.vault.describe_object(
251+
result = await async_workos.vault.get_object_metadata(
252252
object_id="vault_obj_01EHDAK2BFGWCSZXP9HGZ3VK8C"
253253
)
254254
assert isinstance(result, VaultObject)

0 commit comments

Comments
 (0)