DI‐Portal‐PKGVER‐001: Version Summary
Design Item ID: DI-Portal-PKGVER-001
Design Item Name: Version Summary
Related Design Items: -
Related API:
- Get package version content (GET /api/v3/packages/{packageId}/versions/{version})
Revision History:
| Date | Description |
|---|---|
The functionality provides a user with the ability to view aggregated information of the package version, which includes below details:
Version summary:
- Current version - name of the current version
- Revisions count - number of revisions of the version, i.e. how many times version was republished (value is a link to the revision history table).
- Previous version - previous release version
- Publication date - date when version was published
- Published by - user who published version
API Operations (section is shown for each API type available in the version):
- Total number of operations
- Number of deprecated operations
- Number of no-BWC operations
API Validation (section is shown for each API type available in the version):
- Number of BWC errors - number of breaking changes compared to specified previous version
- Changes - number of changes of each severity type
- Number of affected operations - shows for each API type how many operations have breaking changes, semi-breaking changes, deprecated changes, non-breaking changes, and annotation changes.
- User navigates to APIHUB Portal → workspace → group → package version → Overview tab
- User clicks Summary menu in package version.
- The system opens version summary page, that contains aggregated information on the contents of the selected package version
- API to show summary info - GET /api/v3/packages/{packageId}/versions/{version}
- packageId = <current package Id>
- version = <current package version'>
- includeSummary = true
- API to show summary info - GET /api/v3/packages/{packageId}/versions/{version}
- User hovers over any change type in Number of changes field.
- The system shows tooltip with description of the change type.
- User hovers over any change type in Number of affected operations field.
- The system shows tooltip with description of the change type.
tbd