nifi-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Joseph Witt (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (NIFI-309) Support additional documentation annotations
Date Tue, 17 Mar 2015 18:37:38 GMT

     [ https://issues.apache.org/jira/browse/NIFI-309?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Joseph Witt updated NIFI-309:
-----------------------------
    Fix Version/s: 0.1.0

> 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
>            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.
> CreatesAttribute - indicates what attributes a Processor creates on outgoing FlowFile
attributes.  This would be reflected in the documentation.
> ModifiesAttribute - indicates what attributes a Processor modifies on outgoing FlowFiles.
 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)

Mime
View raw message