search

in-toto / attestation

in-toto Attestation Framework
Other
212 stars 50 forks source link

Media Type directions in envelope.md aren't clear #343

Closed TomHennen closed 3 months ago

TomHennen commented 3 months ago

It says MUST match the predicate specification name without the file extension. Predicate versioning is handled in the Statement layer

When we wrote this I'm fairly certain we mean the predicate specification file name. It's the filename that would have an extension to omit and the filename within the linked destination (spec/predicates) is guaranteed to be unique. There isn't other name I'm aware of that would make sense here, but it's still not clear.

If we're agreed I'd be happy to send a PR.

marcelamelara commented 3 months ago

This is ambiguous, though at that time we also added in a requirement for a short predicate name to the ITE-9 spec, so it's quite possible that's the "name" envelope.md is referring to, the intent being that the filename be the predicateName, so I'm fine with specifying that the mediaType needs to match the filename.

TomHennen commented 3 months ago

This is ambiguous, though at that time we also added in a requirement for a short predicate name to the ITE-9 spec, so it's quite possible that's the "name" envelope.md is referring to, the intent being that the filename be the predicateName, so I'm fine with specifying that the mediaType needs to match the filename.

Oh I'd forgotten about that nuance. I don't think we have any examples of people specifying the short name anywhere (but maybe I'm missing it). So maybe we can just standardize on the way you specify that short name is by picking the filename. :)

adityasaky commented 3 months ago

I think that was a relatively new addition, and predicate specs haven't been updated with names...