Skip to content

Commit b21b25c

Browse files
committed
Improves documentation further
2 parents 4d7a13c + cba8d69 commit b21b25c

2 files changed

Lines changed: 25 additions & 17 deletions

File tree

doc/tea-implementations.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,38 +6,46 @@
66

77
A Python client library and CLI client for TEA.
88

9-
* [GitHub](https://github.com/sbomify/py-libtea)
9+
- [GitHub](https://github.com/sbomify/py-libtea)
1010

1111
### PyPi TEA
1212

1313
A TEA bridge for accessing Python SBOMs from PyPi (via [PEP 770](https://peps.python.org/pep-0770/)).
1414

15-
* [GitHub](https://github.com/sbomify/pypi-tea)
15+
- [GitHub](https://github.com/sbomify/pypi-tea)
1616

17-
### Rearm CLI
17+
### ReARM CLI
1818

19-
The REARM cli supports TEA.
19+
The ReARM CLI supports TEA.
2020

21-
* [Documentation](https://github.com/relizaio/rearm-cli/blob/main/docs/tea.md)
22-
* [GitHub](https://github.com/relizaio/rearm-cli)
21+
- [Documentation](https://github.com/relizaio/rearm-cli/blob/main/docs/tea.md)
22+
- [GitHub](https://github.com/relizaio/rearm-cli)
2323

2424
## Open Source Servers
2525

2626
### Oolong
2727

2828
This project is a lightweight implementation of Transparency Exchange API which uses NestJS framework.
2929

30-
* [GitHub](https://github.com/relizaio/oolong)
30+
- [GitHub](https://github.com/relizaio/oolong)
31+
32+
### ReARM
33+
34+
ReARM is a Release-Level Supply Chain Evidence Platform. It supports TEA for standardized discovery and retrieval of SBOMs and other security artefacts.
35+
36+
- [Documentation](https://docs.rearmhq.com/tea/)
37+
- [GitHub](https://github.com/relizaio/rearm)
3138

3239
### sbomify
3340

34-
sbomify is a Software Bill of Materials (SBOM) and document management platform that can be self-hosted or accessed through https://app.sbomify.com. The platform provides a centralized location to upload and manage your SBOMs and related documentation, allowing you to share them with stakeholders or make them publicly accessible.
41+
sbomify is a Software Bill of Materials (SBOM) and document management platform that can be self-hosted or accessed through [app.sbomify.com](https://app.sbomify.com). The platform provides a centralized location to upload and manage your SBOMs and related documentation, allowing you to share them with stakeholders or make them publicly accessible.
3542

36-
* Implements the Transparency Exchange API
37-
* Standardized SBOM discovery via .well-known/tea endpoints
38-
* Enables automated discovery and retrieval of SBOMs across the supply chain
43+
- Implements the Transparency Exchange API
44+
- Standardized SBOM discovery via .well-known/tea endpoints
45+
- Enables automated discovery and retrieval of SBOMs across the supply chain
3946

40-
* [GitHub](https://github.com/sbomify/sbomify)
47+
- [Documentation](https://sbomify.com/faq/how-do-i-enable-tea-in-sbomify/)
48+
- [GitHub](https://github.com/sbomify/sbomify)
4149

4250
## Other implementations
4351

spec/openapi.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ info:
1212
license:
1313
name: Apache 2.0
1414
url: https://github.com/CycloneDX/transparency-exchange-api/blob/main/LICENSE
15-
version: 0.4.0-beta.3
15+
version: 0.4.0
1616
servers:
1717
- url: http://localhost/tea/v1
1818
description: Local development
@@ -265,7 +265,7 @@ paths:
265265
'404':
266266
$ref: "#/components/responses/404-object-by-id-not-found"
267267
tags:
268-
- TEA Component Release
268+
- TEA Component Release
269269
/componentRelease/{uuid}/cle:
270270
get:
271271
description: Get the CLE (Common Lifecycle Enumeration) data for a TEA Component Release
@@ -660,7 +660,7 @@ components:
660660

661661
#
662662
# Reference to a component, in some cases directly to a specific release
663-
#
663+
#
664664
# The release reference (release UUID) is only used in cases where a product
665665
# name includes a version and this version of the product always includes
666666
# the same releases of the component.
@@ -1363,7 +1363,7 @@ components:
13631363
- pageStartIndex
13641364
- pageSize
13651365
- totalResults
1366-
1366+
13671367
paginated-product-response:
13681368
type: object
13691369
description: A paginated response containing TEA Products
@@ -1375,7 +1375,7 @@ components:
13751375
type: array
13761376
items:
13771377
$ref: "#/components/schemas/product"
1378-
1378+
13791379
paginated-product-release-response:
13801380
type: object
13811381
description: A paginated response containing TEA Product Releases

0 commit comments

Comments
 (0)