add option to include markdown docs to get_registry_item (#916)

Author: gmulz

src/viam/app/app_client.py

@@ -2095,7 +2095,7 @@ async def check_permissions(self, permissions: List[AuthorizedPermissions]) -> L
         response: CheckPermissionsResponse = await self._app_client.CheckPermissions(request, metadata=self._metadata)
         return list(response.authorized_permissions)
 
-    async def get_registry_item(self, item_id: str) -> RegistryItem:
+    async def get_registry_item(self, item_id: str, include_markdown_documentation: bool = False) -> RegistryItem:
         """Get registry item by ID.
 
         ::
@@ -2113,7 +2113,7 @@ async def get_registry_item(self, item_id: str) -> RegistryItem:
 
         For more information, see `Fleet Management API <https://docs.viam.com/dev/reference/apis/fleet/#getregistryitem>`_.
         """
-        request = GetRegistryItemRequest(item_id=item_id)
+        request = GetRegistryItemRequest(item_id=item_id, include_markdown_documentation=include_markdown_documentation)
         response: GetRegistryItemResponse = await self._app_client.GetRegistryItem(request, metadata=self._metadata)
         return response.item
 

tests/mocks/services.py

@@ -1698,6 +1698,7 @@ async def DeleteRegistryItem(self, stream: Stream[DeleteRegistryItemRequest, Del
     async def GetRegistryItem(self, stream: Stream[GetRegistryItemRequest, GetRegistryItemResponse]) -> None:
         request = await stream.recv_message()
         assert request is not None
+        self.include_markdown_documentation = request.include_markdown_documentation
         await stream.send_message(GetRegistryItemResponse(item=self.items[0]))
 
 

tests/test_app_client.py

@@ -655,7 +655,8 @@ async def test_list_authorizations(self, service: MockApp):
     async def test_get_registry_item(self, service: MockApp):
         async with ChannelFor([service]) as channel:
             client = AppClient(channel, METADATA, ID)
-            item = await client.get_registry_item(ID)
+            item = await client.get_registry_item(ID, include_markdown_documentation=True)
+            assert service.include_markdown_documentation is True
             assert item.item_id == ITEM.item_id
             assert item.name == ITEM.name
             assert item.visibility == ITEM.visibility