Skip to content

Commit 192c3d7

Browse files
committed
descriptor: clarify platform and artifacts
Signed-off-by: Bjorn Neergaard <[email protected]>
1 parent b159b71 commit 192c3d7

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

descriptor.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,13 @@ The following fields contain the primary properties that constitute a Descriptor
5454

5555
- **`artifactType`** *string*
5656

57-
This OPTIONAL property contains the type of an artifact when the descriptor points to an [artifact](artifacts-guidance.md).
57+
This OPTIONAL property contains the type of an artifact when the descriptor points to an [Artifact](artifacts-guidance.md).
5858
This property MUST be the same as the `artifactType` of the referenced [manifest](manifest.md), or the `mediaType` of the `config` descriptor if an `artifactType` is not set.
5959
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].
6060

61-
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.
61+
Descriptors referencing an Image (as defined in the [artifacts guidance](artifacts-guidance.md)) SHOULD include the extended field `platform`.
62+
See [Image Index Property Descriptions](image-index.md#image-index-property-descriptions) for details.
63+
Artifacts as defined in the artifacts guidance MAY include the extended field `platform` when it improves discoverability or interoperability of the artifact.
6264

6365
### Reserved
6466

0 commit comments

Comments
 (0)