Skip to content

Commit 3939cd4

Browse files
authored
Merge branch 'main' into 2025-08-add-product-release-on-pr-186
Signed-off-by: Pavel Shukhman <[email protected]>
2 parents 45cd04a + 4142a03 commit 3939cd4

File tree

3 files changed

+7
-8
lines changed

3 files changed

+7
-8
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,16 @@ tags in the repository as well as in the slack channel.
3232
## Introduction
3333

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

3737
- [Discovery of servers](/discovery/readme.md): Describes discovery using the Transparency Exchange Identifier (TEI)
38-
- Retrieval of artefacts
39-
- Publication of artefacts
38+
- Retrieval of artifacts
39+
- Publication of artifacts
4040
- Authentication and authorization
4141
- Querying
4242

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

@@ -53,17 +53,16 @@ The working group has produced a list of use cases and requirements for the prot
5353
- [TEA use cases](doc/tea-usecases.md)
5454

5555
## Data model
56-
5756
- [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).
5857
- [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`.
5958
- [TEA Component](tea-component/tea-component.md): Represents a component lineage. A Component is a collection of Component Releases (accessible via `/component/{uuid}/releases`).
6059
- [TEA Release](/tea-component/tea-release.md: A Component Release object. Each Component Release may have its own TEA Collection.
6160
- [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.
6261
- [TEA Artefacts](tea-artifact/tea-artifact.md): Files associated with a Collection. A single Artefact can appear in multiple Collections.
6362

64-
## Artefacts available of the API
63+
## artifacts available of the API
6564

66-
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:
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:
6766

6867
### xBOM
6968

spec/openapi.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -423,7 +423,6 @@ components:
423423
idValue: cpe:2.3:a:apache:log4j
424424
- idType: PURL
425425
idValue: pkg:maven/org.apache.logging.log4j/log4j-api
426-
427426
#
428427
# TEA Product Release
429428
#

tea-product/tea-product.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ which products and versions are supported for a specific user.
2020

2121
A TEA Product Release will be the starting
2222
point of discovery. The TEA product release will list all included components
23+
2324
with the UUID of the TEA component. The reference list may also include
2425
a UUID of a specific release of a component in the case where a product
2526
always includes a single release of the component.

0 commit comments

Comments
 (0)