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

Skip to content

Our API code is hard to understand #2306

@bgrant0607

Description

@bgrant0607

I've been digging through our API code in order to automatically document the API, and it's hard to understand.

The division between master and apiserver isn't clean, and the API machinery is spread out between (at least) api, runtime, conversion, version, and registry, with a seemingly arbitrary decomposition into files and a bewildering proliferation of interfaces (storage, codec, scheme, ...). Additionally, it's not obvious which code is used by the server, by clients, or both. Also, ideally, the generic machinery would be cleanly separated from Kubernetes's specific API object implementations.

After we get some API plugins working, I suggest we look hard at how to simplify and reorganize this.

/cc @lavalamp @smarterclayton

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/apiIndicates an issue on api area.kind/cleanupCategorizes issue or PR as related to cleaning up code, process, or technical debt.kind/documentationCategorizes issue or PR as related to documentation.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.sig/api-machineryCategorizes an issue or PR as relevant to SIG API Machinery.sig/contributor-experienceCategorizes an issue or PR as relevant to SIG Contributor Experience.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions