[
https://issues.apache.org/jira/browse/NIP-23?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18065440#comment-18065440
]
David Handermann commented on NIP-23:
-------------------------------------
Thanks for the additional background on possible use cases [~pvillard], I can
see how Registry Clients could be good candidates for these annotations.
One option that comes to mind is {{CapabilitityTag}}, aligning with
{{CapabilityDescription}}. Another possibility is {{CapabilityDescriptors}},
similar to {{PropertyDescriptor}}, but serving a different purpose. I think
{{Extension}} is implied based on the package location and intend usage.
{{Metadata}} is also implied, since annotations are metadata by definition,
thus prompting something a bit more specific, while still communicating the
open-ended nature of these key-value pairs.
> 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)