[jira] [Commented] (FLINK-8192) Properly annotate APIs of all Flink connectors with @Public / @PublicEvolving / @Internal
[
https://issues.apache.org/jira/browse/FLINK-8192?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16569914#comment-16569914
]
Tzu-Li (Gordon) Tai commented on FLINK-8192:
Yes, this has been completed. I've closed this ticket.
> Properly annotate APIs of all Flink connectors with @Public / @PublicEvolving
> / @Internal
> -
>
> Key: FLINK-8192
> URL: https://issues.apache.org/jira/browse/FLINK-8192
> Project: Flink
> Issue Type: Improvement
> Components: Streaming Connectors
>Reporter: Tzu-Li (Gordon) Tai
>Priority: Major
> Fix For: 1.6.0
>
>
> Currently, the APIs of the Flink connectors have absolutely no annotations on
> whether their usage is {{Public}} / {{PublicEvolving}} / or {{Internal}}.
> We have, for example, instances in the past where a user was mistakenly using
> an abstract internal base class in the Elasticsearch connector.
> This JIRA tracks the coverage of API usage annotation for all Flink shipped
> connectors. Ideally, a separate subtask should be created for each individual
> connector.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
[jira] [Commented] (FLINK-8192) Properly annotate APIs of all Flink connectors with @Public / @PublicEvolving / @Internal
[
https://issues.apache.org/jira/browse/FLINK-8192?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16569899#comment-16569899
]
Till Rohrmann commented on FLINK-8192:
--
Has this issue been completed [~tzulitai]? If yes, then we could close it. If
not, then we should update the fixVersion field accordingly.
> Properly annotate APIs of all Flink connectors with @Public / @PublicEvolving
> / @Internal
> -
>
> Key: FLINK-8192
> URL: https://issues.apache.org/jira/browse/FLINK-8192
> Project: Flink
> Issue Type: Improvement
> Components: Streaming Connectors
>Reporter: Tzu-Li (Gordon) Tai
>Priority: Major
> Fix For: 1.6.0
>
>
> Currently, the APIs of the Flink connectors have absolutely no annotations on
> whether their usage is {{Public}} / {{PublicEvolving}} / or {{Internal}}.
> We have, for example, instances in the past where a user was mistakenly using
> an abstract internal base class in the Elasticsearch connector.
> This JIRA tracks the coverage of API usage annotation for all Flink shipped
> connectors. Ideally, a separate subtask should be created for each individual
> connector.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
[jira] [Commented] (FLINK-8192) Properly annotate APIs of all Flink connectors with @Public / @PublicEvolving / @Internal
[
https://issues.apache.org/jira/browse/FLINK-8192?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16283523#comment-16283523
]
ASF GitHub Bot commented on FLINK-8192:
---
Github user greghogan commented on the issue:
https://github.com/apache/flink/pull/5138
Changes to the public API require a
[FLIP](https://cwiki.apache.org/confluence/display/FLINK/Flink+Improvement+Proposals).
> Properly annotate APIs of all Flink connectors with @Public / @PublicEvolving
> / @Internal
> -
>
> Key: FLINK-8192
> URL: https://issues.apache.org/jira/browse/FLINK-8192
> Project: Flink
> Issue Type: Improvement
> Components: Streaming Connectors
>Reporter: Tzu-Li (Gordon) Tai
> Fix For: 1.5.0
>
>
> Currently, the APIs of the Flink connectors have absolutely no annotations on
> whether their usage is {{Public}} / {{PublicEvolving}} / or {{Internal}}.
> We have, for example, instances in the past where a user was mistakenly using
> an abstract internal base class in the Elasticsearch connector.
> This JIRA tracks the coverage of API usage annotation for all Flink shipped
> connectors. Ideally, a separate subtask should be created for each individual
> connector.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
[jira] [Commented] (FLINK-8192) Properly annotate APIs of all Flink connectors with @Public / @PublicEvolving / @Internal
[
https://issues.apache.org/jira/browse/FLINK-8192?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16283108#comment-16283108
]
ASF GitHub Bot commented on FLINK-8192:
---
GitHub user bowenli86 opened a pull request:
https://github.com/apache/flink/pull/5138
[FLINK-8192] Properly annotate APIs of flink-connector-kinesis
## What is the purpose of the change
Properly annotate classes in flink-connector-kinesis
## Brief change log
Properly annotate classes in flink-connector-kinesis
## Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
## Does this pull request potentially affect one of the following parts:
none
## Documentation
- Does this pull request introduce a new feature? (no)
- If yes, how is the feature documented? (JavaDocs)
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/bowenli86/flink FLINK-8192
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/5138.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #5138
commit f1e9f8ac1323eaae2aa2a028ff1d03d7a2fbf658
Author: Bowen Li
Date: 2017-12-07T08:02:16Z
annotate classes
commit e919aae934a0e9d7b65bb877acb64231e3b17120
Author: Bowen Li
Date: 2017-12-08T06:12:23Z
modify annotation
commit f5d68ddba2ea0fb65bff9b300c5347cd8f7c35f5
Author: Bowen Li
Date: 2017-12-08T06:16:34Z
modify annotations
> Properly annotate APIs of all Flink connectors with @Public / @PublicEvolving
> / @Internal
> -
>
> Key: FLINK-8192
> URL: https://issues.apache.org/jira/browse/FLINK-8192
> Project: Flink
> Issue Type: Improvement
> Components: Streaming Connectors
>Reporter: Tzu-Li (Gordon) Tai
> Fix For: 1.5.0
>
>
> Currently, the APIs of the Flink connectors have absolutely no annotations on
> whether their usage is {{Public}} / {{PublicEvolving}} / or {{Internal}}.
> We have, for example, instances in the past where a user was mistakenly using
> an abstract internal base class in the Elasticsearch connector.
> This JIRA tracks the coverage of API usage annotation for all Flink shipped
> connectors. Ideally, a separate subtask should be created for each individual
> connector.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
[jira] [Commented] (FLINK-8192) Properly annotate APIs of all Flink connectors with @Public / @PublicEvolving / @Internal
[
https://issues.apache.org/jira/browse/FLINK-8192?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16278179#comment-16278179
]
mingleizhang commented on FLINK-8192:
-
Okay. Thanks [~tzulitai]
> Properly annotate APIs of all Flink connectors with @Public / @PublicEvolving
> / @Internal
> -
>
> Key: FLINK-8192
> URL: https://issues.apache.org/jira/browse/FLINK-8192
> Project: Flink
> Issue Type: Improvement
> Components: Streaming Connectors
>Reporter: Tzu-Li (Gordon) Tai
> Fix For: 1.5.0
>
>
> Currently, the APIs of the Flink connectors have absolutely no annotations on
> whether their usage is {{Public}} / {{PublicEvolving}} / or {{Internal}}.
> We have, for example, instances in the past where a user was mistakenly using
> an abstract internal base class in the Elasticsearch connector.
> This JIRA tracks the coverage of API usage annotation for all Flink shipped
> connectors. Ideally, a separate subtask should be created for each individual
> connector.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
[jira] [Commented] (FLINK-8192) Properly annotate APIs of all Flink connectors with @Public / @PublicEvolving / @Internal
[
https://issues.apache.org/jira/browse/FLINK-8192?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16278159#comment-16278159
]
Tzu-Li (Gordon) Tai commented on FLINK-8192:
Sure thing [~mingleizhang]. It would also be good if you would like to work on
that!
> Properly annotate APIs of all Flink connectors with @Public / @PublicEvolving
> / @Internal
> -
>
> Key: FLINK-8192
> URL: https://issues.apache.org/jira/browse/FLINK-8192
> Project: Flink
> Issue Type: Improvement
> Components: Streaming Connectors
>Reporter: Tzu-Li (Gordon) Tai
> Fix For: 1.5.0
>
>
> Currently, the APIs of the Flink connectors have absolutely no annotations on
> whether their usage is {{Public}} / {{PublicEvolving}} / or {{Internal}}.
> We have, for example, instances in the past where a user was mistakenly using
> an abstract internal base class in the Elasticsearch connector.
> This JIRA tracks the coverage of API usage annotation for all Flink shipped
> connectors. Ideally, a separate subtask should be created for each individual
> connector.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
[jira] [Commented] (FLINK-8192) Properly annotate APIs of all Flink connectors with @Public / @PublicEvolving / @Internal
[
https://issues.apache.org/jira/browse/FLINK-8192?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16278030#comment-16278030
]
mingleizhang commented on FLINK-8192:
-
[~tzulitai] I would create a subtask of Elasticsearch if you think it is okay.
> Properly annotate APIs of all Flink connectors with @Public / @PublicEvolving
> / @Internal
> -
>
> Key: FLINK-8192
> URL: https://issues.apache.org/jira/browse/FLINK-8192
> Project: Flink
> Issue Type: Improvement
> Components: Streaming Connectors
>Reporter: Tzu-Li (Gordon) Tai
> Fix For: 1.5.0
>
>
> Currently, the APIs of the Flink connectors have absolutely no annotations on
> whether their usage is {{Public}} / {{PublicEvolving}} / or {{Internal}}.
> We have, for example, instances in the past where a user was mistakenly using
> an abstract internal base class in the Elasticsearch connector.
> This JIRA tracks the coverage of API usage annotation for all Flink shipped
> connectors. Ideally, a separate subtask should be created for each individual
> connector.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
