Skip to content

Commit 3f29dae

Browse files
authored
Merge pull request #139 from vbatts/clarify_refs
image-layout: clarify refs can be generic
2 parents 5c0ce84 + fe63795 commit 3f29dae

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

image-layout.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ Given an image layout a tool can convert a given ref into a runnable OCI Image F
77
The image layout has two top level directories:
88

99
- "blobs" contains content-addressable blobs. A blob has no schema and should be considered opaque.
10-
- "refs" contains descriptors pointing to an image manifest
10+
- "refs" contains [descriptors][descriptors]. Commonly pointing to an image manifest.
11+
1112

1213
It also contains a file that is used to identify the layout version:
1314

@@ -45,7 +46,7 @@ The blobs directory MAY be missing referenced blobs, in which case the missing b
4546

4647
No semantic restriction is given for object names in the `refs` subdirectory.
4748
Each object in the `refs` subdirectory MUST be of type `application/vnd.oci.descriptor.v1+json`.
48-
In general the `mediatype` of this descriptor object will be either `application/vnd.oci.image.manifest.list.v1+json` or `application/vnd.oci.image.manifest.v1+json` although future versions of the spec MAY use a different mediatype.
49+
In general the `mediatype` of this [descriptor][descriptors] object will be either `application/vnd.oci.image.manifest.list.v1+json` or `application/vnd.oci.image.manifest.v1+json` although future versions of the spec MAY use a different mediatype.
4950

5051
This illustrates the expected contents of a given ref, the manifest list it points to and the blobs the manifest references.
5152

@@ -97,3 +98,5 @@ $ cat ./blobs/sha256-5b0bcabd1ed22e9fb1310cf6c2dec7cdef19f0ad69efa1f392e94a43335
9798
$ cat ./blobs/sha256-e692418e4cbaf90ca69d05a66403747baa33ee08806650b51fab815ad7fc331f
9899
[tar stream]
99100
```
101+
102+
[descriptors]: ./descriptor.md

0 commit comments

Comments
 (0)