DI-Portal-GF-005 Favorite packages, dashboards, groups, workspaces
Design Item ID: DI-Portal-GF-005
Design Item Name: Favorite packages, dashboards, groups, workspaces
Related Design Items: -
Related API:
- Favor package (POST /api/v2/packages/{packageId}/favor)
- Disfavor package (/api/v2/packages/{packageId}/disfavor)
- Get packages list (GET /api/v2/packages)
Revision History:
| Date | Description |
|---|---|
Description
Section titled “Description”The functionality provides a user with the ability to add package/dashboard/groups/workspace to favorites.
Flow 1 (for packages, dashboards and groups)
Section titled “Flow 1 (for packages, dashboards and groups)”Start Point
Section titled “Start Point”- User navigates to APIHUB Portal → workspace, or
- APIHUB Portal → workspace → group
Execution
Section titled “Execution”- User clicks ‘star’ icon near package/dashboard.
- The systems changes state of the icon and adds current package/dashboard in favorites.
- API to favor package: POST /api/v2/packages/{packageId}/favor
- User navigates to Favorite tab.
- The system display package/dashboard from step 1 on Favorite page.
- API to list packages on Favorite page - GET /api/v2/packages:
- onlyFavorite = true
- kind = group, package, dashboard
- User clicks ‘star’ icon near already favorite package/dashboard.
- The system removes package/dashboard from favorites. This package/dashboard is not displayed on Favorite page.
- API to disfavor package: POST /api/v2/packages/{packageId}/disfavor.
Flow 2 (for workspaces)
Section titled “Flow 2 (for workspaces)”Start Point
Section titled “Start Point”User navigates to APIHUB Portal → Workspaces tab
Execution
Section titled “Execution”- User either:
- clicks ‘star’ icon near workspace in the list of workspaces or
- opens workspace and click ‘star’ icon near workspace name
- The systems changes state of the icon.
- The system adds current workspace in favorites and displays this workspace in the left sidebar of home page..
- API to favor package: POST /api/v2/packages/{packageId}/favor
- API to list workspace in the left sidebar - GET /api/v2/packages:
- onlyFavorite = true
- kind = workspace
- User clicks ‘star’ icon near already favorite workspace.
- The system removes workspace from favorites. This workspace is not displayed under Favorite workspaces.
- API to disfavor package: POST /api/v2/packages/{packageId}/disfavor.
Screen View
Section titled “Screen View”tbd