Skip to content

Commit 5d36c51

Browse files
committed
annotations: restrict character set of ref.name values
URI are standard enough, though % opens it a bit too much. After much discussion we're going to keep it as close to the docker tag as possible but with +, @ and / reference: #671 (comment) Fixes #599 Signed-off-by: Vincent Batts <[email protected]>
1 parent 7083b5a commit 5d36c51

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

annotations.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,16 @@ This specification defines the following annotation keys, intended for but not l
2828
* **org.opencontainers.image.revision** Source control revision identifier for the packaged software.
2929
* **org.opencontainers.image.vendor** Name of the distributing entity, organization or individual.
3030
* **org.opencontainers.image.licenses** License(s) under which contained software is distributed as a [SPDX License Expression][spdx-license-expression].
31-
* **org.opencontainers.image.ref.name** Name of the reference for a target (string). SHOULD only be considered valid when on descriptors on `index.json` within [image layout](image-layout.md).
31+
* **org.opencontainers.image.ref.name** Name of the reference for a target (string).
32+
* SHOULD only be considered valid when on descriptors on `index.json` within [image layout](image-layout.md).
33+
* Character set of the value SHOULD conform to alphanum of `A-Za-z0-9` and separator set of `-._:@/+`
34+
* An EBNF + regular expression like:
35+
```
36+
ref := component ["/" component]*
37+
component := alphanum [separator alphanum]*
38+
alphanum := /[A-Za-z0-9]+/
39+
separator := /[-._:@+]/ | "--"
40+
```
3241
* **org.opencontainers.image.title** Human-readable title of the image (string)
3342
* **org.opencontainers.image.description** Human-readable description of the software packaged in the image (string)
3443

0 commit comments

Comments
 (0)