Merge pull request #120 from oej/from-leaf-to-component

Renaming TEA LEAF to TEA COMPONENT

Author: oej

README.md

@@ -40,7 +40,7 @@ The working group has produced a list of use cases and requirements for the prot
 ## Data model
 
 - [TEA Product index](tea-index/tea-index.md): This is the starting point. A "product" is something for sale. The [Transparency Exchange Identifier, TEI](/discovery/readme.md) points to a single product.
-- [TEA Leaf index](tea-leaf/tea-leaf.md): A leaf is a version entry. The leaf index has one entry per version of the product.
+- [TEA Component index](tea-component/tea-component.md): A Component index is a version entry. The Component version index has one entry per version of the product.
 - [TEA Collection](tea-collection/tea-collection.md): The collection is a list of artefacts for a specific version. The collection can be dynamic or static, depending on the implemenation.
 
 ## Artefacts available of the API

api-flow/consumer.md

@@ -8,12 +8,12 @@ described in the [discovery document](/discovery/readme.md).
 
 The standard TEI points to a product.
 
-- __List of TEA leafs__: Leafs are components of something sold. Each leaf has it's own versioning and it's own set of artefacts. Note that a single artefact can belong to multiple versions of a leaf and multiple leafs.
-- __List of TEA collections__: For each leaf, 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.
+- __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.
+- __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.
 - __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.
 - __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 LEAF) to find the list of artefacts for the used version.
+The user has to know product TEI and version of each component (TEA Component) to find the list of artefacts for the used version.
 
 ## API flow
 
@@ -29,7 +29,7 @@ sequenceDiagram
     participant discovery as TEA Discovery with TEI
 
     participant tea_product as TEA Product
-    participant tea_leaf as TEA Leaf
+    participant tea_component as TEA Component
     participant tea_collection as TEA Collection
     participant tea_artifact as TEA Artefact
 
@@ -40,8 +40,8 @@ sequenceDiagram
     user ->> tea_product: Finding all product parts
     tea_product ->> user: List of product parts
 
-    user ->> tea_leaf: Finding all versions of a part
-    tea_leaf ->> user: List of all available versions (paginated)
+    user ->> tea_component: Finding all versions of a part
+    tea_component ->> user: List of all available versions (paginated)
 
     user ->> tea_collection: Finding all artefacts for version in scope
     tea_collection ->> user: List of artefacts and formats available for each artefact

api-flow/publisher.md

@@ -8,16 +8,16 @@ sequenceDiagram
     autonumber
     actor Vendor
     participant tea_product as TEA Product
-    participant tea_leaf as TEA Leaf
+    participant tea_component as TEA Component
     participant tea_collection as TEA Collection
 
     Vendor ->> tea_product: POST to /v1/product to create new product
     tea_product -->> Vendor: Product is created and TEA Product Identifier (PI) returned
 
-    Vendor ->> tea_leaf: POST to /v1/leaf with the TEA PI and leaf version as the payload
-    tea_leaf ->> Vendor: Leaf is created and a TEA Leaf ID is returned
+    Vendor ->> tea_component: POST to /v1/component with the TEA PI and component version as the payload
+    tea_component ->> Vendor: Component is created and a TEA Component ID is returned
 
-    Vendor ->> tea_collection: POST to /v1/collection with the TEA Leaf ID as the and the artifact as payload
+    Vendor ->> tea_collection: POST to /v1/collection with the TEA Component ID as the and the artifact as payload
     tea_collection ->> Vendor: Collection is created with the collection ID returned
 
 ```
@@ -29,16 +29,16 @@ sequenceDiagram
     autonumber
     actor Vendor
     participant tea_product as TEA Product
-    participant tea_leaf as TEA Leaf
+    participant tea_component as TEA Component
     participant tea_collection as TEA Collection
 
-    Note over Vendor,tea_leaf: Create new release
+    Note over Vendor,tea_component: Create new release
 
-    Vendor ->> tea_leaf: POST to /v1/leaf with the TEA PI and leaf version as the payload
-    tea_leaf ->> Vendor: Leaf is created and a TEA Leaf ID is returned
+    Vendor ->> tea_component: POST to /v1/component with the TEA PI and component version as the payload
+    tea_component ->> Vendor: Component is created and a TEA Component ID is returned
 
-    Note over Vendor,TEA Leaf: Add an artifact (e.g. SBOM)
-    Vendor ->> tea_collection: POST to /v1/collection with the TEA Leaf ID as the and the artifact as payload
+    Note over Vendor,TEA Component: Add an artifact (e.g. SBOM)
+    Vendor ->> tea_collection: POST to /v1/collection with the TEA Component ID as the and the artifact as payload
     tea_collection ->> Vendor: Collection is created with the collection ID returned
 
 ```
