[
https://issues.apache.org/jira/browse/NIP-23?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18065260#comment-18065260
]
David Handermann commented on NIP-23:
-------------------------------------
This sounds like a useful addition for various things, but it would be helpful
to provide a bit more substance around a possible use case. The generated
documentation seems like a good place to start as described, is that the
primary location?
On the implementation, I suggest considering some alternative names for the
annotation. The final naming could be resolved in an implementation pull
request. This sounds analogous to Tags, except that there is both a Key and a
Value. One possibility might be Label, which is very generic, or LabeledTag.
> Extension Metadata Annotation
> -----------------------------
>
> Key: NIP-23
> URL: https://issues.apache.org/jira/browse/NIP-23
> Project: NiFi Improvement Proposal
> Issue Type: New Feature
> Reporter: Pierre Villard
> Priority: Major
>
> This NIP is to discuss the introduction of an additional annotation that
> could be used on extensions for developers to provide some specific
> information. This information could be automatically added as a table in the
> generated documentation as well as in the extension-manifest file so that it
> can be consumed by NiFi in different places (NAR loading, UI, etc).
> Here is a proposal
> {code:java}
> @Tags({"example", "demo"})
> @CapabilityDescription("Does something useful")
> @ExtensionMetadataEntries({
> @ExtensionMetadata(key = "abc", value = "foo"),
> @ExtensionMetadata(key = "def", value = "foo")
> })
> public class MyProcessor extends AbstractProcessor { ... }{code}
> This is a straightforward change in nifi-api and is completely backward
> compatible.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)