Skip to content

Commit 76000b1

Browse files
committed
feat: examples of TEA Collection Release objects
Adds examples of TEA Collection Release objects, based on Apache Tomcat packages. Signed-off-by: Piotr P. Karwasz <piotr@github.copernik.eu>
1 parent bb4f5a7 commit 76000b1

File tree

2 files changed

+101
-0
lines changed

2 files changed

+101
-0
lines changed

spec/openapi.yaml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -363,6 +363,38 @@ components:
363363
- uuid
364364
- version
365365
- release_date
366+
examples:
367+
# Apache Tomcat 11.0.6
368+
- uuid: 605d0ecb-1057-40e4-9abf-c400b10f0345
369+
version: "11.0.6"
370+
release_date: 2025-04-01T15:43:00Z
371+
identifiers:
372+
- idType: purl
373+
idValue: pkg:maven/org.apache.maven/maven@11.0.6?type=zip
374+
# Different packaging of Apache Tomcat 11.0.6
375+
# Will have slightly different SBOM
376+
- uuid: a9570065-9fc6-4d35-97b4-4bc67d68dbcd
377+
version: "11.0.6"
378+
release_date: 2025-04-01T15:43:00Z
379+
identifiers:
380+
- idType: purl
381+
idValue: pkg:maven/org.apache.maven/maven@11.0.6?classifier=windows-x64&type=zip
382+
# Different release of Apache Tomcat
383+
- uuid: da89e38e-95e7-44ca-aa7d-f3b6b34c7fab
384+
version: "10.1.40"
385+
release_date: 2025-04-01T18:20:00Z
386+
identifiers:
387+
- idType: purl
388+
idValue: pkg:maven/org.apache.maven/maven@10.1.40?type=zip
389+
# A pre-release of Apache Tomcat
390+
- uuid: 95f481df-f760-47f4-b2f2-f8b76d858450
391+
version: "11.0.0-M26"
392+
release_date: 2024-09-13T17:49:00Z
393+
pre_release: true
394+
identifiers:
395+
- idType: purl
396+
idValue: pkg:maven/org.apache.maven/maven@11.0.0-M26?type=zip
397+
366398
#
367399
# TEA Collection and related objects
368400
#

tea-collection/tea-collection.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,75 @@ A TEA Component Release object has the following parts:
1818
- __idType__: Type of identifier, e.g. `tei`, `purl`, `cpe`
1919
- __idValue__: Identifier value
2020

21+
### Examples
22+
23+
A TEA Component Release object of the binary distribution of Apache Tomcat 11.0.6 will look like:
24+
25+
```json
26+
{
27+
"uuid": "605d0ecb-1057-40e4-9abf-c400b10f0345",
28+
"version": "11.0.6",
29+
"release_date": "2025-04-01T15:43:00Z",
30+
"identifiers": [
31+
{
32+
"idType": "purl",
33+
"idValue": "pkg:maven/org.apache.maven/maven@11.0.6?type=zip"
34+
}
35+
]
36+
}
37+
```
38+
39+
The binary distribution for Windows should have a separate TEA Component Release object,
40+
because the associated TEA Collections might differ:
41+
42+
```json
43+
{
44+
"uuid": "a9570065-9fc6-4d35-97b4-4bc67d68dbcd",
45+
"version": "11.0.6",
46+
"release_date": "2025-04-01T15:43:00Z",
47+
"identifiers": [
48+
{
49+
"idType": "purl",
50+
"idValue": "pkg:maven/org.apache.maven/maven@11.0.6?classifier=windows-x64&type=zip"
51+
}
52+
]
53+
}
54+
```
55+
56+
Different versions of Apache Tomcat should have separate TEA Component Release objects:
57+
58+
```json
59+
{
60+
"uuid": "da89e38e-95e7-44ca-aa7d-f3b6b34c7fab",
61+
"version": "10.1.4",
62+
"release_date": "2025-04-01T18:20:00Z",
63+
"identifiers": [
64+
{
65+
"idType": "purl",
66+
"idValue": "pkg:maven/org.apache.maven/maven@10.1.4?type=zip"
67+
}
68+
]
69+
}
70+
```
71+
72+
The pre-release flag is used to mark versions not production ready
73+
and does not require users to know the version naming scheme adopted by the project.
74+
75+
```json
76+
{
77+
"uuid": "95f481df-f760-47f4-b2f2-f8b76d858450",
78+
"version": "11.0.0-M26",
79+
"release_date": "2024-09-13T17:49:00Z",
80+
"pre_release": true,
81+
"identifiers": [
82+
{
83+
"idType": "purl",
84+
"idValue": "pkg:maven/org.apache.maven/maven@11.0.0-M26?type=zip"
85+
}
86+
]
87+
}
88+
```
89+
2190
## The TEA Collection object (TCO)
2291

2392
For each product and version there is a Tea Collection object, which is a list

0 commit comments

Comments
 (0)