[
https://issues.apache.org/jira/browse/NIP-23?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18065344#comment-18065344
]
Pierre Villard commented on NIP-23:
-----------------------------------
Thanks for the comment [~exceptionfactory] - this improvement would likely
mostly benefit developers building custom NiFi components that are provided
outside of the official NiFi repo in order to surface some specific details.
NIFI-15676 is already going to add support for for adding such information at
the NAR level but some metadata need to be at the component level when you have
many components in the same NAR. Exposing this information would likely be done
in the generated documentation of the components first, but my intent would be
to also leverage this information in the extensions registry clients (by
reading the extension manifest) (see NIP-4).
Regarding the naming, I did consider Label but it felt very generic and this is
already used in NiFi. I am definitely open to suggestions, it felt like the
best option at the time but we can come up with something better.
> 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)
