specification icon indicating copy to clipboard operation
specification copied to clipboard

Introduce the `metadata` property to `tasks` and other concepts

Open ricardozanini opened this issue 1 year ago • 4 comments
trafficstars

What would you like to be added: As discussed in #928, there are a few use cases where metadata information is useful such as when designing a graphical interface for representing the DSL.

This field must not change the behavior of the workflow in runtime. For example: adding additional properties to a function call that only the given implementation would understand. The metadata information must describe static information regarding the workflow definition, not changing in any matter its behavior.

Why is this needed: Several times users and community members faced a situation where some dynamic data could be added to the DSL to facilitate some parts of an implementation and there was no room for it in the current DSL version.

Apart from the obvious include to the task object, other parts of the DSL must be assessed.

ricardozanini avatar Aug 02 '24 15:08 ricardozanini

Have we decided on the name meta yet? I remember @cdavernas preferring metadata to avoid abbreviations.

I am fine with either

matthias-pichler avatar Aug 05 '24 09:08 matthias-pichler

@matthias-pichler-warrify you are totally right. AFAIR, we had agreed on metadata indeed, as we should avoid abbreviations whenever possible. Plus, meta is now archi bloated, thanks to Zuckerberg 🤣

cdavernas avatar Aug 05 '24 09:08 cdavernas

We can use metadata, but I remember @matthias-pichler-warrify bringing the arg regarding the word usage in JSON spec.

ricardozanini avatar Aug 06 '24 21:08 ricardozanini

We can use metadata, but I remember @matthias-pichler-warrify bringing the arg regarding the word usage in JSON spec.

I am fine with either. I brought up JSON:API more for the concept 👍

matthias-pichler avatar Aug 06 '24 22:08 matthias-pichler