Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding links to http://kubernetes.io/third_party/swagger-ui/ in our docs #4069

Merged
merged 1 commit into from
Feb 3, 2015
Merged

Adding links to http://kubernetes.io/third_party/swagger-ui/ in our docs #4069

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ If you're developing Kubernetes, docs are in the [devel](devel) folder.

Design docs are in [design](design).

API objects are explained at [http://kubernetes.io/third_party/swagger-ui/](http://kubernetes.io/third_party/swagger-ui/).

## Primary concepts

* **Overview** ([overview.md](overview.md)): A brief overview
Expand Down
14 changes: 8 additions & 6 deletions docs/api-conventions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,12 +98,8 @@ Kubernetes MAY return two resources from any API endpoint in special circumstanc

A "Status" object SHOULD be returned by an API when an operation is not successful (when the server would return a non 2xx HTTP status code). The status object contains fields for humans and machine consumers of the API to determine failures. The information in the status object supplements, but does not override, the HTTP status code's meaning.

An "Operation" object MAY be returned by any non-GET API if the operation may take a significant amount of time. The name of the Operation may be used to retrieve the final result of an operation at a later time.

TODO: More details (refer to another doc for details)

TODO: Use SelfLink to retrieve operation instead.


Synthetic Resources
-------------------
Expand All @@ -127,11 +123,10 @@ Kubernetes by convention exposes additional verbs as new endpoints with singular
* GET /watch/<resourceNamePlural> - Receive a stream of JSON objects corresponding to changes made to any resource of the given kind over time.
* GET /watch/<resourceNamePlural>/<name> - Receive a stream of JSON objects corresponding to changes made to the named resource of the given kind over time.
* GET /redirect/<resourceNamePlural>/<name> - If the named resource can be described by a URL, return an HTTP redirect to that URL instead of a JSON response. For example, a service exposes a port and IP address and a client could invoke the redirect verb to receive an HTTP 307 redirection to that port and IP.
* GET /proxy/<resourceNamePlural>/<name>/{subpath:*} - Proxy GET request to the named resource of the given kind. Can be used for example, to access log files on pods.

Support of additional verbs is not required for all object types.

TODO: document proxy

TODO: more documentation of Watch


Expand Down Expand Up @@ -229,3 +224,10 @@ Events
------

TODO: Document events (refer to another doc for details)


API Documentation
-----------------

API documentation can be found at [http://kubernetes.io/third_party/swagger-ui/](http://kubernetes.io/third_party/swagger-ui/).