Uploaded image for project: 'Apache NiFi'
  1. Apache NiFi
  2. NIFI-309

Support additional documentation annotations

    Details

      Description

      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.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                danbress Dan Bress
                Reporter:
                danbress Dan Bress
              • Votes:
                0 Vote for this issue
                Watchers:
                6 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: