Skip to content

Commit

Permalink
Add clarifaction for WASM usecase
Browse files Browse the repository at this point in the history
Signed-off-by: James Sturtevant <jstur@microsoft.com>
  • Loading branch information
jsturtevant committed Oct 10, 2023
1 parent 93f6e65 commit 327c837
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 2 additions & 2 deletions artifacts-guidance.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Guidance for Artifacts Authors

Content other than OCI container images MAY be packaged using the image manifest.
When this is done, the `config.mediaType` value should not be a known OCI image config [media type](media-types.md).
Historically, due to registry limitations, some tools have created non-OCI conformant artifacts using the `application/vnd.oci.image.config.v1+json` value for `config.mediaType` and values specific to the artifact in `layer[*].mediaType`.
When this is done, the `config.mediaType` value MAY not be a known OCI image config [media type](media-types.md).
Historically, due to registry limitations, some tools have created non-OCI conformant artifacts using the `application/vnd.oci.image.config.v1+json` value for `config.mediaType` and values specific to the artifact in `layer[*].mediaType`. In some cases, the `application/vnd.oci.image.config.v1+json` may still be appropriate if the artifact is to be run via a runtime.
Implementation details and examples are provided in the [image manifest specification](manifest.md#guidelines-for-artifact-usage).
2 changes: 2 additions & 0 deletions manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,8 @@ The decision tree below and the associated examples MAY be used to design new ar
}
```

In the case where the artifact may be run by a runtime the `config.mediaType` MAY be `application/vnd.oci.image.config.v1+json`.

_Implementers note:_ artifacts have historically been created without an `artifactType` field, and tooling to work with artifacts should fallback to the `config.mediaType` value.

[iana]: https://www.iana.org/assignments/media-types/media-types.xhtml
Expand Down

0 comments on commit 327c837

Please sign in to comment.