From bc39c59d6c6120dd1f1e70200928def21ce5dda5 Mon Sep 17 00:00:00 2001 From: Peder Hovdan Andresen <107681714+pederhan@users.noreply.github.com> Date: Mon, 17 Jun 2024 11:24:43 +0200 Subject: [PATCH] Improve `search()` docstring (#83) --- CHANGELOG.md | 3 +++ harborapi/client.py | 9 +-------- 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 957b55b8..df1e225a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,9 @@ While the project is still on major version 0, breaking changes may be introduce - Permissions method: - `HarborAsyncClient.get_permissions()`: Get system and project permissions for a user. +### Removed + +- References to Helm charts in `HarborAsyncClient.search()`. ## [0.24.2](https://github.com/unioslo/harborapi/tree/harborapi-v0.24.2) - 2024-06-15 diff --git a/harborapi/client.py b/harborapi/client.py index 10988a8b..1e0351c7 100644 --- a/harborapi/client.py +++ b/harborapi/client.py @@ -3256,14 +3256,7 @@ async def get_registries( # CATEGORY: search # GET /search async def search(self, query: str) -> Search: - """Search for projects, repositories and helm charts that the user has access to. - - !!! warning - The endpoints's interface seems immature, and may change in the future. - The query string is not documented, and the API spec is not clear. - In the future, this method might change and take a separate argument - for each of the search types (projects, repositories, helm charts). - + """Search for information about the projects and repositories the user has access to. Parameters ----------