-
Notifications
You must be signed in to change notification settings - Fork 4
Edit dashboard version
Adil Bektursunov edited this page Apr 16, 2025
·
3 revisions
Design Item ID: DI-Portal-DSHVER-002
Design Item Name: Edit dashboard version
Related Design Items:
Related API:
- Get package by id (GET /api/v2/packages/{packageId})
- Get version references (GET /api/v3/packages/{packageId}/versions/{version}/references)
- Get packages list (GET /api/v2/packages)
- Get packages versions list (GET /api/v2/packages/{packageId}/versions)
Revision History:
| Date | Description |
|---|---|
The functionality allows the user to edit previously added packages/dashboards in the required dashboard version and republish it with updated content.
- User navigates to APIHUB Portal → workspace → group → dashboard version
- User opens required dashboard version page
- User clicks Edit button. If user does not have permission to manage version in current status (i.e. user does not have manage status permission) in the current dashboard, then edit button will be disabled (for example, if the user is on dashboard version in release status, then he shall have manage_release_version permission to be able to edit current version).
- API to get permissions of current user - GET /api/v2/packages/{packageId}:
- packageId - current dashboard Id
- API to get permissions of current user - GET /api/v2/packages/{packageId}:
- The system opens editing page of current dashboard version and shows list of included packages/dashboards which current dashboard version contains.
- API to show list of included packages/dashboards - GET /api/v3/packages/{packageId}/versions/{version}/references
- packageId = current dashboard Id
- version = current dashboard version
- API to show list of included packages/dashboards - GET /api/v3/packages/{packageId}/versions/{version}/references
All other functionality is the same as in DI-Portal-DSHVER-001: Configure dashboard version from scratch.
Processes description
Technical articles
Design Items
- Navigation to APIHUB (log in / log out)
- Create Workspace
- Create Group
- Create Package
- Favorite packages, dashboards, groups, workspaces
- Shared Packages
- Activity History in Main Page
- Personal private workspace
- Version summary
- Revision History
- Package Activity History
- Manage Manual Operations Group
- Export Operations Group (reduced source specifications)
- Export Operations Group (combined specification)
- Export List of Operations in Excel
- Search and Filter Operations
- List of Operations
- List of Operations Groups
- Manage REST Path Prefix Group
- Activity History
- List of Deprecated Operations
- Export List of Changes in Excel
- Human‐readable description for deprecated items for OpenAPI 3.0
- List of Documents
- OpenAPI Document Overview
- Copy Package Version
- Export Package Version
- Export Document from Package Version
- Export List of Deprecated Operations in Excel
- API Quality Validation Result
- Export of discrepancy analysis results for arbitrary package versions in Excel
- AI Recommendations Tab
- General Settings
- Package versions list
- Access Tokens Management
- Delete Package
- Default Release Version
- Define Release Version Pattern