Skip to content

Commit 89a1a7c

Browse files
committed
Add flow with search capability
Signed-off-by: Olle E. Johansson <oej@edvina.net>
1 parent 9391885 commit 89a1a7c

1 file changed

Lines changed: 39 additions & 1 deletion

File tree

api-flow/consumer.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The standard TEI points to a product.
1717

1818
The user has to know product TEI and version of each component (TEA Component) to find the list of artefacts for the used version.
1919

20-
## API flow
20+
## API flow based on TEI discovery
2121

2222
```mermaid
2323
@@ -52,4 +52,42 @@ sequenceDiagram
5252
5353
5454
55+
```
56+
57+
## API flow based on direct access to API
58+
59+
In this case, the client wants to search for a specific product using the API
60+
61+
```mermaid
62+
63+
---
64+
title: TEA client flow with search
65+
---
66+
67+
sequenceDiagram
68+
autonumber
69+
actor user
70+
71+
participant tea_product as TEA Product
72+
participant tea_component as TEA Component
73+
participant tea_collection as TEA Collection
74+
participant tea_artifact as TEA Artefact
75+
76+
77+
user ->> tea_product: Search for product based on identifier (CPE, PURL, name)
78+
tea_product ->> user: List of products
79+
80+
user ->> tea_product: Finding all product parts (TEA Components) and facts about choosen product
81+
tea_product ->> user: List of product parts
82+
83+
user ->> tea_component: Finding all versions of a TEA Component
84+
tea_component ->> user: List of all available versions (paginated)
85+
86+
user ->> tea_collection: Finding all artefacts for version in scope
87+
tea_collection ->> user: List of artefacts and formats available for each artefact
88+
89+
user ->> tea_artifact: Download artefact
90+
91+
92+
5593
```

0 commit comments

Comments
 (0)