feat: Introduce @ObsoleteApi #1887
Conversation
api-common-java/src/main/java/com/google/api/core/ObsoleteApi.java
Outdated
Show resolved
Hide resolved
api-common-java/src/main/java/com/google/api/core/ObsoleteApi.java
Outdated
Show resolved
Hide resolved
…java Co-authored-by: Mike Eltsufin <[email protected]>
…java Co-authored-by: Mike Eltsufin <[email protected]>
blakeli0
requested review from
suztomo,
lqiu96,
diegomarquezp,
burkedavison and
meltsufin
|
Maybe we can add a blurb here: https://github.com/googleapis/sdk-platform-java/blob/main/gax-java/README.md#versioning about this new annotation (I believe this annotation is going to be used in Gax?). |
Great idea! Added, PTAL. |
|
[gapic-generator-java-root] Kudos, SonarCloud Quality Gate passed!
|
|
[java_showcase_integration_tests] Kudos, SonarCloud Quality Gate passed!
|
|
[java_showcase_unit_tests] Kudos, SonarCloud Quality Gate passed!
|
This PR introduces
@ObsoleteApi. Deprecating any client side feature including adding@Deprecatedannotation is considered a breaking change based on the new support policy, hence we need an alternative way to signal us and customers that an API is deprecating. This annotation is not a direct replacement of@Deprecated, it's more like a pre-deprecation annotation, it has two major purposes:@ObsoleteApimethods to@Deprecatedbefore a major version release, and eventually remove it in another major version release.@Deprecatedsince IDE would strike through deprecated methods, but customers can see it easily through Javadocs while hovering over on it.