mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-07-23 19:56:01 +00:00
Merge pull request #57759 from LiliC/lili/add-api-readme
Update api README
This commit is contained in:
commit
f86218f90f
@ -1 +1,19 @@
|
||||
This repo is still in the experimental stage. Shortly it will contain the schema of the API that are served by the Kubernetes apiserver.
|
||||
# api
|
||||
|
||||
Schema of the external API types that are served by the Kubernetes API server.
|
||||
|
||||
## Purpose
|
||||
|
||||
This library is the canonical location of the Kubernetes API definition. Most likely interaction with this repository is as a dependency of client-go.
|
||||
|
||||
## Compatibility
|
||||
|
||||
Branches track Kubernetes branches and are compatible with that repo.
|
||||
|
||||
## Where does it come from?
|
||||
|
||||
`api` is synced from https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/api. Code changes are made in that location, merged into `k8s.io/kubernetes` and later synced here.
|
||||
|
||||
## Things you should *NOT* do
|
||||
|
||||
1. https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/api is synced to k8s.io/api. All changes must be made in the former. The latter is read-only.
|
||||
|
Loading…
Reference in New Issue
Block a user