Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

scratch: add documentation #1070

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −0
Draft

scratch: add documentation #1070

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions media-types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,19 @@ The following media types identify the formats described here and their referenc
- `application/vnd.oci.image.layer.v1.tar`: ["Layer", as a tar archive](layer.md)
- `application/vnd.oci.image.layer.v1.tar+gzip`: ["Layer", as a tar archive](layer.md#gzip-media-types) compressed with [gzip][rfc1952]
- `application/vnd.oci.image.layer.v1.tar+zstd`: ["Layer", as a tar archive](layer.md#zstd-media-types) compressed with [zstd][rfc8478]

The following media type is special and used to indicate that the image is in fact an artifact, for example, SBOMs, image signatures, etc.

- `application/vnd.oci.scratch.v1+json`: [Scratch blob](manifest.md#example-of-a-scratch-config-or-layer-descriptor)

**NOTE**: `application/vnd.oci.scratch.v1+json` was introduced to support
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: please put each sentence to its own line

artifacts (which are not regular container images) in a backwards-compatible
way. This media-type may appear in the `config` and `layer` descriptor.
However, just the presence of this media-type automatically indicates that the
image manifest no longer represents a regular container image. Using this
media-type to describe any part of a regular container image is construed as
misuse.

The following media types identify a ["Layer" with distribution restrictions](layer.md#non-distributable-layers), but are **deprecated** and not recommended for future use:

- `application/vnd.oci.image.layer.nondistributable.v1.tar`: "Layer", as a tar archive
Expand Down