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

Intrinsic functions: generate documentation #4310

Open
chillleader opened this issue Mar 13, 2025 · 0 comments
Open

Intrinsic functions: generate documentation #4310

chillleader opened this issue Mar 13, 2025 · 0 comments
Labels
kind:task Categorizes an issue or PR as general maintenance, i.e. cleanup, refactoring, etc.

Comments

@chillleader
Copy link
Member

What should we do?

We implemented intrinsic functions in #3843. We need to provide some documentation for the users/connector developers where all parameters of the out-of-the-box intrinsic functions are described.

e.g.:

  • base64 - can accept either string or document
  • generateLink - can only accept documents

and so on.

This can be generated because we already have reflection access to the params definition. We can do this using a Maven plugin, similarly to element-template-generator-maven-plugin.

Why should we do it?

To make it easier to know which functions can be used out-of-the-box and which parameters they can accept.

@chillleader chillleader added the kind:task Categorizes an issue or PR as general maintenance, i.e. cleanup, refactoring, etc. label Mar 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:task Categorizes an issue or PR as general maintenance, i.e. cleanup, refactoring, etc.
Projects
None yet
Development

No branches or pull requests

1 participant