Merge pull request #125 from oej/update-more-flow

Update API-flow mermaid diagrams

Author: oej

api-flow/consumer.md

@@ -6,16 +6,23 @@ described in the [discovery document](/discovery/readme.md).
 
 ## API usage
 
-The standard TEI points to a product.
-
-- __TEA Product__: This is the delivered goods, an open source software, library or a product sold. It consists of one or multiple TEA Components.
-- __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.
-- __TEA Component index__: A list of all the versions available for a TEA Component
-- __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.
-- __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.
-- __List of artefact formats__: An artefact can be published in multiple formats.
-
-The user has to know product TEI and version of each component (TEA Component) to find the list of artefacts for the used version.
+The standard TEI points to a product. A product is something sold, downloaded as an opensource project or aquired
+by other means. It contains one or multiple components.
+
+- __List of TEA Components__: Components are components of something that is part of a product.
+  Each Component has it's own versioning and it's own set of artifacts.
+- __List of TEA releases__: Each component has a list of releases where each release has a timestamp and
+  a lifecycle enumeration. They are normally sorted by timestamps. 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.
+- __List of TEA collections__: For each release, there is a list of TEA collections as indicated
+  by release date and a version integer starting with collection version 1. 
+- __List of TEA artifacts__: The collection is unique for a version and contains a list of artifacts.
+  This can be SBOM files, VEX, SCITT, IN-TOTO or other documents.  Note that a single artifact
+  can belong to multiple versionsof a Component and multiple Components.
+- __List of artifact formats__: An artifact can be published in multiple formats.
+
+The user has to know product TEI and version of each component (TEA Component) to find the list of
+artifacts for the used version.
 
 ## API flow based on TEI discovery
 
@@ -32,6 +39,7 @@ sequenceDiagram
 
     participant tea_product as TEA Product
     participant tea_component as TEA Component
+    participant tea_release as TEA Release
     participant tea_collection as TEA Collection
     participant tea_artifact as TEA Artefact
 
@@ -42,13 +50,17 @@ sequenceDiagram
     user ->> tea_product: Finding all product parts (TEA Components) and facts about the product
     tea_product ->> user: List of product parts
 
-    user ->> tea_component: Finding all versions of a TEA Component
-    tea_component ->> user: List of all available versions (paginated)
+    user ->> tea_component: Finding information of a component
+    tea_component ->> user: List of component metadata
+
+    user ->> tea_release: Finding a specific version/release
+    tea_release ->> user: List of releases and collection id for each release
 
     user ->> tea_collection: Finding all artefacts for version in scope
     tea_collection ->> user: List of artefacts and formats available for each artefact
 
-    user ->> tea_artifact: Download artefact
+    user ->> tea_artifact: Request to download artifact
+    tea_artifact ->> user: Artifact
 
 
 
@@ -70,6 +82,7 @@ sequenceDiagram
 
     participant tea_product as TEA Product
     participant tea_component as TEA Component
+    participant tea_release as TEA Release
     participant tea_collection as TEA Collection
     participant tea_artifact as TEA Artefact
 
@@ -80,13 +93,17 @@ sequenceDiagram
     user ->> tea_product: Finding all product parts (TEA Components) and facts about choosen product
     tea_product ->> user: List of product parts
 
-    user ->> tea_component: Finding all versions of a TEA Component
-    tea_component ->> user: List of all available versions (paginated)
+    user ->> tea_component: Finding information of a component
+    tea_component ->> user: List of component metadata
+
+    user ->> tea_release: Finding a specific version/release
+    tea_release ->> user: List of releases and collection id for each release
 
     user ->> tea_collection: Finding all artefacts for version in scope
     tea_collection ->> user: List of artefacts and formats available for each artefact
 
-    user ->> tea_artifact: Download artefact
+    user ->> tea_artifact: Request to download artifact
+    tea_artifact ->> user: Artifact