Skip to content

Commit 63b8bd0

Browse files
committed
Remove artifact manifest
The artifact manifest does not confer any additional benefits beyond the existing image manifest. Drop it for the sake of backward compatibility. Remove references to artifact.md, regenerate graph. Signed-off-by: Jon Johnson <[email protected]>
1 parent 88195d9 commit 63b8bd0

File tree

10 files changed

+4
-134
lines changed

10 files changed

+4
-134
lines changed

Makefile

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ DOC_FILES := \
3030
descriptor.md \
3131
image-layout.md \
3232
manifest.md \
33-
artifact.md \
3433
image-index.md \
3534
layer.md \
3635
config.md \

annotations.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,8 @@ This property contains arbitrary metadata.
1616

1717
## Pre-Defined Annotation Keys
1818

19-
This specification defines the following annotation keys, intended for but not limited to [image index](image-index.md), image [manifest](manifest.md), [artifact](artifact.md), and [descriptor](descriptor.md) authors.
19+
This specification defines the following annotation keys, intended for but not limited to [image index](image-index.md), image [manifest](manifest.md), and [descriptor](descriptor.md) authors.
2020

21-
* **org.opencontainers.artifact.created** date and time on which the artifact was built, conforming to [RFC 3339][rfc3339].
22-
* **org.opencontainers.artifact.description**: human readable description for the artifact (string)
2321
* **org.opencontainers.image.created** date and time on which the image was built, conforming to [RFC 3339][rfc3339].
2422
* **org.opencontainers.image.authors** contact details of the people or organization responsible for the image (freeform string)
2523
* **org.opencontainers.image.url** URL to find more information on the image (string)

artifact.md

Lines changed: 0 additions & 74 deletions
This file was deleted.

descriptor.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,14 +55,11 @@ The following fields contain the primary properties that constitute a Descriptor
5555
- **`artifactType`** *string*
5656

5757
This OPTIONAL property contains the type of an artifact when the descriptor points to an artifact.
58-
This is the value of `artifactType` when the descriptor references an [artifact manifest](artifact.md).
5958
This is the value of the config descriptor `mediaType` when the descriptor references an [image manifest](manifest.md).
6059
If defined, the value MUST comply with [RFC 6838][rfc6838], including the [naming requirements in its section 4.2][rfc6838-s4.2], and MAY be registered with [IANA][iana].
6160

6261
Descriptors pointing to [`application/vnd.oci.image.manifest.v1+json`](manifest.md) SHOULD include the extended field `platform`, see [Image Index Property Descriptions](image-index.md#image-index-property-descriptions) for details.
6362

64-
Descriptors pointing to [`application/vnd.oci.artifact.manifest.v1+json`](artifact.md) SHOULD include the extended field `artifactType`.
65-
6663
### Reserved
6764

6865
Extended _Descriptor_ field additions proposed in other OCI specifications SHOULD first be considered for addition into this specification.
@@ -206,7 +203,7 @@ In the following example, the descriptor indicates the type of artifact it is re
206203

207204
```json,title=Content%20Descriptor&mediatype=application/vnd.oci.descriptor.v1%2Bjson
208205
{
209-
"mediaType": "application/vnd.oci.artifact.manifest.v1+json",
206+
"mediaType": "application/vnd.oci.image.manifest.v1+json",
210207
"size": 123,
211208
"digest": "sha256:87923725d74f4bfb94c9e86d64170f7521aad8221a5de834851470ca142da630",
212209
"artifactType": "application/vnd.example.sbom.v1"

image-index.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ For the media type(s) that this document is compatible with, see the [matrix][ma
3535
Implementations MUST support at least the following media types:
3636

3737
- [`application/vnd.oci.image.manifest.v1+json`](manifest.md)
38-
- [`application/vnd.oci.artifact.manifest.v1+json`](artifact.md)
3938

4039
Also, implementations SHOULD support the following media types:
4140

@@ -157,14 +156,9 @@ When the variant of the CPU is not listed in the table, values are implementatio
157156
}
158157
},
159158
{
160-
"mediaType": "application/vnd.oci.artifact.manifest.v1+json",
159+
"mediaType": "application/vnd.oci.image.index.v1+json",
161160
"size": 7682,
162-
"digest": "sha256:601570aaff1b68a61eb9c85b8beca1644e698003e0cdb5bce960f193d265a8b7",
163-
"artifactType": "application/example",
164-
"annotations": {
165-
"com.example.artifactKey1": "value1",
166-
"com.example.artifactKey2": "value2"
167-
}
161+
"digest": "sha256:601570aaff1b68a61eb9c85b8beca1644e698003e0cdb5bce960f193d265a8b7"
168162
}
169163
],
170164
"annotations": {

img/media-types.dot

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ digraph G {
44
{
55
rank=same
66
manifest [shape=note, label="Image manifest\napplication/vnd.oci.image.manifest.v1+json"]
7-
artifact [shape=note, label="Artifact Manifest\napplication/vnd.oci.artifact.manifest.v1+json"]
87
}
98
config [shape=note, label="Image config JSON\napplication/vnd.oci.image.config.v1+json"]
109
layer [shape=note, label="Layer tar archive\napplication/vnd.oci.image.layer.v1.tar\napplication/vnd.oci.image.layer.v1.tar+gzip\napplication/vnd.oci.image.layer.nondistributable.v1.tar\napplication/vnd.oci.image.layer.nondistributable.v1.tar+gzip"]
@@ -14,9 +13,5 @@ digraph G {
1413
imageIndex -> manifest [label="1..*"]
1514
manifest -> config [label="1..1"]
1615
manifest -> layer [label="1..*"]
17-
artifact -> manifest [label="0..1"] [constraint = false];
18-
artifact -> artifact [label="0..1"];
1916
manifest -> manifest [label="0..1"];
20-
artifact -> imageIndex [label="0..1"]
21-
artifact -> layer[label="0..*"]
2217
}

img/media-types.png

-9 KB
Loading

spec.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ The goal of this specification is to enable the creation of interoperable tools
1717
- [Image Index](image-index.md)
1818
- [Filesystem Layers](layer.md)
1919
- [Image Configuration](config.md)
20-
- [Artifact Manifest](artifact.md)
2120
- [Annotations](annotations.md)
2221
- [Conversion](conversion.md)
2322
- [Considerations](considerations.md)
@@ -54,7 +53,6 @@ The high-level components of the spec include:
5453

5554
* [Image Manifest](manifest.md) - a document describing the components that make up a container image
5655
* [Image Index](image-index.md) - an annotated list of manifests
57-
* [Artifact Manifest](artifact.md) - a document describing the components that make up an artifact
5856
* [Image Layout](image-layout.md) - a filesystem layout representing the contents of an image
5957
* [Filesystem Layer](layer.md) - a changeset that describes a container's filesystem
6058
* [Image Configuration](config.md) - a document determining layer ordering and configuration of the image suitable for translation into a [runtime bundle][runtime-spec]

specs-go/v1/artifact.go

Lines changed: 0 additions & 34 deletions
This file was deleted.

specs-go/v1/mediatype.go

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,4 @@ const (
7272

7373
// MediaTypeScratch specifies the media type for an unused blob containing the value `{}`
7474
MediaTypeScratch = "application/vnd.oci.scratch.v1+json"
75-
76-
// MediaTypeArtifactManifest specifies the media type for a content descriptor.
77-
MediaTypeArtifactManifest = "application/vnd.oci.artifact.manifest.v1+json"
7875
)

0 commit comments

Comments
 (0)