Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce the metadata property to tasks and other concepts #945

Closed
ricardozanini opened this issue Aug 2, 2024 · 4 comments · Fixed by #996
Closed

Introduce the metadata property to tasks and other concepts #945

ricardozanini opened this issue Aug 2, 2024 · 4 comments · Fixed by #996
Assignees
Labels
area: spec Changes in the Specification change: feature New feature or request. Impacts in a minor version change
Milestone

Comments

@ricardozanini
Copy link
Member

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 ricardozanini added change: feature New feature or request. Impacts in a minor version change area: spec Changes in the Specification labels Aug 2, 2024
@ricardozanini ricardozanini added this to the v1.0.0-alpha3 milestone Aug 2, 2024
@matthias-pichler
Copy link
Collaborator

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

I am fine with either

@cdavernas
Copy link
Member

cdavernas commented Aug 5, 2024

@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 🤣

@ricardozanini ricardozanini changed the title Introduce the meta property to tasks and other concepts Introduce the metadata property to tasks and other concepts Aug 6, 2024
@ricardozanini
Copy link
Member Author

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

@matthias-pichler
Copy link
Collaborator

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 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: spec Changes in the Specification change: feature New feature or request. Impacts in a minor version change
Projects
Status: Done
3 participants