Skip to content

Commit

Permalink
Improve search() docstring (#83)
Browse files Browse the repository at this point in the history
  • Loading branch information
pederhan authored Jun 17, 2024
1 parent 1c98e11 commit bc39c59
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
9 changes: 1 addition & 8 deletions harborapi/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------
Expand Down

0 comments on commit bc39c59

Please sign in to comment.