Skip to content

Commit bb4f5a7

Browse files
committed
feat: synchronizes fields of TEA Component Release
Synchronizes the fields of the TEA Component Release between the OpenSpec and Markdown documents. Signed-off-by: Piotr P. Karwasz <piotr@github.copernik.eu>
1 parent 61b9cf9 commit bb4f5a7

2 files changed

Lines changed: 21 additions & 13 deletions

File tree

spec/openapi.yaml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -340,14 +340,19 @@ components:
340340
type: object
341341
properties:
342342
uuid:
343+
description: A unique identifier for the TEA Component Release
343344
"$ref": "#/components/schemas/uuid"
344345
version:
346+
description: Version number
345347
type: string
346348
release_date:
349+
description: Timestamp of the release (for sorting purposes)
347350
"$ref": "#/components/schemas/date-time"
348351
pre_release:
349352
type: boolean
350-
description: Marks if the version is a pre-release version
353+
description: |
354+
A flag indicating pre-release (or beta) status.
355+
May be disabled after the creation of the release object, but can't be enabled after creation of an object.
351356
identifiers:
352357
type: array
353358
description: List of identifiers for the component

tea-collection/tea-collection.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,21 @@
22

33
## The TEA release object (TRO)
44

5-
The TEA Component Release object is a list of releases (versions) of a component
6-
with a release identifier (string), release timestamp and a lifecycle
7-
enumeration for the release. Each release includes a UUID of a
8-
TEA Collection object (TCO).
9-
10-
* UUID: Release UUID
11-
* Version: Version (string)
12-
* Date: Timestamp of release (for sorting releases)
13-
* Prerelease: A flag indicating pre-release (or beta) status. May be disabled
14-
after creation of release object, but can't be enabled after creation of
15-
an object.
16-
* Lifecycle: An identifier indicating lifecycle status of a release
5+
The TEA Component Release object corresponds to a specific variant
6+
(version and packaging) of a component with a release identifier (string),
7+
release timestamp and a lifecycle enumeration for the release.
8+
The UUID of the TEA Component Release object matches the UUID of the associated TEA Collection objects (TCO).
9+
10+
A TEA Component Release object has the following parts:
11+
12+
- __uuid__: A unique identifier for the TEA Component Release
13+
- __version__: Version number
14+
- __release_date__: Timestamp of the release (for sorting purposes)
15+
- __pre_release__: A flag indicating pre-release (or beta) status.
16+
May be disabled after the creation of the release object, but can't be enabled after creation of an object.
17+
- __identifiers__: List of identifiers for the component
18+
- __idType__: Type of identifier, e.g. `tei`, `purl`, `cpe`
19+
- __idValue__: Identifier value
1720

1821
## The TEA Collection object (TCO)
1922

0 commit comments

Comments
 (0)