From f9d024eab5c867370d786286e9920b3fd1debe5d Mon Sep 17 00:00:00 2001 From: Ben Firshman Date: Mon, 9 Mar 2015 10:29:02 +0000 Subject: [PATCH] Clarify API documentation Notably, add *mostly* compatible with Remote API. Signed-off-by: Ben Firshman --- api/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/api/README.md b/api/README.md index 9bd0c46f57..95a49e9e45 100644 --- a/api/README.md +++ b/api/README.md @@ -6,11 +6,11 @@ page_keywords: docker, swarm, clustering, 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" @@ -26,7 +26,7 @@ POST "/images/{name:.*}/tag" DELETE "/images/{name:.*}" ``` -## Some endpoints have more information +## Endpoints which behave differently * `GET "/containers/{name:.*}/json"`: New field `Node` added: