Skip to content

Commit 93a024c

Browse files
committed
image-layout.md, annotations.md: restrict scope of ref.name
By restricting the scope of the annotation `org.opencontainers.image.ref.name` to only image indexes appearing in the context of an image layout, we can greatly simplify processing and selection of target content. While other properties may apply down, we ensure that naming is restricted to a single "entity", the `index.json`, ambiguity for a given reference is reduced. This does not apply to other annotations, which may "apply downward" to other resources referenced. The application of annotation downward is specific to a particular annotation. Signed-off-by: Stephen J Day <[email protected]>
1 parent e6013db commit 93a024c

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

annotations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ This specification defines the following annotation keys, intended for but not l
2626
* **org.opencontainers.image.revision** Source control revision identifier for packaged software.
2727
* **org.opencontainers.image.vendor** Name of the distributing entity, organization or individual.
2828
* **org.opencontainers.image.licenses** Comma-separated list of licenses under which contained software is distributed, in [SPDX Short identifier]https://spdx.org/licenses/] form.
29-
* **org.opencontainers.image.ref.name** Name of the reference (string)
29+
* **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).

0 commit comments

Comments
 (0)