Skip to content

docs: regenerate API specs - #255

Merged
xvaier merged 2 commits into
Flared:mainfrom
am-flare:update-api-specs
Aug 28, 2026
Merged

docs: regenerate API specs#255
xvaier merged 2 commits into
Flared:mainfrom
am-flare:update-api-specs

Conversation

@am-flare

@am-flare am-flare commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Summary

Regenerated the Firework OpenAPI/Swagger specs from the current API.

  • new secret search type
  • AlertChannelSummary gains a required type (AlertType)
  • IdentifierQueryVerdict gains required search_terms and highlights
  • This is the change we want -> Recommendation gains required status, updated_at and relevancy (HIGH/MEDIUM/LOW)
image

Picks up the latest v4 changes: the `secret` search type, a required `type`
on AlertChannelSummary, `search_terms` and `highlights` on
IdentifierQueryVerdict, and `status`, `updated_at` and `relevancy_score_type`
on Recommendation (with the new RecommendationRelevancyScoreType enum).

The v2 and v3 files only move existing content around, since the generator
does not emit definitions and enum values in a stable order.

Co-authored-by: Cursor <cursoragent@cursor.com>
@am-flare

Copy link
Copy Markdown
Contributor Author

The docs mentioned I should include all changes from the generation, even though I only really want the updated recommendations API endpoint. Let me know if anything needs to be addressed!

@am-flare
am-flare marked this pull request as ready for review August 28, 2026 13:10
@xvaier
xvaier merged commit 6bf9390 into Flared:main Aug 28, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants