github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-09-09 05:01:46 +00:00
Code Issues Projects Releases Wiki Activity

Add a README for api-reference docs and link to it instead of linking to swagger-ui

Browse Source
This commit is contained in:
nikhiljindal
2016-03-16 15:17:03 -07:00
parent 067b1323d3
commit 2f6991cf38
5 changed files with 47 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/devel/README.md
View File

@@ -83,7 +83,8 @@ Guide](../admin/README.md).
## Developing against the Kubernetes API
* API objects are explained at [http://kubernetes.io/third_party/swagger-ui/](http://kubernetes.io/third_party/swagger-ui/).
* The [REST API documentation](../api-reference/README.md) explains the REST
API exposed by apiserver.
* **Annotations** ([docs/user-guide/annotations.md](../user-guide/annotations.md)): are for attaching arbitrary non-identifying metadata to objects.
Programs that automate Kubernetes objects may use annotations to store small amounts of their state.