You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@nifi.apache.org by "Joseph Witt (JIRA)" <ji...@apache.org> on 2016/01/08 05:51:39 UTC

[jira] [Created] (NIFI-1373) Annotate all classes to indicate their API stability and intended audience

Joseph Witt created NIFI-1373:
---------------------------------

             Summary: Annotate all classes to indicate their API stability and intended audience
                 Key: NIFI-1373
                 URL: https://issues.apache.org/jira/browse/NIFI-1373
             Project: Apache NiFi
          Issue Type: Task
          Components: Core Framework, Core UI, Extensions
            Reporter: Joseph Witt
            Assignee: Joseph Witt
             Fix For: 0.6.0


Sean Busbey and Tony Kurc have pointed out the need to document the intended audience and stability of the APIs.  This is very necessary as we need to be able to make changes and be fluid where intended and extremely strict to compatibility where intended.  Presently with things being unmarked it can be ambiguous for those not deeply familiar with the api and codebase.

By leveraging the annotations from Apache Yetus we can resolve this discrepancy across the codebase:  http://yetus.apache.org/documentation/0.1.0/audience-annotations-apidocs/



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)