Skip to content

Commit

Permalink
Add some text about extensions
Browse files Browse the repository at this point in the history
Signed-off-by: Doug Davis <dug@us.ibm.com>
  • Loading branch information
Doug Davis committed Jun 26, 2016
1 parent b36f351 commit 0f830d0
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,13 +85,18 @@ A client will distinguish a manifest list from an image manifest based on the Co

This OPTIONAL property contains arbitrary metadata for the manifest list.
Annotations is a key-value, unordered hashmap.
Keys are unique, and best practice is to namespace the keys.
Keys MUST be unique, and best practice is to namespace the keys.
If there are no annotations then this property MAY either be absent or be an empty hashmap.
Common annotation keys include:
* **created** date on which the image was built (string, timestamps type)
* **authors** contact details of the people or organization responsible for the image (freeform string)
* **homepage** URL to find more information on the image (string, must be a URL with scheme HTTP or HTTPS)
* **documentation** URL to get documentation on the image (string, must be a URL with scheme HTTP or HTTPS)

### Extensibility
The `annotations` property MAY be used as an extensibility point to include additional information that is not defined as part of this specification.
Implementations that are reading/processing manifest lists MUST NOT generate an error if they encounter an unknown annotation.
Excluding the `annotations` property, implementations that are reading/processing manifest lists MUST generate an error if they encounter an unknown property.

## Example Manifest List

Expand Down

0 comments on commit 0f830d0

Please sign in to comment.