Skip to content

Commit e3a1166

Browse files
authored
Merge pull request #167 from wking/manifest-doc-lean-on-descriptor
manifest: Punt mediaType, size, and digest to descriptor docs
2 parents 45e8036 + 56629bb commit e3a1166

1 file changed

Lines changed: 5 additions & 53 deletions

File tree

manifest.md

Lines changed: 5 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -35,22 +35,7 @@ A client will distinguish a manifest list from an image manifest based on the Co
3535
This REQUIRED property contains a list of manifests for specific platforms.
3636
While the property MUST be present, the size of the array MAY be zero.
3737

38-
Properties of each object in the manifests list are:
39-
40-
- **`mediaType`** *string*
41-
42-
This REQUIRED property contains the MIME type of the referenced object.
43-
(i.e. `application/vnd.oci.image.manifest.v1+json`)
44-
45-
- **`size`** *int*
46-
47-
This REQUIRED property specifies the size in bytes of the object.
48-
This property exists so that a client will have an expected size for the content before validating.
49-
If the length of the retrieved content does not match the specified length, the content should not be trusted.
50-
51-
- **`digest`** *string*
52-
53-
This REQUIRED property is the digest of the content, as defined by the [Descriptor](descriptor.md) digest format.
38+
Each object in the manifest is a [descriptor](descriptor.md) with the following additional properties:
5439

5540
- **`platform`** *object*
5641

@@ -146,51 +131,18 @@ Unlike the [Manifest List](#manifest-list), which contains information about a s
146131
This REQUIRED property contains the MIME type of the image manifest.
147132
For this version of the specification, this MUST be set to `application/vnd.oci.image.manifest.v1+json`.
148133

149-
- **`config`** *object*
134+
- **`config`** *[descriptor](descriptor.md)*
150135

151136
This REQUIRED property references a configuration object for a container, by digest.
152137
The referenced configuration object is a JSON blob that the runtime uses to set up the container, see [Image JSON Description](serialization.md#image-json-description).
153138

154-
Properties of `config` are:
155-
156-
- **`mediaType`** *string*
157-
158-
This REQUIRED property contains the MIME type of the referenced object.
159-
(i.e. `application/vnd.oci.image.serialization.config.v1+json`)
160-
161-
- **`size`** *int*
162-
163-
This REQUIRED property specifies the size in bytes of the object.
164-
This property exists so that a client will have an expected size for the content before validating.
165-
If the length of the retrieved content does not match the specified length, the content should not be trusted.
166-
167-
- **`digest`** *string*
168-
169-
This REQUIRED property is the digest of the content, as defined by the [Descriptor](descriptor.md) digest format.
170-
171139
- **`layers`** *array*
172140

173-
The layer list MUST have the base image at index 0.
174-
Subsequent layers MUST then follow in the order in which they are to be layered on top of each other.
141+
Each item in the array MUST be a [descriptor](descriptor.md).
142+
The array MUST have the base image at index 0.
143+
Subsequent layers MUST then follow in the order in which they are to be layered on top of each other.
175144
The algorithm to create the final unpacked filesystem layout MUST be to first unpack the layer at index 0, then index 1, and so on.
176145

177-
Properties of an item in the layers list are:
178-
179-
- **`mediaType`** *string*
180-
181-
This REQUIRED property contains the MIME type of the referenced object.
182-
(i.e. `application/vnd.oci.image.serialization.rootfs.tar.gzip`)
183-
184-
- **`size`** *int*
185-
186-
This REQUIRED property specifies the size in bytes of the object.
187-
This property exists so that a client will have an expected size for the content before validating.
188-
If the length of the retrieved content does not match the specified length, the content should not be trusted.
189-
190-
- **`digest`** *string*
191-
192-
This REQUIRED property is the digest of the content, as defined by the [Descriptor](descriptor.md) digest format.
193-
194146
- **`annotations`** *hashmap*
195147

196148
This OPTIONAL property contains arbitrary metadata for the manifest list.

0 commit comments

Comments
 (0)