[
https://issues.apache.org/jira/browse/NIFI-453?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14571304#comment-14571304
] Dan Bress commented on NIFI-453: -------------------------------- Joe, The doc generation will pull the description from allowable value and display it as a tool tip. This is really helpful for enumerations that have detailed meaning. Some processors are already taking advantage of this like GetTwitter. [Source code|https://github.com/apache/incubator-nifi/blob/develop/nifi/nifi-nar-bundles/nifi-social-media-bundle/nifi-twitter-processors/src/main/java/org/apache/nifi/processors/twitter/GetTwitter.java#L75-L77] and [generated output|https://nifi.incubator.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.twitter.GetTwitter/index.html] [Here|https://nifi.incubator.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.standard.Base64EncodeContent/index.html] [are|https://nifi.incubator.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.standard.CompressContent/index.html] [some|https://nifi.incubator.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.standard.ControlRate/index.html] [examples|https://nifi.incubator.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.hadoop.CreateHadoopSequenceFile/index.html] lacking AllowableValue descriptions. > When using AllowableValue specify a description > ----------------------------------------------- > > Key: NIFI-453 > URL: https://issues.apache.org/jira/browse/NIFI-453 > Project: Apache NiFi > Issue Type: Improvement > Components: Extensions > Affects Versions: 0.1.0 > Reporter: Dan Bress > Priority: Minor > > AllowableValue allows you to specify a description of the AllowableValue. > This can be very helpful for the conflict resolution strategies, as the > difference between "reject" "fail" and "ignore" might not be clear to new > users -- This message was sent by Atlassian JIRA (v6.3.4#6332)
