Merge pull request #103 from oej/update-prod

Update the product definition

Author: oej

tea-index/tea-index.md

@@ -1,13 +1,21 @@
-# The TEA index API
+# The TEA product API
 
-After TEA discovery, a user has a URL to the TEA index which will provide
-an entrypoint in the Transparency Exchange API where a list of all
-versions of a product can be found
+After TEA discovery, a user has a URL to the TEA product API where
+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.
+- For a composed product consisting of a bundle, the response
+  will be multiple TEA LEAF objects.
+
+In addition, all known TEIs for the product will be returned,
+in order for a TEA client to avoid duplication.
 
 ## Authorization
 
 Authorization can be done on multiple levels, including
-which versions is supported for a specific user.
+which products and versions are supported for a specific user.
 
 ## Composite products
 
@@ -19,7 +27,18 @@ and include pointers (URLs) to the TEA index for these.
 The URL can be to a different vendor or different site with the
 same vendor.
 
-## TEA index structure
+## TEA Product object
+
+- __uuid__: A unique identifier for this product
+- __name__: Product name in clear text (str)
+- __identifiers__: A list of TEIs that apply to this product
+   - __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
+
+The TEA LEAF UUID is used in the LEAF API to find out which versions
+of the LEAF 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
@@ -39,21 +58,7 @@ An automated system may want to provide the user with a GUI,
 listing versions and being able to scroll to the next page
 until the user selects a version.
 
-### Content of the index object
-
-* UUID
-* Identifier (name)
-* Version tag
-* Metadata
-  * CLE, Common lifecycle enumeration
-    * Note: This product version is no longer supported
-    * Status: Beta, prod, deprecate?
-    * Release date (in the CLE)
-* Key-value tags
-  * Defined in API
-  * TBD: Do we allow Vendor extensions?
-
-### Tea API operation - index files
+### Tea API operation
 
 * Recommendation: Support HTTP compression
 * Recommendation: HTTP content negotiation
@@ -63,7 +68,4 @@ until the user selects a version.
   * start page
   * Default value defined
 
-### Tea API definition
 
-The API will be defined in an OpenAPI format, specifying
-methods, objects and responses.