[
https://issues.apache.org/jira/browse/NIFI-309?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14366498#comment-14366498
]
Joseph Witt commented on NIFI-309:
----------------------------------
Dan,
I think we should also consider the following:
- These annotations aren't just for documentation purposes. We could in theory
evolve to support runtime type checking like validation on flow file attributes
based on the 'ReadsAttributes' annotation.
- We should also consider an annotation that lets the developer indicate
something like "PerformanceConsider" whereby they can signal for the UI and
documentation an important performance note for someone building the flow to
consider. For example, the processor EvaluateJSONPath has a note indicating it
reads the entire object into memory to do its thing. This is important because
it means there is a concern one should have in mind for object size and
concurrency and so on. Totally feasible one might warn of disk usage or cpu
usage for a given case.
Thanks
Joe
> 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
> Fix For: 0.1.0
>
>
> 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)
