DI‐Portal‐PKGVER‐012: Activity History

Design Item ID: DI-Portal-PKGVER-012
Design Item Name: Activity History
Related Design Items:

Related API:

• Get activity history (GET /api/v4/activity)
• Get activity history for the package (GET /api/v4/packages/{packageId}/activity)

Revision History:

Date	Description

---

Description

The functionality provides users with the ability to track and view actions taken by users within APIHUB Portal. This feature captures various events and allows the users to review them in a chronological format.
List of events that the system can track is listed in the table below in "eventType" column.
For each event the system generates appropriate message. Messages are listed in the table below in "eventMessage" column.
Each event type is related with event groups; user can filter events by event groups. Mapping between event type and and event group see in the table below in "eventType" and "eventGroup" columns.

eventType	eventMessage	eventGroup
grant_role	added with <array [role]> role(s) to the	Package members
update_role	updated role(s) of in the	Package members
delete_role	deleted with <array [role]> role(s) from the	Package members
generate_api_key	generated access token in the	Package security
revoke_api_key	revoked access token in the	Package security
publish_new_version	published version in status in the package - for the first publication	New version
publish_new_revision	published <@revision> revision of version in status in the package - for revisions starting from the second revision	Package version
patch_version_meta	changed <array [parameter]> for version of packageenum for parameter:statuslabels	Package version
delete_version	deleted version in status in package	Package version
create_package	created	Package management
delete_package	deleted	Package management
patch_package_meta	updated <array [parameter]> of packageenum for parameter:namedescriptionserviceNameimageUrldefaultRole	Package management

The system allows the users to search events by user name or package name.

1. User enters value in search field.
2. The system searches event by user name and package name.
   • API for search - GET /api/v2/activity (for Activity History in Main Page) or GET /api/v2/packages/{packageId}/activity (for Package Activity History):
     • textFilter = <user input>

The system allows the use to filter events by event group. Available filter options:

1. User clicks filter icon.
2. The system shows the following filtering options:
   • Package management: Events related to package creation, deletion, and metadata updates.
   • New version: Events for publishing new versions or revisions of packages.
   • Package version: Events related to version metadata changes, deletions, etc.
   • Package security: Events for generating and revoking access tokens.
   • Package members: Events related to role assignments, updates, and deletions.
3. The user selects one or multiple filtering options.
4. The system filters events by the selected options:
   • API for filtering - GET /api/v2/activity (for Activity History in Main Page) or GET /api/v2/packages/{packageId}/activity (for Package Activity History)
     • types = <filtering option(s) selected by the user>

User can see activity history for the specific package in package version page (see more in Package Activity History) or for some set of packages on main page (see more in Activity History in Main Page)