[ 
https://issues.apache.org/jira/browse/NIFI-309?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14367888#comment-14367888
 ] 

ASF GitHub Bot commented on NIFI-309:
-------------------------------------

GitHub user danbress opened a pull request:

    https://github.com/apache/incubator-nifi/pull/37

    NIFI-309

    This pull request closes NIFI-309
    Adds support for SeeAlso, ReadsAttributes, WritesAttributes, 
DynamicProperties, DynamicRelationship
    
    This further reduces the amount of stuff that developers are putting in 
additionalDetails.html

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/danbress/incubator-nifi NIFI-309-rebased

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/incubator-nifi/pull/37.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #37
    
----
commit d8731c63fff8cefdc42ca9789625330a93fd056d
Author: danbress <[email protected]>
Date:   2015-03-05T16:04:16Z

    NIFI-309 - Adding support for Reads/Writes Attributes

commit 0143f11448f1c62419f48c263ec23c6bbca28344
Author: danbress <[email protected]>
Date:   2015-03-05T16:20:51Z

    NIFI-309 - Adding support or SeeAlso

commit aaa9945d5b8ccc8ab027b6b941c19ec22386bdc7
Author: danbress <[email protected]>
Date:   2015-03-05T16:29:34Z

    NIFI-309 - writing javadoc

commit 0306c5019501a12fb638e08e2683de9de9a6ac63
Author: danbress <[email protected]>
Date:   2015-03-05T17:23:25Z

    NIFI-309 - Adding doc annotations to std processors

commit 796120c5430677ceb12f07ebda01cc61febfcb65
Author: danbress <[email protected]>
Date:   2015-03-05T19:01:24Z

    NIFI-309 better support for See also using class names

commit 9e1bf56d72f85b9775022dcfd16e08f1d1a49648
Author: danbress <[email protected]>
Date:   2015-03-05T19:06:32Z

    NIFI-309 adding SeeAlso to standard services

commit 8d0969d43d9d9fe9b23894c0c0390e064a31d851
Author: danbress <[email protected]>
Date:   2015-03-05T19:19:20Z

    NIFI-309 adding documentation attributes to processors

commit f33b7d73d00965c353e34ff6216e2311bcd38753
Author: danbress <[email protected]>
Date:   2015-03-05T19:53:31Z

    NIFI-309 fixing bug when dealing with string class names

commit 6387a0f93864f30b8f22d1eab9607626e437170e
Author: danbress <[email protected]>
Date:   2015-03-06T14:56:44Z

    NIFI-309 Updating additionalDetails.html or removing
    based what is contained in new annotations

commit 677d16513669308fd861975a86ade62063369034
Author: danbress <[email protected]>
Date:   2015-03-06T15:20:25Z

    NIFI-309 cleaning up formatting of MergeContent

commit 4057109e2c7ed16cb505a1d99cb8d0298285c724
Author: danbress <[email protected]>
Date:   2015-03-08T16:00:11Z

    NIFI-309 documenting @SeeAlso, @ReadsAttributes, @WritesAttributes

commit ac8cb85c7ec7cd3db5060b90a6cde435b3f14955
Author: danbress <[email protected]>
Date:   2015-03-08T16:03:27Z

    NIFI-309 adding javadoc

commit c6184885b84414d01d4cc176a06870aa85a158a9
Author: danbress <[email protected]>
Date:   2015-03-18T13:05:05Z

    Merge branch 'NIFI-309' into NIFI-309-rebased
    
    Conflicts:
        
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/main/java/org/apache/nifi/documentation/html/HtmlDocumentationWriter.java
        
nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/main/java/org/apache/nifi/documentation/html/HtmlProcessorDocumentationWriter.java
        
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/CompressContent.java
        
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/HashContent.java
        
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/IdentifyMimeType.java
        
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/SegmentContent.java
        
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/additionalDetails.html
        
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html
        
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.InvokeHTTP/additionalDetails.html
        
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MonitorActivity/additionalDetails.html
        
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PostHTTP/additionalDetails.html
        
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutSFTP/additionalDetails.html
        
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ScanContent/additionalDetails.html
        
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SegmentContent/additionalDetails.html
        
nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitContent/additionalDetails.html

commit e67b5d5514991b2b4c5fc5499f8b0a7cef6334b4
Author: danbress <[email protected]>
Date:   2015-03-18T17:41:57Z

    NIFI-309 - Adding DynamicProperty support

commit ebde81f8e435614569eed7ef547381e73f564a13
Author: danbress <[email protected]>
Date:   2015-03-18T17:59:13Z

    NIFI-309 supporting DynamicRelationships

commit b8d662e763241f15a0096d75f46922f49fd600f0
Author: danbress <[email protected]>
Date:   2015-03-18T19:23:34Z

    NIFI-309 - applying @DynamicProperty and @DynamicRelationships to processors

commit 170c4bd98624b4287f8a25bed073404ccc1d98e6
Author: danbress <[email protected]>
Date:   2015-03-18T19:30:50Z

    NIFI-309 making sure dynamic property exists

commit fc6aca548323089bd79d4f494b8c1959a5479762
Author: danbress <[email protected]>
Date:   2015-03-18T19:52:57Z

    NIFI-309 adding a value to @DynamicProperty
    this lets you describe the name, the value, and what the two together mean

commit 31a435f9ee21d59f77d67aca026491bde6f882b7
Author: danbress <[email protected]>
Date:   2015-03-18T20:00:55Z

    NIFI-309 - cleaning up additionalDetails.html

commit 28ac4d8ca566b0f81ee622a89ab661c1050314d2
Author: danbress <[email protected]>
Date:   2015-03-18T20:20:05Z

    NIFI-309 renaming DynamicRelationships

commit 840fee69359cb8ee9ea591a2b61571b61de1583f
Author: danbress <[email protected]>
Date:   2015-03-18T20:20:38Z

    NIFI-309 applying ASF License

commit 3b3898694a1bdddb4feb91f706568e4b3f87d92c
Author: danbress <[email protected]>
Date:   2015-03-18T20:20:57Z

    NIFI-309 renaming DynamicRelationships

commit ae1f01cd474ac0c4cf3e14cdc75c5d9a4de5ab1d
Author: danbress <[email protected]>
Date:   2015-03-18T20:37:11Z

    NIFI-309 cleaning up HandleHttpRequest/HandleHttpResponse docs

commit fc03bdd2e89125eaad9c23b706fe4f6102b0fac9
Author: danbress <[email protected]>
Date:   2015-03-18T20:55:28Z

    NIFI-309 removing print statement

----


> 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)

Reply via email to