Skip to content

Commit 45cd04a

Browse files
committed
docs: artifact - artefact in Readme
Signed-off-by: Pavel Shukhman <[email protected]>
1 parent 46ab211 commit 45cd04a

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 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 artifacts, like BOMs, between systems. The work includes:
35+
product related artefacts, 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 artifacts
39-
- Publication of artifacts
38+
- Retrieval of artefacts
39+
- Publication of artefacts
4040
- Authentication and authorization
4141
- Querying
4242

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

@@ -58,24 +58,24 @@ The working group has produced a list of use cases and requirements for the prot
5858
- [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`.
5959
- [TEA Component](tea-component/tea-component.md): Represents a component lineage. A Component is a collection of Component Releases (accessible via `/component/{uuid}/releases`).
6060
- [TEA Release](/tea-component/tea-release.md: A Component Release object. Each Component Release may have its own TEA Collection.
61-
- [TEA Collection](tea-collection/tea-collection.md): A versioned list of artifacts for a specific Release (Component Release) or Product Release. Collections are versioned to indicate changes, e.g., an updated VEX or corrected SBOM.
62-
- [TEA Artifacts](tea-artifact/tea-artifact.md): Files associated with a Collection. A single Artifact can appear in multiple Collections.
61+
- [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.
62+
- [TEA Artefacts](tea-artifact/tea-artifact.md): Files associated with a Collection. A single Artefact can appear in multiple Collections.
6363

64-
## artifacts available of the API
64+
## Artefacts available of the API
6565

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

6868
### xBOM
6969

70-
Bill of materials for any type of component and service are supported. This includes, but is not limited to, SBOM, HBOM, AI/ML-BOM, SaaSBOM, and CBOM. The API provides a BOM format agnostic way of publishing, searching, and retrieval of xBOM artifacts.
70+
Bill of materials for any type of component and service are supported. This includes, but is not limited to, SBOM, HBOM, AI/ML-BOM, SaaSBOM, and CBOM. The API provides a BOM format agnostic way of publishing, searching, and retrieval of xBOM artefacts.
7171

7272
### CDXA
7373

74-
Standards and requirements along with attestations to those standards and requirements are captured and supported by CycloneDX Attestations (CDXA). Much like xBOM, these are supply chain artifacts that are captured allowing for consistent publishing, searching, and retrieval.
74+
Standards and requirements along with attestations to those standards and requirements are captured and supported by CycloneDX Attestations (CDXA). Much like xBOM, these are supply chain artefacts that are captured allowing for consistent publishing, searching, and retrieval.
7575

7676
### VDR/VEX
7777

78-
Vulnerability Disclosure Reports (VDR) and Vulnerability Exploitability eXchange (VEX) are supported artifact types. Like the xBOM element, the VDR/VEX support is format agnostic. However, CSAF has its own distribution requirements that may not be compatible with APIs. Therefore, the initial focus will be on CycloneDX (VDR and VEX) and OpenVEX.
78+
Vulnerability Disclosure Reports (VDR) and Vulnerability Exploitability eXchange (VEX) are supported artefact types. Like the xBOM element, the VDR/VEX support is format agnostic. However, CSAF has its own distribution requirements that may not be compatible with APIs. Therefore, the initial focus will be on CycloneDX (VDR and VEX) and OpenVEX.
7979

8080
### CLE
8181

@@ -105,7 +105,7 @@ Contributors are listed in the [Contributors](contributors.md) file.
105105
- API: Application programming interface
106106
- Authorization (authz):
107107
- Authentication (authn):
108-
- Collection: A set of artifacts representing a version of a product
108+
- Collection: A set of artefacts representing a version of a product
109109
- Product: An item sold or delivered under one name
110110
- Product variant: A variant of a product
111111
- Version:

0 commit comments

Comments
 (0)