summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authornikhiljindal <nikhiljindal@google.com>2016-03-16 15:17:03 -0700
committernikhiljindal <nikhiljindal@google.com>2016-03-16 15:47:30 -0700
commitdbc40f5a38a538c2a256c94f1fe14b73fd604ed9 (patch)
tree388614e319a58ea4e14bc14f74a290e1b621a7fb
parentffae1287d5299550cbf40adb84204d4ab2b173d4 (diff)
Add a README for api-reference docs and link to it instead of linking to swagger-ui
-rw-r--r--README.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/README.md b/README.md
index 188b395e..b1af07df 100644
--- a/README.md
+++ b/README.md
@@ -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.