Skip to content

chore(openapi): [main] update client/openapi/trustd.yaml - #1213

Open
trustify-ci-bot[bot] wants to merge 1 commit into
mainfrom
create-pull-request/patch-00adb72
Open

chore(openapi): [main] update client/openapi/trustd.yaml#1213
trustify-ci-bot[bot] wants to merge 1 commit into
mainfrom
create-pull-request/patch-00adb72

Conversation

@trustify-ci-bot

@trustify-ci-bot trustify-ci-bot Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

The openapi.yaml of trustify has changed

Summary by Sourcery

Update the Trustify OpenAPI specification to support CISA KEV exploit data and expose exploit reporting endpoints and schemas.

New Features:

  • Add OpenAPI definitions for listing and retrieving exploit reports, including paginated results and exploit metadata.
  • Add CISA KEV catalog support through a new importer configuration and catalog identifier.
  • Expose exploit reports in vulnerability summaries.

Enhancements:

  • Update the Trustify API specification version from 0.5.0-rc.1 to 0.6.0-rc.1.

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@sourcery-ai

sourcery-ai Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Updates the trustd OpenAPI specification to version 0.6.0-rc.1 by adding exploit/KEV-related APIs, schemas, and importer configuration, and wiring exploit data into existing vulnerability responses and catalog source enums.

Sequence diagram for exploit listing and retrieval APIs

sequenceDiagram
  actor Client
  participant trustd

  Client->>trustd: listExploits(q, sort, offset, limit, total)
  trustd-->>Client: PaginatedResults_Exploit

  Client->>trustd: getExploit(id)
  trustd-->>Client: Exploit
Loading

File-Level Changes

Change Details Files
Bump trustd OpenAPI spec version to 0.6.0-rc.1 to align the client with the latest server API.
  • Update the top-level OpenAPI info.version from 0.5.0-rc.1 to 0.6.0-rc.1
client/openapi/trustd.yaml
Introduce exploit listing and retrieval endpoints and associated pagination schema.
  • Add GET /api/v3/exploit endpoint with query, sort, offset, limit, and total parameters and PaginatedResults_Exploit response
  • Add GET /api/v3/exploit/{id} endpoint to fetch a single exploit entry by ID
  • Define PaginatedResults_Exploit schema for paginated exploit responses
client/openapi/trustd.yaml
Add core Exploit domain model and integrate exploit data into vulnerability projections.
  • Define Exploit schema capturing CVE linkage, reporting/source metadata, dates, and remediation information
  • Add exploits field to vulnerability-related response payload (alongside advisories and scores) to surface exploit assertions per vulnerability
client/openapi/trustd.yaml
Add configuration support for importing KEV (known exploited vulnerability) catalogs.
  • Extend importer union schema with a KEV importer variant (kev)
  • Define KevImporter schema that composes CommonImporter options with catalog/source configuration specific to KEV catalogs
client/openapi/trustd.yaml
Extend catalog source enums to support a new cisakev source across relevant contexts.
  • Add cisakev to the list of allowed catalog sources wherever catalog/source enums are declared (multiple enum definitions updated)
client/openapi/trustd.yaml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • The PaginatedResults_Exploit.items schema duplicates the Exploit schema instead of referencing it; consider reusing #/components/schemas/Exploit to avoid divergence between the two definitions.
  • The new cisakev catalog identifier and the source example value "cisa-kev" use slightly different naming; consider standardizing these identifiers to a single canonical form to avoid confusion in clients.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The `PaginatedResults_Exploit.items` schema duplicates the `Exploit` schema instead of referencing it; consider reusing `#/components/schemas/Exploit` to avoid divergence between the two definitions.
- The new `cisakev` catalog identifier and the `source` example value "cisa-kev" use slightly different naming; consider standardizing these identifiers to a single canonical form to avoid confusion in clients.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov

codecov Bot commented Aug 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 54.20%. Comparing base (00adb72) to head (412b2bf).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1213      +/-   ##
==========================================
+ Coverage   54.19%   54.20%   +0.01%     
==========================================
  Files         255      255              
  Lines        5715     5715              
  Branches     1774     1774              
==========================================
+ Hits         3097     3098       +1     
  Misses       2355     2355              
+ Partials      263      262       -1     
Flag Coverage Δ
e2e 70.38% <ø> (+0.02%) ⬆️
unit 8.65% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

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

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

0 participants