Merge pull request opencontainers#347 from wking/versioned-media-types

philips · web-flow · commit f58ea21e18ef · 2016-09-30T13:32:17.000-07:00
Consistently version media types
diff --git a/config.md b/config.md
@@ -26,7 +26,7 @@ Changing it means creating a new derived image, instead of changing the existing
 A layer DiffID is a SHA256 digest over the layer's uncompressed tar archive and serialized in the descriptor digest format, e.g., `sha256:a9561eb1b190625c9adb5a9513e72c4dedafc1cb2d4c5236c9a6957ec7dfd5a9`.
 Layers must be packed and unpacked reproducibly to avoid changing the layer DiffID, for example by using tar-split to save the tar headers.
 
-NOTE: the DiffID is different than the digest in the manifest list because the manifest digest is taken over the gzipped layer for `application/vnd.oci.image.layer.tar+gzip` types.
+NOTE: the DiffID is different than the digest in the manifest list because the manifest digest is taken over the gzipped layer for `application/vnd.oci.image.layer.v1.tar+gzip` types.
 
 ### Layer ChainID
 
diff --git a/image-layout.md b/image-layout.md
@@ -96,7 +96,7 @@ $ cat ./blobs/sha256/afff3924849e458c5ef237db5f89539274d5e609db5db935ed3959c90f1
   },
   "layers": [
     {
-      "mediaType": "application/vnd.oci.image.layer.tar+gzip",
+      "mediaType": "application/vnd.oci.image.layer.v1.tar+gzip",
       "size": 32654,
       "digest": "sha256:e692418e4cbaf90ca69d05a66403747baa33ee08806650b51fab815ad7fc331f"
     },
diff --git a/image/manifest_test.go b/image/manifest_test.go
@@ -108,7 +108,7 @@ func TestUnpackLayer(t *testing.T) {
 
 	testManifest := manifest{
 		Layers: []descriptor{descriptor{
-			MediaType: "application/vnd.oci.image.layer.tar+gzip",
+			MediaType: "application/vnd.oci.image.layer.v1.tar+gzip",
 			Digest:    fmt.Sprintf("sha256:%s", fmt.Sprintf("%x", h.Sum(nil))),
 		}},
 	}
diff --git a/img/media-types.dot b/img/media-types.dot
@@ -3,7 +3,7 @@ digraph G {
     manifestList [shape=note, label="Manifest list\n<<optional>>\napplication/vnd.oci.image.manifest.list.v1+json"]
     manifest [shape=note, label="Image manifest\napplication/vnd.oci.image.manifest.v1+json"]
     config [shape=note, label="Image JSON\napplication/vnd.oci.image.config.v1+json"]
-    layer [shape=note, label="Layer tar+gzip\napplication/vnd.oci.image.layer.tar+gzip\napplication/vnd.oci.image.layer.nondistributable.tar+gzip"]
+    layer [shape=note, label="Layer tar+gzip\napplication/vnd.oci.image.layer.v1.tar+gzip\napplication/vnd.oci.image.layer.nondistributable.v1.tar+gzip"]
   }
 
   manifestList -> manifest [label="1..*"]
diff --git a/img/media-types.png b/img/media-types.png
diff --git a/layer.md b/layer.md
@@ -6,8 +6,8 @@ This document will use a concrete example to illustrate how to create and consum
 
 ## Distributable Format
 
-Layer Changesets for the [mediatype](./media-types.md) `application/vnd.oci.image.layer.tar+gzip` MUST be packaged in a [tar archive][tar-archive] compressed with [gzip][gzip].
-Layer Changesets for the [mediatype](./media-types.md) `application/vnd.oci.image.layer.tar+gzip` MUST NOT include duplicate entries for file paths in the resulting [tar archive][tar-archive].
+Layer Changesets for the [mediatype](./media-types.md) `application/vnd.oci.image.layer.v1.tar+gzip` MUST be packaged in a [tar archive][tar-archive] compressed with [gzip][gzip].
+Layer Changesets for the [mediatype](./media-types.md) `application/vnd.oci.image.layer.v1.tar+gzip` MUST NOT include duplicate entries for file paths in the resulting [tar archive][tar-archive].
 
 ## Change Types
 
@@ -206,7 +206,7 @@ Where the basename name of `./etc/my-app-config` is now prefixed with `.wh.`, an
 
 ## Applying
 
-Layer Changesets of [mediatype](./media-types.md) `application/vnd.oci.image.layer.tar+gzip` are applied rather than strictly extracted in normal fashion for tar archives.
+Layer Changesets of [mediatype](./media-types.md) `application/vnd.oci.image.layer.v1.tar+gzip` are applied rather than strictly extracted in normal fashion for tar archives.
 
 Applying a layer changeset requires consideration for the [whiteout](#whiteouts) files.
 In the absence of any [whiteout](#whiteouts) files in a layer changeset, the archive is extracted like a regular tar archive.
@@ -311,7 +311,7 @@ Any given image is likely to be composed of several of these Image Filesystem Ch
 Certain layers, due to legal requirements, may not be regularly distributable.
 Typically, such layers are downloaded directly from a distributor but are never uploaded.
 
-Layers that have these restrictions SHOULD be tagged with an alternative mediatype of `application/vnd.oci.image.layer.nondistributable.tar+gzip`.
+Layers that have these restrictions SHOULD be tagged with an alternative mediatype of `application/vnd.oci.image.layer.nondistributable.v1.tar+gzip`.
 [Descriptors](descriptor.md) referencing these layers MAY include `urls` for downloading these layers.
 It is implementation-defined whether or not implementations upload layers tagged with this media type.
 
diff --git a/manifest.md b/manifest.md
@@ -169,8 +169,8 @@ Unlike the [Manifest List](#manifest-list), which contains information about a s
         This [descriptor property](descriptor.md#properties) has additional restrictions for `layers[]`.
         Implementations MUST support at least the following media types:
 
-        - [`application/vnd.oci.image.layer.tar+gzip`](layer.md)
-        - [`application/vnd.oci.image.layer.nondistributable.tar+gzip`](layer.md#non-distributable-layers)
+        - [`application/vnd.oci.image.layer.v1.tar+gzip`](layer.md)
+        - [`application/vnd.oci.image.layer.nondistributable.v1.tar+gzip`](layer.md#non-distributable-layers)
 
         Manifests concerned with portability SHOULD use one of the above media types.
 
@@ -205,17 +205,17 @@ Instead they MUST ignore unknown properties.
   },
   "layers": [
     {
-      "mediaType": "application/vnd.oci.image.layer.tar+gzip",
+      "mediaType": "application/vnd.oci.image.layer.v1.tar+gzip",
       "size": 32654,
       "digest": "sha256:e692418e4cbaf90ca69d05a66403747baa33ee08806650b51fab815ad7fc331f"
     },
     {
-      "mediaType": "application/vnd.oci.image.layer.tar+gzip",
+      "mediaType": "application/vnd.oci.image.layer.v1.tar+gzip",
       "size": 16724,
       "digest": "sha256:3c3a4604a545cdc127456d94e421cd355bca5b528f4a9c1905b15da2eb4a4c6b"
     },
     {
-      "mediaType": "application/vnd.oci.image.layer.tar+gzip",
+      "mediaType": "application/vnd.oci.image.layer.v1.tar+gzip",
       "size": 73109,
       "digest": "sha256:ec4b8955958665577945c89419d1af06b5f7636b4ac3da7f12184802ad867736"
     }
diff --git a/media-types.md b/media-types.md
@@ -6,8 +6,8 @@ The following media types identify the formats described here and their referenc
 - `application/vnd.oci.image.manifest.list.v1+json`: [Manifest list](manifest.md#manifest-list)
 - `application/vnd.oci.image.manifest.v1+json`: [Image manifest format](manifest.md#image-manifest)
 - `application/vnd.oci.image.config.v1+json`: [Image config JSON](config.md)
-- `application/vnd.oci.image.layer.tar+gzip`: ["Layer", as a gzipped tar archive](layer.md)
-- `application/vnd.oci.image.layer.nondistributable.tar+gzip`: ["Layer", as a gzipped tar archive with distribution restrictions](layer.md#non-distributable-layers)
+- `application/vnd.oci.image.layer.v1.tar+gzip`: ["Layer", as a gzipped tar archive](layer.md)
+- `application/vnd.oci.image.layer.nondistributable.v1.tar+gzip`: ["Layer", as a gzipped tar archive with distribution restrictions](layer.md#non-distributable-layers)
 
 ## Compatibility Matrix
 
diff --git a/schema/manifest_test.go b/schema/manifest_test.go
@@ -67,7 +67,7 @@ func TestManifest(t *testing.T) {
   },
   "layers": [
     {
-      "mediaType": "application/vnd.oci.image.layer.tar+gzip",
+      "mediaType": "application/vnd.oci.image.layer.v1.tar+gzip",
       "size": "675598",
       "digest": "sha256:c86f7763873b6c0aae22d963bab59b4f5debbed6685761b5951584f6efb0633b"
     }
@@ -90,17 +90,17 @@ func TestManifest(t *testing.T) {
   },
   "layers": [
     {
-      "mediaType": "application/vnd.oci.image.layer.tar+gzip",
+      "mediaType": "application/vnd.oci.image.layer.v1.tar+gzip",
       "size": 675598,
       "digest": "sha256:9d3dd9504c685a304985025df4ed0283e47ac9ffa9bd0326fddf4d59513f0827"
     },
     {
-      "mediaType": "application/vnd.oci.image.layer.tar+gzip",
+      "mediaType": "application/vnd.oci.image.layer.v1.tar+gzip",
       "size": 156,
       "digest": "sha256:2b689805fbd00b2db1df73fae47562faac1a626d5f61744bfe29946ecff5d73d"
     },
     {
-      "mediaType": "application/vnd.oci.image.layer.tar+gzip",
+      "mediaType": "application/vnd.oci.image.layer.v1.tar+gzip",
       "size": 148,
       "digest": "sha256:c57089565e894899735d458f0fd4bb17a0f1e0df8d72da392b85c9b35ee777cd"
     }
diff --git a/specs-go/v1/descriptor.go b/specs-go/v1/descriptor.go
@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package specs
+package v1
 
 // Descriptor describes the disposition of targeted content.
 type Descriptor struct {
diff --git a/specs-go/v1/manifest.go b/specs-go/v1/manifest.go
@@ -22,10 +22,10 @@ type Manifest struct {
 
 	// Config references a configuration object for a container, by digest.
 	// The referenced configuration object is a JSON blob that the runtime uses to set up the container.
-	Config specs.Descriptor `json:"config"`
+	Config Descriptor `json:"config"`
 
 	// Layers is an indexed list of layers referenced by the manifest.
-	Layers []specs.Descriptor `json:"layers"`
+	Layers []Descriptor `json:"layers"`
 
 	// Annotations contains arbitrary metadata for the manifest list.
 	Annotations map[string]string `json:"annotations"`
diff --git a/specs-go/v1/manifest_list.go b/specs-go/v1/manifest_list.go
@@ -44,7 +44,7 @@ type Platform struct {
 
 // ManifestDescriptor describes a platform specific manifest.
 type ManifestDescriptor struct {
-	specs.Descriptor
+	Descriptor
 
 	// Platform describes the platform which the image in the manifest runs on.
 	Platform Platform `json:"platform"`
diff --git a/specs-go/v1/mediatype.go b/specs-go/v1/mediatype.go
@@ -25,11 +25,11 @@ const (
 	MediaTypeImageManifestList = "application/vnd.oci.image.manifest.list.v1+json"
 
 	// MediaTypeImageLayer is the media type used for layers referenced by the manifest.
-	MediaTypeImageLayer = "application/vnd.oci.image.layer.tar+gzip"
+	MediaTypeImageLayer = "application/vnd.oci.image.layer.v1.tar+gzip"
 
 	// MediaTypeImageLayerNonDistributable is the media type for layers referenced by
 	// the manifest but with distribution restrictions.
-	MediaTypeImageLayerNonDistributable = "application/vnd.oci.image.layer.nondistributable.tar+gzip"
+	MediaTypeImageLayerNonDistributable = "application/vnd.oci.image.layer.nondistributable.v1.tar+gzip"
 
 	// MediaTypeImageConfig specifies the media type for the image configuration.
 	MediaTypeImageConfig = "application/vnd.oci.image.config.v1+json"

Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,7 @@ $ cat ./blobs/sha256/afff3924849e458c5ef237db5f89539274d5e609db5db935ed3959c90f1`
`96`	`96`	`},`
`97`	`97`	`"layers": [`
`98`	`98`	`{`
`99`		`- "mediaType": "application/vnd.oci.image.layer.tar+gzip",`
	`99`	`+ "mediaType": "application/vnd.oci.image.layer.v1.tar+gzip",`
`100`	`100`	`"size": 32654,`
`101`	`101`	`"digest": "sha256:e692418e4cbaf90ca69d05a66403747baa33ee08806650b51fab815ad7fc331f"`
`102`	`102`	`},`
Original file line number	Diff line number	Diff line change
`@@ -108,7 +108,7 @@ func TestUnpackLayer(t *testing.T) {`
`108`	`108`
`109`	`109`	`testManifest := manifest{`
`110`	`110`	`Layers: []descriptor{descriptor{`
`111`		`- MediaType: "application/vnd.oci.image.layer.tar+gzip",`
	`111`	`+ MediaType: "application/vnd.oci.image.layer.v1.tar+gzip",`
`112`	`112`	`Digest: fmt.Sprintf("sha256:%s", fmt.Sprintf("%x", h.Sum(nil))),`
`113`	`113`	`}},`
`114`	`114`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ digraph G {`
`3`	`3`	`manifestList [shape=note, label="Manifest list\n<<optional>>\napplication/vnd.oci.image.manifest.list.v1+json"]`
`4`	`4`	`manifest [shape=note, label="Image manifest\napplication/vnd.oci.image.manifest.v1+json"]`
`5`	`5`	`config [shape=note, label="Image JSON\napplication/vnd.oci.image.config.v1+json"]`
`6`		`- layer [shape=note, label="Layer tar+gzip\napplication/vnd.oci.image.layer.tar+gzip\napplication/vnd.oci.image.layer.nondistributable.tar+gzip"]`
	`6`	`+ layer [shape=note, label="Layer tar+gzip\napplication/vnd.oci.image.layer.v1.tar+gzip\napplication/vnd.oci.image.layer.nondistributable.v1.tar+gzip"]`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`manifestList -> manifest [label="1..*"]`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ func TestManifest(t *testing.T) {`
`67`	`67`	`},`
`68`	`68`	`"layers": [`
`69`	`69`	`{`
`70`		`- "mediaType": "application/vnd.oci.image.layer.tar+gzip",`
	`70`	`+ "mediaType": "application/vnd.oci.image.layer.v1.tar+gzip",`
`71`	`71`	`"size": "675598",`
`72`	`72`	`"digest": "sha256:c86f7763873b6c0aae22d963bab59b4f5debbed6685761b5951584f6efb0633b"`
`73`	`73`	`}`
`@@ -90,17 +90,17 @@ func TestManifest(t *testing.T) {`
`90`	`90`	`},`
`91`	`91`	`"layers": [`
`92`	`92`	`{`
`93`		`- "mediaType": "application/vnd.oci.image.layer.tar+gzip",`
	`93`	`+ "mediaType": "application/vnd.oci.image.layer.v1.tar+gzip",`
`94`	`94`	`"size": 675598,`
`95`	`95`	`"digest": "sha256:9d3dd9504c685a304985025df4ed0283e47ac9ffa9bd0326fddf4d59513f0827"`
`96`	`96`	`},`
`97`	`97`	`{`
`98`		`- "mediaType": "application/vnd.oci.image.layer.tar+gzip",`
	`98`	`+ "mediaType": "application/vnd.oci.image.layer.v1.tar+gzip",`
`99`	`99`	`"size": 156,`
`100`	`100`	`"digest": "sha256:2b689805fbd00b2db1df73fae47562faac1a626d5f61744bfe29946ecff5d73d"`
`101`	`101`	`},`
`102`	`102`	`{`
`103`		`- "mediaType": "application/vnd.oci.image.layer.tar+gzip",`
	`103`	`+ "mediaType": "application/vnd.oci.image.layer.v1.tar+gzip",`
`104`	`104`	`"size": 148,`
`105`	`105`	`"digest": "sha256:c57089565e894899735d458f0fd4bb17a0f1e0df8d72da392b85c9b35ee777cd"`
`106`	`106`	`}`