[
https://issues.apache.org/jira/browse/NIFI-10704?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Paul Grey updated NIFI-10704:
-----------------------------
Description:
Component properties have both a "Display Name", which reflects the label used
in the NiFi UI, and an API name, which would be used to refer to the same
property in a NiFi API call. These usually are the same, but can differ. For
example, processor "GenerateFlowFile" [1] has a property CUSTOM_TEXT where
these differ [2].
The component document generation facility should be updated to provide both of
these names, to facilitate API usage.
[1]
https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.18.0/org.apache.nifi.processors.standard.GenerateFlowFile/index.html
[2]
https://github.com/apache/nifi/blob/feb3148b680916ad635f7f7205045b85aee30a0b/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/GenerateFlowFile.java#L105-L106
> NiFi component documentation should reflect display name as well as API name
> ----------------------------------------------------------------------------
>
> Key: NIFI-10704
> URL: https://issues.apache.org/jira/browse/NIFI-10704
> Project: Apache NiFi
> Issue Type: Improvement
> Reporter: Paul Grey
> Assignee: Paul Grey
> Priority: Minor
>
> Component properties have both a "Display Name", which reflects the label
> used in the NiFi UI, and an API name, which would be used to refer to the
> same property in a NiFi API call. These usually are the same, but can
> differ. For example, processor "GenerateFlowFile" [1] has a property
> CUSTOM_TEXT where these differ [2].
> The component document generation facility should be updated to provide both
> of these names, to facilitate API usage.
> [1]
> https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.18.0/org.apache.nifi.processors.standard.GenerateFlowFile/index.html
> [2]
> https://github.com/apache/nifi/blob/feb3148b680916ad635f7f7205045b85aee30a0b/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/GenerateFlowFile.java#L105-L106
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
