Skip to content

Commit 489e00e

Browse files
committed
manifest-list: platform is effective optional
Per the 2017-01-25 call, stevvooe pointed out that in implementation this field is optional and sane defaults are assumed. This pairs nicely with the index model of providing a list of descriptors, that may not be platform specific objects (i.e. an XML file for AppStream data). For media that pertains to an image, like AppStream metadata, may need to accompany a manifest-list, but is not a descriptor that points to a manifest (i.e. and XML file). This clarifies the behavior on handling unknown `mediaType` descriptors. Signed-off-by: Vincent Batts <[email protected]>
1 parent ed18de1 commit 489e00e

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

manifest-list.md

+7-11
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ For the media type(s) that this document is compatible with, see the [matrix][ma
2020

2121
- **`manifests`** *array of objects*
2222

23-
This REQUIRED property contains a list of manifests for specific platforms.
24-
While the property MUST be present, the size of the array MAY be zero.
23+
This REQUIRED property contains a list of [manifests](manifest.md) for specific platforms.
24+
While this property MUST be present, the size of the array MAY be zero.
2525

26-
Each object in `manifests` is a [descriptor](descriptor.md) with the following additional properties and restrictions:
26+
Each object in `manifests` has the base properties of [descriptor](descriptor.md) with the following additional properties and restrictions:
2727

2828
- **`mediaType`** *string*
2929

@@ -33,10 +33,13 @@ For the media type(s) that this document is compatible with, see the [matrix][ma
3333
- [`application/vnd.oci.image.manifest.v1+json`](manifest.md)
3434

3535
Manifest lists concerned with portability SHOULD use one of the above media types.
36+
Future versions of the spec MAY use a different mediatype (i.e. a new versioned format).
37+
An encountered `mediaType` that is unknown SHOULD be safely ignored.
3638

3739
- **`platform`** *object*
3840

39-
This REQUIRED property describes the platform which the image in the manifest runs on.
41+
This OPTIONAL property describes the platform which the image in the manifest runs on.
42+
This property SHOULD be present if its target is platform-specific.
4043

4144
- **`architecture`** *string*
4245

@@ -64,13 +67,6 @@ For the media type(s) that this document is compatible with, see the [matrix][ma
6467

6568
This OPTIONAL property specifies an array of strings, each specifying a mandatory CPU feature (for example `sse4` or `aes`).
6669

67-
- **`annotations`** *string-string map*
68-
69-
This OPTIONAL property contains arbitrary metadata for the manifest list.
70-
This OPTIONAL property MUST use the [annotation rules](annotations.md#rules).
71-
72-
See [Pre-Defined Annotation Keys](annotations.md#pre-defined-annotation-keys).
73-
7470
## Example Manifest List
7571

7672
*Example showing a simple manifest list pointing to image manifests for two platforms:*

0 commit comments

Comments
 (0)