docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarify API documentation 

Notably, add *mostly* compatible with Remote API.

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
This commit is contained in:
Ben Firshman 2015-03-09 10:29:02 +00:00
parent 58a373b7bb
commit f9d024eab5
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
api/README.md
View File

@ -6,11 +6,11 @@ page_keywords: docker, swarm, clustering, api
# Docker Swarm API # Docker Swarm API
The Docker Swarm API is compatible with the [Offical Docker API](https://docs.docker.com/reference/api/docker_remote_api/): The Docker Swarm API is mostly compatible with the [Docker Remote API](https://docs.docker.com/reference/api/docker_remote_api/). This document is an overview of the differences between the Swarm API and the Docker Remote API.
Here are the main differences: ## Missing endpoints
## Some endpoints are not (yet) implemented Some endpoints have not yet been implemented and will return a 404 error.
``` ```
GET "/images/get" GET "/images/get"
@ -26,7 +26,7 @@ POST "/images/{name:.*}/tag"
DELETE "/images/{name:.*}" DELETE "/images/{name:.*}"
``` ```
## Some endpoints have more information ## Endpoints which behave differently
* `GET "/containers/{name:.*}/json"`: New field `Node` added: * `GET "/containers/{name:.*}/json"`: New field `Node` added: