github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-09-05 11:12:03 +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

2
docs/api.md
View File

@@ -38,7 +38,7 @@ Primary system and API concepts are documented in the [User guide](user-guide/RE
Overall API conventions are described in the [API conventions doc](devel/api-conventions.md).
Complete API details are documented via [Swagger](http://swagger.io/). The Kubernetes apiserver (aka "master") exports an API that can be used to retrieve the [Swagger spec](https://github.com/swagger-api/swagger-spec/tree/master/schemas/v1.2) for the Kubernetes API, by default at `/swaggerapi`, and a UI you can use to browse the API documentation at `/swagger-ui`. We also periodically update a [statically generated UI](http://kubernetes.io/third_party/swagger-ui/).
Complete API details are documented via [Swagger](http://swagger.io/). The Kubernetes apiserver (aka "master") exports an API that can be used to retrieve the [Swagger spec](https://github.com/swagger-api/swagger-spec/tree/master/schemas/v1.2) for the Kubernetes API, by default at `/swaggerapi`, and a UI you can use to browse the API documentation at `/swagger-ui`. We also host generated [API reference docs](api-reference/README.md).
Remote access to the API is discussed in the [access doc](admin/accessing-the-api.md).