OpenAssetIO / OpenAssetIO-MediaCreation

OpenAssetIO extensions for use in the Media Creation industry.
Apache License 2.0
12 stars 10 forks source link

Update trait/specification(s) to indicate required properties for `preflight` #52

Open foundrytom opened 1 year ago

foundrytom commented 1 year ago

What

Document any required trait properties for preflight

Why

OpenAssetIO recently changed the signature to Preflight, as a result some specifications may mandate that trait properties are required for preflight.

elliotcmorris commented 8 months ago

It might be best to assume everything is required and only indicate optional properties.

elliotcmorris commented 6 months ago

We have to go through all the properties in traits.yml and decide, "Is this property required."

Theres an argument that if we're adding a "required" field into the yaml, we should also traitgen that to be nice, but we don't have to, there's already a precedent with usage.

feltech commented 3 months ago

I think this issue has been misunderstood. The current GUIDELINES are pretty clear that trait properties are required by default.

I think this was specifically to call out which trait properties are required for preflight - not which traits are required for resolve(!)

I've updated the description to hopefully avoid misinterpretation again.