Skip to content

Commit 68a5d22

Browse files
committed
*: update for oc/image-spec
WIP
1 parent 9d0f39a commit 68a5d22

File tree

1 file changed

+20
-22
lines changed

1 file changed

+20
-22
lines changed

manifest.md

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -29,26 +29,25 @@ A client will distinguish a manifest list from an image manifest based on the Co
2929

3030
- **`schemaVersion`** *int*
3131

32-
This field specifies the image manifest schema version as an integer. This
33-
schema uses the version `2`.
32+
This field specifies the image manifest schema version as an integer.
33+
This schema uses the version `0`.
3434

3535
- **`mediaType`** *string*
3636

37-
The MIME type of the manifest list. This should be set to
38-
`application/vnd.oci.image.manifest.list.v1+json`.
37+
This REQUIRED property contains the MIME type of the referenced object.
38+
This should be set to `application/vnd.oci.image.manifest.list.v1+json`.
3939

4040
- **`manifests`** *array*
4141

42-
The manifests field contains a list of manifests for specific platforms.
42+
This REQUIRED property contains a list of manifests for specific platforms.
43+
While the property MUST be present, the size of the array MAY be zero.
4344

44-
Fields of a object in the manifests list are:
45+
Fields of each object in the manifests list are:
4546

4647
- **`mediaType`** *string*
4748

48-
The MIME type of the referenced object. This will generally be
49-
`application/vnd.oci.image.manifest.v1+json`, but it could also
50-
be `application/vnd.oci.image.manifest.v1+json` if the manifest
51-
list references a legacy schema-1 manifest.
49+
The MIME type of the referenced object.
50+
This will generally be `application/vnd.oci.image.manifest.v1+json`.
5251

5352
- **`size`** *int*
5453

@@ -62,39 +61,39 @@ A client will distinguish a manifest list from an image manifest based on the Co
6261

6362
- **`platform`** *object*
6463

65-
The platform object describes the platform which the image in the manifest runs on.
64+
This REQUIRED property describes the platform which the image in the manifest runs on.
6665
A full list of valid operating system and architecture values are listed in the [Go language documentation for `$GOOS` and `$GOARCH`](https://golang.org/doc/install/source#environment)
6766

6867
- **`architecture`** *string*
6968

70-
The architecture field specifies the CPU architecture, for example `amd64` or `ppc64le`.
69+
This REQUIRED property specified the CPU architecture, for example `amd64` or `ppc64le`.
7170

7271
- **`os`** *string*
7372

74-
The os field specifies the operating system, for example `linux` or `windows`.
73+
This REQUIRED property specifies the operating system, for example `linux` or `windows`.
7574

7675
- **`os.version`** *string*
7776

78-
The optional os.version field specifies the operating system version, for example `10.0.10586`.
77+
This optional property specifies the operating system version, for example `10.0.10586`.
7978

8079
- **`os.features`** *array*
8180

82-
The optional os.features field specifies an array of strings, each listing a required OS feature (for example on Windows `win32k`).
81+
This OPTIONAL property specifies an array of strings, each specifying a mandatory OS feature (for example on Windows `win32k`).
8382

8483
- **`variant`** *string*
8584

86-
The optional variant field specifies a variant of the CPU, for example `armv6l` to specify a particular CPU variant of the ARM CPU.
85+
This OPTIONAL property specifies the variant of the CPU, for example `armv6l` to specify a particular CPU variant of the ARM CPU.
8786

8887
- **`features`** *array*
8988

90-
The optional features field specifies an array of strings, each listing a required CPU feature (for example `sse4` or `aes`).
89+
This OPTIONAL property specifies an array of strings, each specifying a mandatory CPU feature (for example `sse4` or `aes`).
9190

9291
## Example Manifest List
9392

9493
*Example showing a simple manifest list pointing to image manifests for two platforms:*
9594
```json
9695
{
97-
"schemaVersion": 2,
96+
"schemaVersion": 0,
9897
"mediaType": "application/vnd.oci.image.manifest.list.v1+json",
9998
"manifests": [
10099
{
@@ -125,14 +124,13 @@ A client will distinguish a manifest list from an image manifest based on the Co
125124
# Image Manifest
126125

127126
The image manifest provides a configuration and a set of layers for a container image.
128-
It's the direct replacement for the schema-1 manifest.
129127

130128
## *Image Manifest* Field Descriptions
131129

132130
- **`schemaVersion`** *int*
133131

134132
This field specifies the image manifest schema version as an integer.
135-
This schema uses version `2`.
133+
This schema uses version `0`.
136134

137135
- **`mediaType`** *string*
138136

@@ -194,8 +192,8 @@ It's the direct replacement for the schema-1 manifest.
194192
*Example showing an image manifest:*
195193
```json
196194
{
197-
"schemaVersion": 2,
198-
"mediaType": "application/vnd.oci.image.manifest.v2+json",
195+
"schemaVersion": 0,
196+
"mediaType": "application/vnd.oci.image.manifest.v1+json",
199197
"config": {
200198
"mediaType": "application/vnd.oci.image.serialization.v1+json",
201199
"size": 7023,

0 commit comments

Comments
 (0)