Skip to content

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

Merged
gildub merged 1 commit into
mainfrom
create-pull-request/patch-0ad3387
Sep 16, 2026
Merged

gildub merged 1 commit into
mainfrom
create-pull-request/patch-0ad3387

Conversation

@trustify-ci-bot

@trustify-ci-bot trustify-ci-bot Bot commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

The openapi.yaml of trustify has changed

Summary by Sourcery

Update the trustd OpenAPI specification to expose aggregated vendor recommendation reporting for multiple SBOMs.

New Features:

  • Add an API endpoint for generating aggregated vendor recommendation reports across selected SBOMs.
  • Define OpenAPI request, response, impact summary, SBOM summary, and package schemas for recommendation reports.

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

sourcery-ai Bot commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Updates the trustd OpenAPI specification to expose the new recommendation report endpoint and fully describe its request, response, aggregation, and error contracts.

Sequence diagram for the recommendation report request

sequenceDiagram
    actor Client
    participant Trustd

    Client->>Trustd: POST /api/v3/recommend/report
    Trustd-->>Client: 200 RecommendReportResponse
    Trustd-->>Client: 413 package count exceeds configured limit
Loading

File-Level Changes

Change Details Files
Adds the OpenAPI contract for generating aggregated vendor recommendation reports across multiple SBOMs.
  • Defines a POST endpoint accepting a required list of SBOM UUIDs.
  • Documents successful report responses and the package-count limit error.
  • Adds schemas for impact summaries, per-SBOM summaries, and deduplicated recommended packages, including provenance and vulnerability data.
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 reviewed your changes and they look great!

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

@codecov

codecov Bot commented Sep 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 57.16%. Comparing base (0ad3387) to head (4d6edfe).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1254   +/-   ##
=======================================
  Coverage   57.16%   57.16%           
=======================================
  Files         263      263           
  Lines        6014     6014           
  Branches     1907     1907           
=======================================
  Hits         3438     3438           
  Misses       2335     2335           
  Partials      241      241           
Flag Coverage Δ
e2e 69.69% <ø> (ø)
unit 18.33% <ø> (ø)

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.

@gildub
gildub added this pull request to the merge queue Sep 16, 2026
Merged via the queue into main with commit b6e7595 Sep 16, 2026
13 checks passed
@github-project-automation github-project-automation Bot moved this to Done in Trustify Sep 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant