[
https://issues.apache.org/jira/browse/NIFI-309?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14369644#comment-14369644
]
Mark Payne commented on NIFI-309:
---------------------------------
Dan,
Looking at the ReadsAttribute, WritesAttribute, it looks like the desire is to
use it as:
@ReadsAttributes({ @ReadsAttribute(attribute="", description="") })
@WritesAttributes({ @WritesAttribute(attribute="", description="") })
I would recommend changing ReadsAttribute and WritesAttribute to just
"Attribute" and then changing the "attribute" property to "name" so that it can
be written as:
@ReadsAttributes({ @Attribute(name="", description="") })
@WritesAttributes({ @Attribute(name="", description="") })
Or perhaps even changing the attribute to "value" so that it can be written as:
@ReadsAttributes({ @Attribute("name", description="description") })
@WritesAttributes({ @Attribute("otherAttr") })
> Support additional documentation annotations
> --------------------------------------------
>
> Key: NIFI-309
> URL: https://issues.apache.org/jira/browse/NIFI-309
> Project: Apache NiFi
> Issue Type: Improvement
> Components: Core Framework, Documentation & Website
> Affects Versions: 0.0.1
> Reporter: Dan Bress
> Assignee: Dan Bress
> Priority: Trivial
>
> Additional documentation only annotations should be added to better describe
> ConfigurableComponents. These annotations are:
> DynamicProperties - this would indicate whether a component supports dynamic
> properties or not, and provides a description. This could be used by the UI
> to determine whether or not to allow dynamic properties. It could also be
> reflected in the documentation.
> DynamicRelationships - this would indicate whether a component has dynamic
> relationships, like RouteOnAttribute and DistributeLoad do. This could be
> reflected in the documentation.
> ReadsAttribute - indicates what attributes a Processor reads certain FlowFile
> attributes on incoming FlowFiles. This would be reflected in the
> documentation.
> WritesAttribute - indicates what attributes a Processor creates on outgoing
> FlowFile attributes. This would be reflected in the documentation.
> SeeAlso - Provides a mechanism to link one configurable component to another.
> E.g. PutFile & GetFile. This would be used in the documentation.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
