feat: add list user workspaces endpoint #3308
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gabrielmbmb
added
type: enhancement
alvarobartt
reviewed
Jul 3, 2023
|
LGTM, I'll update the Python client accordingly! |
gabrielmbmb
force-pushed
the
feature/list_user_workspaces_endpoint
branch
from
f1b5a99 to
56ae37e
Compare
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## develop #3308 +/- ##
===========================================
- Coverage 90.13% 86.21% -3.93%
===========================================
Files 233 235 +2
Lines 12493 12681 +188
===========================================
- Hits 11261 10933 -328
- Misses 1232 1748 +516
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Sentry. |
frascuchon
reviewed
Jul 3, 2023
alvarobartt
approved these changes
Jul 4, 2023
There was a problem hiding this comment.
LGTM, are you planning to solve @frascuchon's comment or are we good to merge?
10 tasks
leiyre
pushed a commit
that referenced
this pull request
Jul 4, 2023
* develop: refactor: add `HuggingFaceDatasetMixIn` under `integrations` (#3326) feat: add list user workspaces endpoint (#3308) ci: Stop linking issues to team work project chore: add missing `greenlet` dependency in `server` extra (#3330) fix: unit test failing if not local db (#3307) ci: Optimize build + test pipeline (#3300) refactor: simplify old bulk endpoints to avoid create datasets if does not exists (#3306) 📝 Update doc site link (#3299) 🚑 Fix dependencies (#3302) feat: migrate to async SQLAlchemy engine (#3162)
gabrielmbmb
added a commit
that referenced
this pull request
Jul 4, 2023
# Description This PR adds the `list_user_workspaces` function in the SDK and the Python client, as of the recently included API endpoint at #3308, so this PR needs to wait upon its parent one to be merged first. This PR then, solves the issue we had when listing workspaces from an user, since we were listing all the workspaces, and just available for certain users. **Type of change** - [X] New feature (non-breaking change which adds functionality) **How Has This Been Tested** - [X] Add unit tests for both the SDK and the Python client **Checklist** - [X] I added relevant documentation - [X] follows the style guidelines of this project - [X] I did a self-review of my code - [X] I made corresponding changes to the documentation - [X] My changes generate no new warnings - [X] I have added tests that prove my fix is effective or that my feature works - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [x] I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/) --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Gabriel Martin <gabriel@argilla.io>
11 tasks
gabrielmbmb
pushed a commit
that referenced
this pull request
Jul 5, 2023
<!-- Thanks for your contribution! As part of our Community Growers initiative 🌱, we're donating Justdiggit bunds in your name to reforest sub-Saharan Africa. To claim your Community Growers certificate, please contact David Berenstein in our Slack community or fill in this form https://tally.so/r/n9XrxK once your PR has been merged. --> # Description This PR changes the `GET /api/v1/users/:user_id/workspaces` endpoint introduced in #3308 to return all workspaces for owner users Also, returns 404 if provided user id does not exist **Type of change** (Please delete options that are not relevant. Remember to title the PR according to the type of change) - [X] Bug fix (non-breaking change which fixes an issue) **How Has This Been Tested** (Please describe the tests that you ran to verify your changes. And ideally, reference `tests`) - [ ] Test A - [ ] Test B **Checklist** - [ ] I added relevant documentation - [x] follows the style guidelines of this project - [x] I did a self-review of my code - [ ] I made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK) (see text above) - [x] I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/)
leiyre
pushed a commit
that referenced
this pull request
Jul 5, 2023
* develop: fix: return all workspaces in system for owner users (#3343) fix: `rg.init` with argilla user using quickstart images raise an unexpected error (#3341) feat: add `Suggestion` endpoints (#3304) feat: add `list_user_workspaces` and `User.workspaces` property (#3334) refactor: add `HuggingFaceDatasetMixIn` under `integrations` (#3326) feat: add list user workspaces endpoint (#3308) ci: Stop linking issues to team work project chore: add missing `greenlet` dependency in `server` extra (#3330) docs: update developer docs (#3314) Docs/3312 docs 112 is not building correctly (#3313) fix: unit test failing if not local db (#3307) ci: Optimize build + test pipeline (#3300) refactor: simplify old bulk endpoints to avoid create datasets if does not exists (#3306)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a new endpoint to API v1 to list the workspaces to which a user belongs.
Closes #3273
Type of change
How Has This Been Tested
Manually and unit tests have been added to test this new endpoint.
Checklist