[
https://issues.apache.org/jira/browse/FLINK-24483?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17460720#comment-17460720
]
Till Rohrmann commented on FLINK-24483:
---------------------------------------
I suggest to document the following source API stability guarantees:
|| Annotation || Meaning ||
|@Internal|API is internal and might change across releases (major, minor,
patch). This API can change between any two versions.|
|@Experimental|API can change across releases (major, minor, patch). This API
can change between any two versions.|
|@PublicEvolving|API is intended for public use but it can change across
releases (major, minor) → stable across 1.1.Z. A new minor release is required
to change this API.|
|@Public|API is intended for public use and it can only change across major
releases → stable across 1.Y.Z. A new major release is required for this API to
change.|
For that I propose to add document under {{/docs/dev/api_stability}}
> Document what is Public API and what compatibility guarantees Flink is
> providing
> --------------------------------------------------------------------------------
>
> Key: FLINK-24483
> URL: https://issues.apache.org/jira/browse/FLINK-24483
> Project: Flink
> Issue Type: Sub-task
> Components: API / DataStream, Documentation, Table SQL / API
> Affects Versions: 1.14.0, 1.12.5, 1.13.2
> Reporter: Piotr Nowojski
> Priority: Blocker
> Fix For: 1.15.0, 1.13.6, 1.14.3
>
>
> We should document:
> * What constitute of the Public API, what do
> Public/PublicEvolving/Experimental/Internal annotations mean.
> * What compatibility guarantees we are providing forward (backward?)
> functional/compile/binary compatibility for {{@Public}} interfaces?
> A good starting point:
> https://cwiki.apache.org/confluence/plugins/servlet/mobile?contentId=44302796#content/view/62686683
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
