[jira] [Comment Edited] (FLINK-32537) Add compatibility annotation for REST API classes

2023-07-05 Thread Hong Liang Teoh (Jira)


[ 
https://issues.apache.org/jira/browse/FLINK-32537?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17740266#comment-17740266
 ] 

Hong Liang Teoh edited comment on FLINK-32537 at 7/5/23 3:42 PM:
-

> We already know that though due to the compatibility tests.

 

Got it. [~chesnay] Is the proposal to close this Jira and leave as-is?


was (Author: JIRAUSER292614):
> We already know that though due to the compatibility tests.

 

Got it. [~chesnay] Is the proposal to ignore the `@Internal` or `@Public` for 
REST API classes?

> Add compatibility annotation for REST API classes
> -
>
> Key: FLINK-32537
> URL: https://issues.apache.org/jira/browse/FLINK-32537
> Project: Flink
>  Issue Type: Technical Debt
>  Components: Runtime / REST
>Affects Versions: 1.16.2, 1.17.1
>Reporter: Hong Liang Teoh
>Priority: Minor
> Fix For: 1.18.0
>
>
> *Why*
> We want to standardise the class labelling for Flink classes. Currently, the 
> compatibility annotations like @Public, @PublicEvolving, @Internal are not 
> present for REST API classes.
>  
> *What*
> We should be added @Internal for most Flink classes, unless they change the 
> REST API variables, so we know clearly which components will change our REST 
> API when changed



--
This message was sent by Atlassian Jira
(v8.20.10#820010)


[jira] [Comment Edited] (FLINK-32537) Add compatibility annotation for REST API classes

2023-07-05 Thread Chesnay Schepler (Jira)


[ 
https://issues.apache.org/jira/browse/FLINK-32537?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17740106#comment-17740106
 ] 

Chesnay Schepler edited comment on FLINK-32537 at 7/5/23 8:49 AM:
--

??so we know clearly which components will change our REST API when changed??

We already know that though due to the compatibility tests.

We'd just unnecessarily restrict us from changing things internally. None of 
the _classes_ are actually user-facing.


was (Author: zentol):
??so we know clearly which components will change our REST API when changed??

We already know that though due to the compatibility tests.

> Add compatibility annotation for REST API classes
> -
>
> Key: FLINK-32537
> URL: https://issues.apache.org/jira/browse/FLINK-32537
> Project: Flink
>  Issue Type: Technical Debt
>  Components: Runtime / REST
>Affects Versions: 1.16.2, 1.17.1
>Reporter: Hong Liang Teoh
>Priority: Minor
> Fix For: 1.18.0
>
>
> *Why*
> We want to standardise the class labelling for Flink classes. Currently, the 
> compatibility annotations like @Public, @PublicEvolving, @Internal are not 
> present for REST API classes.
>  
> *What*
> We should be added @Internal for most Flink classes, unless they change the 
> REST API variables, so we know clearly which components will change our REST 
> API when changed



--
This message was sent by Atlassian Jira
(v8.20.10#820010)


[jira] [Comment Edited] (FLINK-32537) Add compatibility annotation for REST API classes

2023-07-05 Thread Chesnay Schepler (Jira)


[ 
https://issues.apache.org/jira/browse/FLINK-32537?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17740106#comment-17740106
 ] 

Chesnay Schepler edited comment on FLINK-32537 at 7/5/23 8:48 AM:
--

??so we know clearly which components will change our REST API when changed??

We already know that though due to the compatibility tests.


was (Author: zentol):
> so we know clearly which components will change our REST API when changed

We already know that though due to the compatibility tests.

> Add compatibility annotation for REST API classes
> -
>
> Key: FLINK-32537
> URL: https://issues.apache.org/jira/browse/FLINK-32537
> Project: Flink
>  Issue Type: Technical Debt
>  Components: Runtime / REST
>Affects Versions: 1.16.2, 1.17.1
>Reporter: Hong Liang Teoh
>Priority: Minor
> Fix For: 1.18.0
>
>
> *Why*
> We want to standardise the class labelling for Flink classes. Currently, the 
> compatibility annotations like @Public, @PublicEvolving, @Internal are not 
> present for REST API classes.
>  
> *What*
> We should be added @Internal for most Flink classes, unless they change the 
> REST API variables, so we know clearly which components will change our REST 
> API when changed



--
This message was sent by Atlassian Jira
(v8.20.10#820010)