Till Rohrmann created FLINK-25352:
-------------------------------------

             Summary: Update stability annotations to include the since and 
missedGraduations fields
                 Key: FLINK-25352
                 URL: https://issues.apache.org/jira/browse/FLINK-25352
             Project: Flink
          Issue Type: Sub-task
    Affects Versions: 1.15.0
            Reporter: Till Rohrmann
             Fix For: 1.15.0


In order to implement the graduation process outlined in FLIP-197, we need to 
extend our stability annotations to include a {{since}} and 
{{missedGraduations}} fields. 

The idea of {{since}} is that it tells since when something has this stability 
guarantee.

The idea of the {{missedGraduations}} field is to record reasons why an API has 
not been graduated.

{code}
@Target(ElementType.TYPE)
public @interface PublicEvolving {
 
   FlinkVersion since();
 
   GraduationMiss[] missedGraduations();
}
 
public @interface GraduationMiss {
   FlinkVersion graduation();
 
   String reason();
}
 
// Usage
@PublicEvolving(
       since = FlinkVersion.V1_11_0,
       missedGraduations = {
           @GraduationMiss(graduation = FlinkVersion.V1_13_0, reason = 
"foobar"),
           @GraduationMiss(graduation = FlinkVersion.V1_14_0, reason = "barfoo")
       })
public class Foobar {}
{code}



--
This message was sent by Atlassian Jira
(v8.20.1#820001)

Reply via email to