@@ -50,12 +50,12 @@ sequenceDiagram
     autonumber
     actor Vendor
     participant tea_product as TEA Product
-    participant tea_leaf as TEA Leaf
+    participant tea_component as TEA Component
     participant tea_collection as TEA Collection
 
-    Vendor ->> tea_leaf: GET to /v1/leaf with the TEA PI to get the latest version
-    tea_leaf ->> Vendor: Leaf will be returned
+    Vendor ->> tea_component: GET to /v1/component with the TEA PI to get the latest version
+    tea_component ->> Vendor: Component will be returned
 
-    Vendor ->> tea_collection: POST to /v1/collection with the TEA Leaf ID as the and the artifact as payload
+    Vendor ->> tea_collection: POST to /v1/collection with the TEA Component ID as the and the artifact as payload
     tea_collection ->> Vendor: Collection is created with the collection ID returned
 ```

tea-leaf/tea-leaf.md tea-component/tea-component.mdtea-leaf/tea-leaf.md renamed to tea-component/tea-component.md

@@ -1,18 +1,25 @@
-# The TEA Leaf Object (TLO)
+# The TEA Component Index Object (TCO)
 
-The TEA LEAF is the object that indicates a product version. The API should be
-very agnostic as to how a "version" is indicated - semver, vers, name, hash or anything else.
+The TEA COMPONENT INDEX is the object that indicates a product component. The product may
+be constructed with one or multiple Tea Components, each with their own set of
+related artefacts.
+
+For each TEA COMPONENT there is a TEA COMPONENT INDEX, which is a list of all versions
+for that component.
+
+The API should be very agnostic as to how a "version" is indicated - semver, vers,
+name, hash or anything else.
 
 ## Major and minor versions
 
-Each leaf is for a sub-version or minor version (using semver definitions). A new
+Each component is for a sub-version or minor version (using semver definitions). A new
 major version counts as a new product with a separate product object (TPO). Each
 product object has one or multiple TEI URNs.
 
 For the API to be able to present a list of versions in a cronological order,
 a timestamp for a release is required.
 
-## The Leaf Object
+## The Tea Component Object
 
 - __Uuid__ unique for this object
 - __Product name__: A text field
@@ -21,17 +28,20 @@ a timestamp for a release is required.
 - __Pre-release__: A boolean flag indicating a pre-release (beta, rc)
 - __Tco_uuid__: A reference to the TEA Collection objet for this release
 
+Note: In coming versions, there may be a flag indicating lifecycle status
+for a component.
+
 ## Handling the Pre-Release flag
 
 The "Pre-release" flag is used to indicate that this is not a final release.
-For a given Leaf with a UUID, the flag can be set to indicate a "test", "beta", "alpha"
-or similar non-deployed release. It can only be set when creating the LEAF. The TEA implementation
-may allow it to be unset (False) once. This is to support
+For a given Component with a UUID, the flag can be set to indicate a "test", "beta", "alpha"
+or similar non-deployed release. It can only be set when creating the Component.
+The TEA implementation may allow it to be unset (False) once. This is to support
 situations where a object is promoted as is after testing to production version. The flag can not
-be set after initial creation and publication of the leaf.
+be set after initial creation and publication of the Component.
 
 If the final version is different from the pre-release (bugs fixed, code changed, different binary)
-a new leaf with a new UUID and version needs to be created.
+a new Component with a new UUID and version needs to be created.
 
 ## References
 

tea-index/tea-index.md

@@ -5,9 +5,9 @@ the TEI is used to query for data. The TEI marks the product sold,
 which can be a single unit or multiple units in a bundle.
 
 - For a single product, the output will be metadata about the
-  product and a TEA LEAF object.
+  product and a TEA COMPONENT object.
 - For a composed product consisting of a bundle, the response
-  will be multiple TEA LEAF objects.
+  will be multiple TEA COMPONENT objects.
 
 In addition, all known TEIs for the product will be returned,
 in order for a TEA client to avoid duplication.
@@ -35,10 +35,10 @@ same vendor.
    - __type__: Type of identifier - one of "tei", "purl", or "cpe"
    - __id__: The complete identifier (str)
 - __leaves__: A list of product leaves
-   - __uuid__: TEA LEAF UUID
+   - __uuid__: TEA COMPONENT UUID
 
-The TEA LEAF UUID is used in the LEAF API to find out which versions
-of the LEAF that exists.
+The TEA Component UUID is used in the Component API to find out which versions
+of the Component that exists.
 
 The goal of the TEA index is to provide a selection of product
 versions to assist the user software in finding a match for the