Skip to content

Commit 324f2c8

Browse files
ruromeroclaude
andcommitted
feat: add AdvisoryRemediation schema for advisory-grouped remediation (TC-4523)
Restructure the Remediation schema to group remediation data by source advisory. Replace flat remediations/versionRanges arrays with an advisories array of AdvisoryRemediation objects, each containing the advisory attribution, status, version ranges, fixedIn version, and remediation actions. Remove the advisory field from RemediationInfo since attribution is now at the AdvisoryRemediation level. Bump API version to 5.4.0 and artifact version to 2.0.12-SNAPSHOT. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 683926c commit 324f2c8

1 file changed

Lines changed: 27 additions & 12 deletions

File tree

api/v5/openapi.yaml

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ info:
55
license:
66
name: Apache 2.0
77
url: https://www.apache.org/licenses/LICENSE-2.0.html
8-
version: 5.3.0
8+
version: 5.4.0
99
servers:
1010
- url: /api/v5
1111
description: API v5 endpoint
@@ -539,16 +539,11 @@ components:
539539
type: array
540540
items:
541541
type: string
542-
remediations:
543-
type: array
544-
description: Detailed remediation information from vulnerability advisories
545-
items:
546-
$ref: '#/components/schemas/RemediationInfo'
547-
versionRanges:
542+
advisories:
548543
type: array
549-
description: Affected version ranges from vulnerability advisories
544+
description: Remediation details grouped by source advisory
550545
items:
551-
$ref: '#/components/schemas/VersionRange'
546+
$ref: '#/components/schemas/AdvisoryRemediation'
552547
trustedContent:
553548
type: object
554549
properties:
@@ -568,9 +563,31 @@ components:
568563
- NO_FIX_PLANNED
569564
- NONE_AVAILABLE
570565
- WILL_NOT_FIX
566+
AdvisoryRemediation:
567+
type: object
568+
description: Remediation information grouped by source advisory. Each entry represents one advisory's assessment of a vulnerability, including the affected version ranges, the fix version, and the remediation actions.
569+
properties:
570+
advisory:
571+
$ref: '#/components/schemas/AdvisoryInfo'
572+
status:
573+
type: string
574+
description: Advisory status for this purl (e.g. affected, fixed, not_affected)
575+
versionRanges:
576+
type: array
577+
description: Affected version ranges from this advisory
578+
items:
579+
$ref: '#/components/schemas/VersionRange'
580+
fixedIn:
581+
type: string
582+
description: Fix version from this advisory
583+
remediations:
584+
type: array
585+
description: Remediation actions from this advisory
586+
items:
587+
$ref: '#/components/schemas/RemediationInfo'
571588
RemediationInfo:
572589
type: object
573-
description: Detailed remediation information from a vulnerability advisory
590+
description: A single remediation action from a vulnerability advisory
574591
properties:
575592
category:
576593
$ref: '#/components/schemas/RemediationCategory'
@@ -581,8 +598,6 @@ components:
581598
type: string
582599
format: uri
583600
description: URL with more information about the remediation
584-
advisory:
585-
$ref: '#/components/schemas/AdvisoryInfo'
586601
AdvisoryInfo:
587602
type: object
588603
description: Source advisory attribution for a remediation

0 commit comments

Comments
 (0)