Skip to content

Commit 9391885

Browse files
committed
Update the API flow
Signed-off-by: Olle E. Johansson <oej@edvina.net>
1 parent 410324b commit 9391885

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

api-flow/consumer.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,11 @@ described in the [discovery document](/discovery/readme.md).
88

99
The standard TEI points to a product.
1010

11-
- __List of TEA Components__: Components are components of something sold. Each Component has it's own versioning and it's own set of artefacts. Note that a single artefact can belong to multiple versions of a Component and multiple Components.
12-
- __List of TEA collections__: For each Component, there is a list of TEA collections as indicated by release date and a version string. The TEA API has no requirements of type of version string (semantic or any other scheme) - it's just an identifier set by the manufacturer. It's sorted by release date as a default.
13-
- __List of TEA artefacts__: The collection is unique for a version and contains a list of artefacts. This can be SBOM files, VEX, SCITT, IN-TOTO or other documents.
11+
- __TEA Product__: This is the delivered goods, an open source software, library or a product sold. It consists of one or multiple TEA Components.
12+
- __TEA Components__: Components are components of something sold. Each Component has it's own versioning and it's own set of artefacts. Note that a single artefact can belong to multiple versions of a Component and multiple Components.
13+
- __TEA Component index__: A list of all the versions available for a TEA Component
14+
- __TEA Collection__: For each Component version, there is TEA collection as indicated by release date and a version string. The TEA API has no requirements of type of version string (semantic or any other scheme) - it's just an identifier set by the manufacturer. It's sorted by release date as a default.
15+
- __List of TEA artefacts__: The TEA Collection is unique for a version and contains a list of artefacts. This can be SBOM files, VEX, SCITT, IN-TOTO or other documents.
1416
- __List of artefact formats__: An artefact can be published in multiple formats.
1517

1618
The user has to know product TEI and version of each component (TEA Component) to find the list of artefacts for the used version.
@@ -37,10 +39,10 @@ sequenceDiagram
3739
user ->> discovery: Discovery using DNS
3840
discovery ->> user: List of API servers
3941
40-
user ->> tea_product: Finding all product parts
42+
user ->> tea_product: Finding all product parts (TEA Components) and facts about the product
4143
tea_product ->> user: List of product parts
4244
43-
user ->> tea_component: Finding all versions of a part
45+
user ->> tea_component: Finding all versions of a TEA Component
4446
tea_component ->> user: List of all available versions (paginated)
4547
4648
user ->> tea_collection: Finding all artefacts for version in scope

0 commit comments

Comments
 (0)