Skip to content

Commit 9bca142

Browse files
committed
Adding a "componentref" structure in the product definition
This is to be able to reference a specific release of a component in addition to referencing the component itself. Signed-off-by: Olle E. Johansson <[email protected]>
1 parent b3d81f6 commit 9bca142

File tree

1 file changed

+36
-7
lines changed

1 file changed

+36
-7
lines changed

spec/openapi.yaml

Lines changed: 36 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -266,14 +266,18 @@ components:
266266
description: Product name
267267
identifiers:
268268
type: array
269-
description: List of identifiers for the product
269+
description: |
270+
List of identifiers for the product, like TEI, CPE, PURL or other identifiers
270271
items:
271272
"$ref": "#/components/schemas/identifier"
272273
components:
273274
type: array
274-
description: List of TEA components for the product
275+
description: |
276+
List of TEA componentrefs for the product. The componentref by default just
277+
includes the UUID of the component, but in some cases also include a reference
278+
to the UUID of a specific release.
275279
items:
276-
description: Unique identifier of the TEA component
280+
description: Unique identifier of the TEA componentref
277281
"$ref": "#/components/schemas/uuid"
278282
required:
279283
- uuid
@@ -288,10 +292,6 @@ components:
288292
idValue: cpe:2.3:a:apache:log4j
289293
- idType: PURL
290294
idValue: pkg:maven/org.apache.logging.log4j/log4j-api
291-
- idType: PURL
292-
idValue: pkg:maven/org.apache.logging.log4j/log4j-core
293-
- idType: PURL
294-
idValue: pkg:maven/org.apache.logging.log4j/log4j-layout-template-json
295295
components:
296296
- 3910e0fd-aff4-48d6-b75f-8bf6b84687f0
297297
- b844c9bd-55d6-478c-af59-954a932b6ad3
@@ -334,6 +334,35 @@ components:
334334
- idType: PURL
335335
idValue: pkg:maven/org.apache.logging.log4j/log4j-core
336336

337+
#
338+
# Reference to a component, in some cases directly to a specific release
339+
#
340+
# The release reference (release UUID) is only used in cases where a product
341+
# name incldues a version and this version of the product always include
342+
# the same releases of the component.
343+
componentref:
344+
type: object
345+
description: A reference to a TEA component or specific component release
346+
properties:
347+
uuid:
348+
description: A unique identifier for the TEA component
349+
"$ref": "#/components/schemas/uuid"
350+
name:
351+
type: string
352+
description: Component name
353+
release:
354+
type: string
355+
description: |
356+
Optional UUID of a specific release included in the product in the case where the product
357+
always include a specific release of a component. The product name should include a version
358+
identifier in this case.
359+
items:
360+
"$ref": "#/components/schemas/uuid"
361+
required:
362+
- uuid
363+
364+
365+
337366
#
338367
# TEA Release and related objects
339368
#

0 commit comments

Comments
 (0)