java icon indicating copy to clipboard operation
java copied to clipboard

Examples for `CoreV1Api.listNamespacedPod()` is incorrect for version 20 and beyond of the client

Open bcarld opened this issue 7 months ago • 3 comments

Describe the bug Client version 20.0.1 and beyond changed the signature for all of the CoreV1Api.list* by removing all of the parameters that allow selectors, but the release notes to do provide guidance on how to filter the list. After various web searches, I went to java doc and it does not provide any info (not too surprising since the javadoc is method specfic). I then went to the examples and found and example. But, it is older as it has all of the old parameters.

For compatibility breaking changes, it would be nice to have better documentation in the release notes with the recommended new method to do what the previous method can no longer do due to the reduction of parameters.

Client Version 20.0.1

Kubernetes Version e.g. 1.19.3

Java Version e.g. Java 8

To Reproduce Change 'io.kubernetes:client-java:19.0.1' to 'io.kubernetes:client-java:20.0.1' or later and try to build.

Expected behavior

  • release notes should reference documentation for recommendations on how to deal with a compatibility breaking change. -Code examples should either be for the latest code or reference the version to which the example applies.

Additional context My problem is a build break due to moving up versions to resolve a security vulnerability in one of the packages used by the java client.

bcarld avatar Jul 18 '24 13:07 bcarld