From e8a1d99afb42d0931f7e1fd3df41611aafddf5a9 Mon Sep 17 00:00:00 2001 From: Boaz Shuster Date: Tue, 6 Jun 2017 21:33:02 +0300 Subject: [PATCH] Describe the differences between container-inspect and container-list Signed-off-by: Boaz Shuster --- api/swagger.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/api/swagger.yaml b/api/swagger.yaml index 14b5e4864c..fc9ecd39bc 100644 --- a/api/swagger.yaml +++ b/api/swagger.yaml @@ -2698,6 +2698,11 @@ paths: /containers/json: get: summary: "List containers" + description: | + Returns a list of containers. For details on the format, see [the inspect endpoint](#operation/ContainerInspect). + + Note that it uses a different, smaller representation of a container than inspecting a single container. For example, + the list of linked containers is not propagated . operationId: "ContainerList" produces: - "application/json"