Add a README for api-reference docs and link to it instead of linking to swagger-ui #23080
+47
−4
Conversation
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
Closed
|
Labelling this PR as size/S |
k8s-github-robot
added
the
size/S
6 tasks
|
Labelling this PR as size/M |
k8s-github-robot
added
size/M
|
GCE e2e build/test passed for commit f01ff6aec2aa3a705638427e2b65f423e28287c7. |
|
GCE e2e build/test passed for commit 2f6991c. |
|
Thanks. Seems reasonable. @caesarxuchao PTAL. |
| @@ -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). | |||
There was a problem hiding this comment.
Is the /swagger-ui enabled on apiserver by default?
There was a problem hiding this comment.
Right now yes.
Will update the documentation in the PR where we disable it. #23025
|
LGTM. |
caesarxuchao
added
the
lgtm
|
@k8s-bot test this Tests are more than 48 hours old. Re-running tests. |
|
GCE e2e build/test failed for commit 2f6991c. Please reference the list of currently known flakes when examining this failure. If you request a re-test, you must reference the issue describing the flake. |
|
Automatic merge from submit-queue |
k8s-github-robot
pushed a commit
that referenced
this pull request
Mar 21, 2016
Auto commit by PR queue bot
xingzhou
pushed a commit
to xingzhou/kubernetes
that referenced
this pull request
Dec 15, 2016
Auto commit by PR queue bot
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #16049 and #15915.
http://kubernetes.io/third_party/swagger-ui/ does not work anymore with the new site upgrade. Ref kubernetes/website#112
cc @kubernetes/sig-api-machinery @bgrant0607 @caesarxuchao @kubernetes/docs