lablup / lablup/backend.ai

Replace identification of vfolders from `name` to `id`

Open
#1,905 1 comment 0 reactions 1 assignee Claimed by @fregataa View on GitHub
Dominant language
Python
Stars
670
Forks
183
Avg merge
17h 7m
Merged PRs (30d)
358

Description

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)

JIRA Issue: BA-149

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.