Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[RFC] Major breaking changes in the upcoming release #974

Closed
@roycaihw

Description

@roycaihw

Hi Kubernetes Python client developers, this is a request for comment issue. Please leave comments if you have any opinion/suggestion. Thanks!

What happened:
A majority of the code base is generated code. This repo is switching from using swagger-codegen to using openapi-generator. For more backgrounds:

Major breaking changes were detected when we released 11.0.0a1 with openapi-generator:

The breaking changes are:

  1. [Major] kubernetes.client.apis package is renamed to kubernetes.client.api
  2. [Major] kubernetes package code now uses absolute import instead of relative import
  3. [Minor] The swagger_types attribute in all models is renamed to openapi_types

the major breaking changes come from swagger-api/swagger-codegen#6839 (comment), which is also in latest swagger-codegen. This repo didn't have these changes because we were depending on a old version of swagger-codegen.

What versions are affected?:

  • All 8.0.x, 9.0.x, 10.0.x versions are not affected
  • 11.0.0a1 (corresponding to Kubernetes 1.15) is the only version that's affected currently
  • The next release 11.0.0b1 and future releases (corresponding to Kubernetes 1.15, 1.16+) will be affected.

Impact and fix:

  • All clients that import kubernetes.client.apis must change the import to kubernetes.client.api when upgrading to 11.0.0b1+, to avoid import error.
  • Clients that use relative import and patch the kubernetes package locally may experience unexpected import error. Clients should install kubernetes package properly following the instructions in the Readme or the release page.

Metadata

Metadata

Assignees

Labels

api-reviewCategorizes an issue or PR as actively needing an API review.kind/bugCategorizes issue or PR as related to a bug.lifecycle/rottenDenotes an issue or PR that has aged beyond stale and will be auto-closed.priority/important-soonMust be staffed and worked on either currently, or very soon, ideally in time for the next release.release-note-action-requiredDenotes a PR that introduces potentially breaking changes that require user action.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions