Merge pull request #1077 from sajayantony/index-artifacts

image-index: add artifactType to specs and schema
opencontainers · Jun 22, 2023 · 5d7ba05 · 5d7ba05
2 parents 9708013 + a845c7a
commit 5d7ba05
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 0 deletions.
diff --git a/schema/image-index-schema.json b/schema/image-index-schema.json
@@ -15,6 +15,10 @@
       "description": "the mediatype of the referenced object",
       "$ref": "defs-descriptor.json#/definitions/mediaType"
     },
+    "artifactType": {
+      "description": "the artifact mediatype of the referenced object",
+      "$ref": "defs-descriptor.json#/definitions/mediaType"
+    },
     "subject": {
       "$ref": "content-descriptor.json"
     },

diff --git a/schema/imageindex_test.go b/schema/imageindex_test.go
@@ -227,6 +227,31 @@ func TestImageIndex(t *testing.T) {
     }
   ]
 }
+`,
+			fail: false,
+		},
+
+		// valid image index with artifactType and manifests
+		{
+			imageIndex: `
+{
+  "schemaVersion": 2,
+  "mediaType" : "application/vnd.oci.image.index.v1+json",
+  "artifactType": "application/vnd.example+type",
+  "manifests": [
+    {
+      "mediaType": "application/vnd.oci.image.manifest.v1+json",
+      "size": 7143,
+      "digest": "sha256:5b0bcabd1ed22e9fb1310cf6c2dec7cdef19f0ad69efa1f392e94a4333501270"
+    },
+    {
+      "mediaType": "application/vnd.oci.image.manifest.v1+json",
+      "artifactType": "application/vnd.example1+type",
+      "size": 506,
+      "digest": "sha256:99953afc4b90c7d78079d189ae10da0a1002e6be5e9e8dedaf9f7f29def42111"
+    }
+  ]
+}
 `,
 			fail: false,
 		},

diff --git a/specs-go/v1/index.go b/specs-go/v1/index.go
@@ -24,6 +24,9 @@ type Index struct {
 	// MediaType specifies the type of this document data structure e.g. `application/vnd.oci.image.index.v1+json`
 	MediaType string `json:"mediaType,omitempty"`
 
+	// ArtifactType specifies the IANA media type of artifact when the manifest is used for an artifact.
+	ArtifactType string `json:"artifactType,omitempty"`
+
 	// Manifests references platform specific manifests.
 	Manifests []Descriptor `json:"manifests"`