Skip to content

Commit e62880d

Browse files
committed
Updating the tea-product documentation
Signed-off-by: Olle E. Johansson <[email protected]>
1 parent 9bca142 commit e62880d

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

tea-product/tea-product.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ which can be a single unit or multiple units in a bundle.
1010
will be multiple TEA COMPONENT objects.
1111

1212
In addition, all known TEIs for the product will be returned,
13-
in order for a TEA client to avoid duplication.
13+
in order for a TEA client to avoid duplication. This list can
14+
also include known Package URLs (PURL) and CPEs for the product.
1415

1516
## Authorization
1617

@@ -20,9 +21,11 @@ which products and versions are supported for a specific user.
2021
## Composite products
2122

2223
If a product consists of a set of products, each with a different
23-
version number and update scheme, a TEA bundle will be the starting
24-
point of discovery. The TEA bundle will list all included parts
25-
and include pointers (URLs) to the TEA index for these.
24+
version number and update scheme, a TEA "bundle" will be the starting
25+
point of discovery. The TEA product will list all included components
26+
with the UUID of the TEA component. The reference list may also include
27+
a UUID of a specific release of a component in the case where a product
28+
always includes a single release of the component.
2629

2730
The URL can be to a different vendor or different site with the
2831
same vendor.
@@ -38,6 +41,7 @@ A TEA Product object has the following parts:
3841
- __idValue__: Identifier value
3942
- __components__: List of TEA components for the product
4043
- __uuid__: Unique identifier of the TEA component
44+
- __release__: Optional UUID of a TEA component release
4145

4246
The TEA Component UUID is used in the Component API to find out which versions
4347
of the Component that exists.
@@ -73,9 +77,9 @@ An example of a product consisting of an OSS project and all its Maven artifacts
7377
}
7478
],
7579
"components": [
76-
"3910e0fd-aff4-48d6-b75f-8bf6b84687f0",
77-
"b844c9bd-55d6-478c-af59-954a932b6ad3",
78-
"d6d3f754-d4f4-4672-b096-b994b064ca2d"
80+
{ "3910e0fd-aff4-48d6-b75f-8bf6b84687f0", },
81+
{ "b844c9bd-55d6-478c-af59-954a932b6ad3", },
82+
{ "d6d3f754-d4f4-4672-b096-b994b064ca2d", },
7983
]
8084
}
8185
```

0 commit comments

Comments
 (0)