Expose REST API endpoint to list workflow run events

[nscuro]

Description

Exposes REST API endpoint to list workflow run events.

Addressed Issue

N/A

Additional Details

N/A

Checklist

• I have read and understand the contributing guidelines
• This PR fixes a defect, and I have provided tests to verify that the fix is effective
• This PR implements an enhancement, and I have provided tests to verify that it works as intended
• This PR introduces changes to the database model, and I have updated the migration changelog accordingly
• This PR introduces new or alters existing behavior, and I have updated the documentation accordingly

[Copilot]

Pull request overview

This PR exposes a new REST API endpoint to list workflow run events (history). It refactors the internal API to return WorkflowRunHistoryEntry objects (which include both sequence numbers and events) rather than just WorkflowEvent objects, and adds support for sorting, pagination, and polling via a from_sequence_number parameter.

Changes:

• Added REST API endpoint /workflow-runs/{id}/events with support for pagination, sorting (ASC/DESC), and continuous polling via from_sequence_number
• Refactored WorkflowRunHistoryEntry from internal persistence model to public API class, exposing sequence numbers alongside events
• Enhanced listRunHistory to support descending order and filtering from a specific sequence number
• Updated all existing tests to use the new listRunHistory API returning WorkflowRunHistoryEntry instead of just WorkflowEvent

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
api/src/main/openapi/openapi.yaml	Added route definition for new events endpoint
api/src/main/openapi/paths/workflow-runs__id__events.yaml	OpenAPI specification for listing workflow run events with pagination and sorting
api/src/main/openapi/components/schemas/list-workflow-run-events-response.yaml	Response schema for events list
api/src/main/openapi/components/schemas/list-workflow-run-events-response-item.yaml	Schema for individual event items with sequence numbers
apiserver/src/main/java/org/dependencytrack/resources/v2/ResourceConfig.java	Registered ObjectMapper for dependency injection
apiserver/src/main/java/org/dependencytrack/resources/v2/WorkflowsResource.java	Implemented REST endpoint handler with protobuf-to-JSON conversion
apiserver/src/test/java/org/dependencytrack/resources/v2/WorkflowsResourceTest.java	Added basic test for new endpoint
dex/engine-api/src/main/java/org/dependencytrack/dex/engine/api/DexEngine.java	Updated interface signature from listRunEvents to listRunHistory
dex/engine-api/src/main/java/org/dependencytrack/dex/engine/api/WorkflowRunHistoryEntry.java	Moved from persistence layer to API layer, removed workflowRunId field
dex/engine-api/src/main/java/org/dependencytrack/dex/engine/api/request/ListWorkflowRunEventsRequest.java	Removed old request class
dex/engine-api/src/main/java/org/dependencytrack/dex/engine/api/request/ListWorkflowRunHistoryRequest.java	New request class with support for fromSequenceNumber and sortDirection
dex/engine/src/main/java/org/dependencytrack/dex/engine/DexEngineImpl.java	Updated to use new API, converting history entries to events internally where needed
dex/engine/src/main/java/org/dependencytrack/dex/engine/persistence/WorkflowRunDao.java	Enhanced SQL query with FreeMarker template for DESC sorting and fromSequenceNumber filtering
dex/engine/src/main/java/org/dependencytrack/dex/engine/persistence/jdbi/JdbiFactory.java	Updated import from persistence model to API
dex/engine/src/main/java/org/dependencytrack/dex/engine/persistence/jdbi/WorkflowRunHistoryEntryRowMapper.java	Updated to map to API class, removed workflowRunId mapping
dex/engine/src/test/java/org/dependencytrack/dex/engine/DexEngineImplTest.java	Updated all tests to use listRunHistory API and added comprehensive tests for pagination, DESC ordering, and fromSequenceNumber

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ +0.00% (target: -1.00%)	✅ 93.55% (target: 70.00%)

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (2a8c522)	37608	31512	83.79%
Head commit (7d59856)	37674 (+66)	31569 (+57)	83.80% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#1753)	93	87	93.55%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

[Copilot]

Pull request overview

Copilot reviewed 16 out of 16 changed files in this pull request and generated 1 comment.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.