Skip to content

Commit 09efd26

Browse files
committed
Add a note about required uniqueness of the TEI
Signed-off-by: Olle E. Johansson <[email protected]>
1 parent bc40ace commit 09efd26

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

discovery/readme.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,20 +49,25 @@ and gives the vendor a name space to define product identifiers based on existin
4949
like EAN/UPC bar code, PURLs or other existing schemes. A given product may have multiple identifiers
5050
as long as they all resolve into the same destination.
5151

52+
The vendor needs to make sure that the TEI is unique within the vendor's name space. There is no
53+
intention to create any TEI registries.
54+
5255
## The TEI URN: An extensible identifier
5356

5457
The TEI, Transparency Exchange Identifier, is a URN schema that is extensible based on existing
5558
identifiers like EAN codes, PURL and other identifiers. It is based on a DNS name, which leads
5659
to global uniqueness without new registries.
5760

5861
The TEI can be shown in the software itself, in shipping documentation, in web pages and app stores.
59-
TEI is unique for a product, not a version of a software. The TEI consist of three core parts
62+
TEI is unique for a product, not a version of a product.
6063

6164
A TEI belongs to a single product. A product can have multiple TEIs - like one with a EAN/UPC
6265
barcode and one with the vendor's product number.
6366

6467
### TEI syntax
6568

69+
The TEI consist of three core parts
70+
6671
```text
6772
urn:tei:<type>:<domain-name>:<unique-identifier>
6873
````
@@ -150,6 +155,11 @@ urn:tei:uuid:cyclonedx.org:d4d9f54a-abcf-11ee-ac79-1a52914d44b1
150155
- GS1
151156
- STD
152157

158+
Note that if an identifier, like EAN, is used for multiple different products then this
159+
EAN code will not be unique for a given product and should not be used as an identifier.
160+
In this case, the vendor is recommended to create a separate identifier for each unique
161+
product sold by other means, like UUID or hash.
162+
153163
### TEI resolution using DNS
154164

155165
The `domain-name` part of the TEI is used in a DNS query to find one or multiple locations for
@@ -201,11 +211,6 @@ Always prefix with the https:// scheme. http (unencrypted) is not valid.
201211

202212
**NOTE:** The `/.well-known/tea` names space needs to be registred.
203213

204-
## The TEA Version Index
205-
206-
The resulting URL leads to the TEA version index, which is documented in another document.
207-
One redirect (302) is allowed in order to provide for aliasing, where a single product
208-
has many identifiers. The redirect should not lead to a separate web server.
209214

210215
## References
211216

0 commit comments

Comments
 (0)