chore(openapi): [main] update client/openapi/trustd.yaml - #1172
chore(openapi): [main] update client/openapi/trustd.yaml#1172trustify-ci-bot[bot] wants to merge 1 commit into
Conversation
Reviewer's GuideUpdates the Trustd OpenAPI specification to add NVD as a supported importer/source alongside existing vulnerability data providers, including schema and union-type changes to model NVD-specific configuration options. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- The
NvdImporter.yearsdescription refers tostart_year, but the field is namedstartYear; update the description to match the actual property name for consistency.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The `NvdImporter.years` description refers to `start_year`, but the field is named `startYear`; update the description to match the actual property name for consistency.
## Individual Comments
### Comment 1
<location path="client/openapi/trustd.yaml" line_range="5036-5045" />
<code_context>
+ The base URL of the GitHub repository publishing NVD data as per-year
+ release assets (`CVE-<year>.json.xz` + `.meta`), in the NVD-API JSON
+ schema. The latest release is always used.
+ startYear:
+ type:
+ - integer
+ - 'null'
+ format: int32
+ description: |-
+ The first feed year to import when `years` is empty; all years from
+ here through the current year are imported. Defaults to 1999, the
+ first year with NVD data.
+ minimum: 0
+ years:
+ type: array
+ items:
+ type: integer
+ format: int32
+ minimum: 0
+ description: |-
+ An explicit set of feed years to import. When non-empty, exactly these
+ years are imported and `start_year` is ignored.
+ uniqueItems: true
OrganizationDetails:
allOf:
</code_context>
<issue_to_address>
**issue (typo):** Descriptions reference `start_year` but the field is `startYear`, which is potentially confusing.
Both `startYear` and `years` descriptions refer to `start_year`, which doesn’t exist in this schema and appears to be an internal naming copy. Please update the text to consistently reference `startYear` instead (e.g., “when `startYear` is empty” and “`startYear` is ignored”).
Suggested implementation:
```
startYear:
type:
- integer
- 'null'
format: int32
description: |-
The first feed year to import when `startYear` is empty; all years from
here through the current year are imported. Defaults to 1999, the
first year with NVD data.
minimum: 0
```
```
years:
type: array
items:
type: integer
format: int32
minimum: 0
description: |-
An explicit set of feed years to import. When non-empty, exactly these
years are imported and `startYear` is ignored.
uniqueItems: true
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| startYear: | ||
| type: | ||
| - integer | ||
| - 'null' | ||
| format: int32 | ||
| description: |- | ||
| The first feed year to import when `years` is empty; all years from | ||
| here through the current year are imported. Defaults to 1999, the | ||
| first year with NVD data. | ||
| minimum: 0 |
There was a problem hiding this comment.
issue (typo): Descriptions reference start_year but the field is startYear, which is potentially confusing.
Both startYear and years descriptions refer to start_year, which doesn’t exist in this schema and appears to be an internal naming copy. Please update the text to consistently reference startYear instead (e.g., “when startYear is empty” and “startYear is ignored”).
Suggested implementation:
startYear:
type:
- integer
- 'null'
format: int32
description: |-
The first feed year to import when `startYear` is empty; all years from
here through the current year are imported. Defaults to 1999, the
first year with NVD data.
minimum: 0
years:
type: array
items:
type: integer
format: int32
minimum: 0
description: |-
An explicit set of feed years to import. When non-empty, exactly these
years are imported and `startYear` is ignored.
uniqueItems: true
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1172 +/- ##
=======================================
Coverage 54.03% 54.03%
=======================================
Files 269 269
Lines 5904 5904
Branches 1849 1849
=======================================
Hits 3190 3190
Misses 2419 2419
Partials 295 295
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
56cd38d to
d0225f1
Compare
carlosthe19916
left a comment
There was a problem hiding this comment.
🤖 Auto-approved
Only client/openapi/trustd.yaml changed — no manual review required.
The openapi.yaml of trustify has changed