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

Consider adding metadata to embedded workflows using assembly proxy classes #1109

Closed
glopesdev opened this issue Nov 1, 2022 · 0 comments · Fixed by #1138
Closed

Consider adding metadata to embedded workflows using assembly proxy classes #1109

glopesdev opened this issue Nov 1, 2022 · 0 comments · Fixed by #1138
Labels
proposal Request for a new feature
Milestone

Comments

@glopesdev
Copy link
Member

glopesdev commented Nov 1, 2022

The options for including metadata in embedded workflows packed with package assemblies are currently very limited. Apart from the description field, it is not possible to express any of the richness and flexibility of class attributes, e.g for indicating that an embedded workflow is obsolete, or that it should use a specific display name, etc.

One option to allow such flexibility would be to use proxy types in the assembly that would work as stand-in hosts for metadata associated with the embedded workflow. There could be a simple naming convention rule to associate these host classes with the embedded workflow. For example, assuming an embedded path MyAssembly:MyNamespace.MyFile.bonsai, the corresponding type name might be MyAssembly.MyNamespace.MyFile.

When loading package embedded workflows into the toolbox, the editor could look for the existence of the corresponding host class, and if present, use the attribute metadata associated with that type for the toolbox.

Another advantage of such an approach is that it would require no changes to core types and packages, as this strategy could be applied and used only at the editor level.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
proposal Request for a new feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant