Skip to content

472 Release Track Endpoint Updates#484

Merged
seansica merged 5 commits into
nextfrom
472-release-track-endpoint-updates
Jul 7, 2026
Merged

472 Release Track Endpoint Updates#484
seansica merged 5 commits into
nextfrom
472-release-track-endpoint-updates

Conversation

@clemiller

Copy link
Copy Markdown
Contributor

Updates release track responses with UI-friendly summary and object details:

  • Adds summary counts to GET /api/release-tracks for each track:
    • members_count
    • staged_count
    • candidates_count
  • Adds object details to candidates and staged entries in GET /api/release-tracks/:id:
    • attack_id
    • name
    • description
    • modified_by_user

clemiller and others added 5 commits June 17, 2026 13:35
- add object detail fields to members and quarantine entries
- apply workbench enrichment to historical snapshot reads
- make workbench the default snapshot format and remove snapshot alias
- return 501 for unsupported filesystemstore exports
- update release track API and user docs
@seansica

seansica commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

I found an inconsistency/bug w.r.t. to what is implemented and what is documented (not the fault of this PR, but a preexisting issue).

The "Get Latest Snapshot" endpoint — GET /api/release-tracks/:id — supports emitting the retrieved snapshot in 3 formats (controlled by the bundle query parameter):

  1. workbench: emits the retrieved snapshot as a custom data structure that is suitable for the Workbench frontend
  2. bundle: emits the retrieved snapshot as a STIX 2.1 bundle
  3. filesystemstore: not implemented yet; will eventually emit a STIX FileSystemStore, probably as a zip file and/or as a path to some shared/specified output directory

However, in actuality, there was a fourth format being used — snapshot — this format also happens to be the default if you don't specify the format query param. This format is totally erroneous and needs to be removed. Your PR was adding the new enrichment fields (attack_id, name, etc.) to this erroneous snapshot format.

I removed the snapshot format and kept your changes applied to the workbench output format. workbench is now the default output format (so if you don't specify the format=workbench query parameter, your response data will be returned in the workbench format). If the Workbench frontend wasn't setting the format query param before, then probably nothing needs to change on the frontend.

In addition:

  • I modified the PR to ensure that objects in quarantine and members also get the new enrichment fields. Before, the fields were only being applied to objects in candidates and staged.
  • I modified the PR to ensure that historical snapshots — via GET /api/release-tracks/:id/snapshots/:modified — also get the enrichment fields. Before, the fields were only being returned if the retrieved snapshot was the latest snapshot.

@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 73.87755% with 64 lines in your changes missing coverage. Please review.
✅ Project coverage is 71.10%. Comparing base (bd32292) to head (b6c5db9).
⚠️ Report is 14 commits behind head on next.

Files with missing lines Patch % Lines
.../services/release-tracks/release-tracks-service.js 79.85% 28 Missing ⚠️
app/controllers/release-tracks-controller.js 47.05% 27 Missing ⚠️
...release-tracks/release-track-dynamic.repository.js 82.60% 4 Missing ⚠️
app/services/release-tracks/snapshot-service.js 86.95% 3 Missing ⚠️
app/services/release-tracks/export-service.js 71.42% 2 Missing ⚠️
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.
Additional details and impacted files
@@            Coverage Diff             @@
##             next     #484      +/-   ##
==========================================
+ Coverage   69.15%   71.10%   +1.95%     
==========================================
  Files         220      220              
  Lines       30832    31305     +473     
  Branches     2676     2941     +265     
==========================================
+ Hits        21321    22260     +939     
+ Misses       9474     9003     -471     
- Partials       37       42       +5     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@seansica seansica merged commit 79007d9 into next Jul 7, 2026
4 checks passed
@seansica seansica deleted the 472-release-track-endpoint-updates branch July 7, 2026 14:41
@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown

🎉 This PR is included in version 4.19.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants