-
Notifications
You must be signed in to change notification settings - Fork 677
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.
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
Add reference field #828
Add reference field #828
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -44,6 +44,11 @@ The following fields contain the primary properties that constitute a Descriptor | |
This OPTIONAL property contains arbitrary metadata for this descriptor. | ||
This OPTIONAL property MUST use the [annotation rules](annotations.md#rules). | ||
|
||
- **`reference`** *descriptor* | ||
|
||
This OPTIONAL property contains a descriptor is the subject of the content described by this descriptor. | ||
This is used to associate multiple pieces of content. | ||
|
||
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. | ||
|
||
### Reserved | ||
|
@@ -176,6 +181,21 @@ In the following example, the descriptor indicates that the referenced manifest | |
} | ||
``` | ||
|
||
In the following example, the descriptor indicates that the referenced manifest is retrievable from a particular URL: | ||
|
||
```json | ||
{ | ||
"mediaType": "application/vnd.example.signature+json", | ||
"size": 3514, | ||
"digest": "sha256:19387f68117dbe07daeef0d99e018f7bbf7a660158d24949ea47bc12a3e4ba17", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this is the kind of place where multicodecs are useful https://github.com/multiformats/multicodec/blob/master/table.csv#L9 |
||
"reference": { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What is the use case of adding a reference to a descriptor? I understand it in the context of of a manifest or index object, but adding this field to the descriptor is creating lots of strange potential implementations where I'm not seeing the value add in present use cases. Is this being proposed in expectation of a descriptor as a manifest being approved, or are there other use cases? |
||
"mediaType": "application/vnd.docker.distribution.manifest.list.v2+json", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is a user supposed to read this as "this is the signature of the following manifest"? How would this work with "this is a list of SBoMs for the following manifest"? or "this is a list of signatures for the following manifest"? |
||
"size": 1201, | ||
"digest": "sha256:b4f9e18267eb98998f6130342baacaeb9553f136142d40959a1b46d6401f0f2b" | ||
} | ||
} | ||
``` | ||
|
||
[rfc3986]: https://tools.ietf.org/html/rfc3986 | ||
[rfc4634-s4.1]: https://tools.ietf.org/html/rfc4634#section-4.1 | ||
[rfc4634-s4.2]: https://tools.ietf.org/html/rfc4634#section-4.2 | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"which is the subject of"