From 59f0304cd70f675c42ef236292699bce673f6e52 Mon Sep 17 00:00:00 2001 From: Vincent Batts Date: Thu, 11 May 2017 15:42:21 -0400 Subject: [PATCH] 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: https://github.com/opencontainers/image-spec/pull/671#issuecomment-302251178 Fixes #599 Signed-off-by: Vincent Batts --- annotations.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/annotations.md b/annotations.md index b5ab57025..4bb0a7a3b 100644 --- a/annotations.md +++ b/annotations.md @@ -26,7 +26,10 @@ This specification defines the following annotation keys, intended for but not l * **org.opencontainers.image.revision** Source control revision identifier for the packaged software. * **org.opencontainers.image.vendor** Name of the distributing entity, organization or individual. * **org.opencontainers.image.licenses** Comma-separated list of licenses under which contained software is distributed, in [SPDX Short identifier](https://spdx.org/licenses/) form. -* **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). +* **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). + * Character set of the value SHOULD conform to alphanum of `A-Za-z0-9` and separator set of `-._:@/+` + * Recommended regular expression of `/[A-Za-z0-9]+[-._:@/+A-Za-z0-9]*[A-Za-z0-9]+/` * **org.opencontainers.image.name** Human-readable name of the software packaged in the image (string) * **org.opencontainers.image.description** Human-readable description of the software packaged in the image (string)