forked from kubernetes/api
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Kubernetes-commit: 2b237717a851329a3861fac0f020f2ab96409edf
- Loading branch information
1 parent
ccdd560
commit 69a7b12
Showing
1 changed file
with
19 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |