Skip to content

Commit ba1e5d8

Browse files
authored
Merge pull request #209 from taleodor/2025-11-advance-to-beta-2
Advance TEA to Beta 2
2 parents 1ae8c88 + faa235d commit ba1e5d8

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

README.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,10 @@ formed - TC54 TG1. The working group has a slack channel in the CycloneDX slack
1414

1515
![](images/tealogo.png)
1616

17-
## Status of the standard: Beta 1
17+
## Status of the standard: Beta 2
1818

19-
TEA is now in beta 1. This beta focuses on the consumer side of the API. Work on the
20-
publisher API will start after the beta. The idea is to get implementation feedback
21-
early on the current specification in order to move forward towards a first official
22-
version of the standard. Feedback will be gathered in the Hackathon at OWASP AppSec
23-
Global in Barcelona May 28 as well as in the meetings and slack channel.
19+
TEA is now in beta 2. This beta focuses on ready-to-implement consumer side of the API. Work on the
20+
publisher API will start after the 1.0 release.
2421

2522
We encourage developers to start with both client and server implementations of TEA and
2623
participate in interoperability tests. These will be organised both as hackathons and
@@ -29,19 +26,25 @@ informally using the Slack channel.
2926
There will likely be multiple beta releases. We will announce these by adding new
3027
tags in the repository as well as in the slack channel.
3128

29+
Priority issues for Beta 3:
30+
- Refinement of distribution types and distributionType fields, see https://github.com/CycloneDX/transparency-exchange-api/issues/198
31+
- CLE Spec needs to be integrated in TEA
32+
- E2e poc of authn/z workflow with TEA consumer spec, including consumer spec adjustment to better support authn/z
33+
- Compliance document workflow, see https://github.com/CycloneDX/transparency-exchange-api/issues/205
34+
3235
## Introduction
3336

3437
This specification defines a standard, format agnostic, API for the exchange of
35-
product related artifacts, like BOMs, between systems. The work includes:
38+
product related artefacts, like BOMs, between systems. The work includes:
3639

3740
- [Discovery of servers](/discovery/readme.md): Describes discovery using the Transparency Exchange Identifier (TEI)
38-
- Retrieval of artifacts
39-
- Publication of artifacts
41+
- Retrieval of artefacts
42+
- Publication of artefacts
4043
- Authentication and authorization
4144
- Querying
4245

4346
System and tooling implementors are encouraged to adopt this API standard for
44-
sending/receiving transparency artifacts between systems.
47+
sending/receiving transparency artefacts between systems.
4548
This will enable more widespread
4649
"out of the box" integration support in the BOM ecosystem.
4750

@@ -56,13 +59,13 @@ The working group has produced a list of use cases and requirements for the prot
5659
- [TEA Product Release](tea-product/tea-product-release.md): The primary entry point. The [Transparency Exchange Identifier, TEI](/discovery/readme.md) resolves to a specific Product Release. A Product Release may optionally belong to a [TEA Product](tea-product/tea-product.md).
5760
- [TEA Product](tea-product/tea-product.md): An optional higher-level object that groups a set of Product Releases for a product line or family. Products can be discovered and browsed; releases are accessed via `/product/{uuid}/releases`.
5861
- [TEA Component](tea-component/tea-component.md): Represents a component lineage. A Component is a collection of Component Releases (accessible via `/component/{uuid}/releases`).
59-
- [TEA Release](/tea-component/tea-release.md: A Component Release object. Each Component Release may have its own TEA Collection.
62+
- [TEA Release](/tea-component/tea-release.md): A Component Release object. Each Component Release may have its own TEA Collection.
6063
- [TEA Collection](tea-collection/tea-collection.md): A versioned list of artefacts for a specific Release (Component Release) or Product Release. Collections are versioned to indicate changes, e.g., an updated VEX or corrected SBOM.
61-
- [TEA Artefacts](tea-artifact/tea-artifact.md): Files associated with a Collection. A single Artefact can appear in multiple Collections.
64+
- [TEA Artifacts](tea-artifact/tea-artifact.md): Files associated with a Collection. A single TEA Artifact can appear in multiple Collections. Note that a TEA Artifact is a named term introduced by the TEA standard.
6265

63-
## artifacts available of the API
66+
## Artefacts available of the API
6467

65-
The Transparency Exchange API (TEA) supports publication and retrieval of a set of transparency exchange artifacts. The API itself should not be restricting the types of the artifacts. A few examples:
68+
The Transparency Exchange API (TEA) supports publication and retrieval of a set of transparency exchange artefacts. The API itself should not be restricting the types of the artefacts. A few examples:
6669

6770
### xBOM
6871

0 commit comments

Comments
 (0)