Skip to content

tea-component.md

Latest commit

 

History

History
82 lines (63 loc) · 2.44 KB

tea-component.md

File metadata and controls

82 lines (63 loc) · 2.44 KB

The TEA Component API

The TEA Component represents a component lineage. A product release may be constructed with one or multiple TEA Components, each with their own set of releases and related artefacts.

Each TEA Component has a list of Component Releases (see /component/{uuid}/releases), which enumerates all known versions for that component.

The API should be very agnostic as to how a "version" is indicated - semver, vers, name, hash or anything else.

Versions and TEIs

Each product object has one or multiple TEI URNs.

For the API to be able to present a list of versions in a cronological order, a timestamp for a release is required.

TEA Component Object

A TEA Component object has the following parts:

  • uuid: A unique identifier for the TEA component
  • name: Component name
  • identifiers: List of identifiers for the component
    • idType: Type of identifier, e.g. tei, purl, cpe
    • idValue: Identifier value

Note: In coming versions, there may be a flag indicating lifecycle status for a component.

Examples

Some examples of Maven artefacts as TEA Components:

{
  "uuid": "3910e0fd-aff4-48d6-b75f-8bf6b84687f0",
  "name": "Apache Log4j API",
  "identifiers": [
    {
      "idType": "PURL",
      "idValue": "pkg:maven/org.apache.logging.log4j/log4j-api"
    }
  ]
}
{
  "uuid": "b844c9bd-55d6-478c-af59-954a932b6ad3",
  "name": "Apache Log4j Core",
  "identifiers": [
    {
      "idType": "CPE",
      "idValue": "cpe:2.3:a:apache:log4j"
    },
    {
      "idType": "PURL",
      "idValue": "pkg:maven/org.apache.logging.log4j/log4j-core"
    }
  ]
}

Handling the Pre-Release flag

The "Pre-release" flag is used to indicate that this is not a final release. For a given Component with a UUID, the flag can be set to indicate a "test", "beta", "alpha" or similar non-deployed release. It can only be set when creating the Component. The TEA implementation may allow it to be unset (False) once. This is to support situations where a object is promoted as is after testing to production version. The flag can not be set after initial creation and publication of the Component.

If the final version is different from the pre-release (bugs fixed, code changed, different binary) a new Component with a new UUID and version needs to be created.

References