Skip to content

Commit

Permalink
image-layout.md, annotations.md: restrict scope of ref.name
Browse files Browse the repository at this point in the history
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 <stephen.day@docker.com>
  • Loading branch information
stevvooe committed May 4, 2017
1 parent e6013db commit 93a024c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ This specification defines the following annotation keys, intended for but not l
* **org.opencontainers.image.revision** Source control revision identifier for 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 (string)
* **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 comments on commit 93a024c

Please sign in to comment.