operator-framework / operator-framework/java-operator-sdk

Marking public APIs with `@Public` annotation

オープン
#3,419 コメント 0 件 リアクション 0 件 担当者 1 名 GitHub で見る

@csviri がすでに取り組んでいます。

2026年6月18日 から。

  • #3428 @csviri による — マージされずにクローズ
主要言語
Java
スター
944
フォーク
242
平均マージ
1日 4時間
マージ済み PR(30日)
43

説明

In order to better communicate - in terms of semver - which our APIs are considered public we should introduce @Public annotation, and mark appropriate classes / methods etc. Note this is source level compatibility, not binary.

Note that there are libraries that provide such annotations like:

  1. org.apiguardian:apiguardian-api:
@API(status = Status.STABLE)
@API(status = Status.EXPERIMENTAL)
@API(status = Status.INTERNAL)
@API(status = Status.MAINTAINED)
@API(status = Status.DEPRECATED)
  1. audience-annotations in yetus

For reference, Flink's own @Public/@PublicEvolving/@Experimental/@Internal in org.apache.flink.annotation are the same idea, but they're internal to Flink (and shaded), so not meant to be pulled in as a standalone dependency.

Notes

  • we have already @Experimental annotation.
  • this could be done an an inverse way, so marking internal API, butin our case would be probably harder to do (or more code)

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。