proposal: use +json
postfix to mark json annotation values
#50
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi,
I'm following up to what was presented yesterday call, with #44, #49
I'd like to propose a more explicit way to distinguish annotations that are holding a string-based-representation of a known format which is not a pure string scalar, in this case string-based-representation of a JSON object.
This stems from the fact that in OCI spec, Annotations are indeed key-value pair of str-str scalars only.
ref https://github.com/opencontainers/image-spec/blob/64294bd7a2bf2537e1a6a34d687caae70300b0c4/annotations.md?plain=1#L9
I think using a string representation of a structured JSON object in the value is more than fine,
but imho we can make it even more explicit beyond writing in the document:
ref https://github.com/CloudNativeAI/model-spec/blob/main/docs/annotations.md?plain=1#L11C84-L11C108
by using a conventional
+suffix
making it even prominent without referring to the doc itself.wdyt?