[
https://issues.apache.org/jira/browse/NIFI-1373?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Joseph Witt updated NIFI-1373:
------------------------------
Description:
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/
To Do:
1) Go through entire codebase and tag classes appropriate with Yetus
annotations.
2) Update our versioning guidance to reflect that our major/minor/incremental
model only applies to those classes which are tagged as stable/etc.. We should
be able to safely maneuver and update internal APIs without any risks to
compatibility. Through discussions things should become more stable and if we
find folks wanting to extend/alter things which we didn't have listed as stable
then those are great things to start discussion on. Right now we're too
hamstrung by thinking we have to hold onto everything.
was:
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/
> 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: 1.0.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/
> To Do:
> 1) Go through entire codebase and tag classes appropriate with Yetus
> annotations.
> 2) Update our versioning guidance to reflect that our major/minor/incremental
> model only applies to those classes which are tagged as stable/etc.. We
> should be able to safely maneuver and update internal APIs without any risks
> to compatibility. Through discussions things should become more stable and
> if we find folks wanting to extend/alter things which we didn't have listed
> as stable then those are great things to start discussion on. Right now
> we're too hamstrung by thinking we have to hold onto everything.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
