artifacts icon indicating copy to clipboard operation
artifacts copied to clipboard

Add clarity when `config` should be used in the `mediaType`

Open SteveLasker opened this issue 3 years ago • 0 comments

We initially focused on putting config in the mediaType, and including a +json on the extension, simply as momentum for how they were represented at the time.
We later clarified config should be reserved when there's actually a config object, and the +json|+yaml should be reserved to represent how the optional config blob is formatted.

The current docs at Defining a Unique Artifact Type don't clarify config, and show examples of using config, even though no config object is actually used.

TODO: Add clarity to define an artifact type with a shortened string, only including config in the string if an actual config object is represented, including +json|+yaml|+txt to represent the actually config formatting.

SteveLasker avatar Jul 13 '22 21:07 SteveLasker