Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace identification of vfolders from name to id #1905

Open
Tracked by #767
fregataa opened this issue Feb 15, 2024 · 0 comments
Open
Tracked by #767

Replace identification of vfolders from name to id #1905

fregataa opened this issue Feb 15, 2024 · 0 comments
Assignees
Labels
comp:cli Related to CLI component comp:manager Related to Manager component type:enhance Enhance component, behavior, internals without user-facing features
Milestone

Comments

@fregataa
Copy link
Member

fregataa commented Feb 15, 2024

follow-up #767

There are many APIs that identify vfolders by name and it causes confusing because there could be duplicate names.
Let's deprecate it and identify vfolders by id.

Phase 1 (milestone 24.03)

Manager

  • Add optional id field to all API that have name field. APIs should use id field prior to name field
  • Replace all name based route of vfolder API to id_or_name, and check whether its UUID or string

CLI

  • Implement get_vfolder_id_by_name API to allow client to input vfolder name
  • get_vfolder_id_by_name should check ambiguity caused by shared or invited vfolders and fetch request with result of it (vfolder_id)

Webui

  • (Please leave a link of an issue in webui repo)

Phase 2 (milestone 24.09)

Manager

  • Deprecate all name parameters of vfolder API and replace them to id
  • Replace all id_or_name based route of vfolder API to id

CLI

Webui

  • (Please leave a link of an issue in webui repo)
@fregataa fregataa added comp:manager Related to Manager component comp:cli Related to CLI component labels Feb 15, 2024
@achimnol achimnol added the type:enhance Enhance component, behavior, internals without user-facing features label Apr 26, 2024
@achimnol achimnol added this to the 24.09 milestone Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
comp:cli Related to CLI component comp:manager Related to Manager component type:enhance Enhance component, behavior, internals without user-facing features
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants