From 640682dacd619c99f7fb6bc8ead8df0389ec4383 Mon Sep 17 00:00:00 2001 From: pouchrobot Date: Wed, 10 Jan 2018 01:03:11 +0000 Subject: [PATCH] docs: auto generate pouch cli docs via code Signed-off-by: pouchrobot --- docs/api/api.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/api/api.md b/docs/api/api.md index a54f8b955..4bd7d336f 100644 --- a/docs/api/api.md +++ b/docs/api/api.md @@ -120,6 +120,13 @@ GET /containers/json ``` +#### Parameters + +|Type|Name|Description|Schema|Default| +|---|---|---|---|---| +|**Query**|**all**
*optional*|Return all containers. By default, only running containers are shown|boolean|`"false"`| + + #### Responses |HTTP Code|Description|Schema| @@ -1107,7 +1114,7 @@ GET "/containers/json" |Name|Description|Schema| |---|---|---| |**Command**
*optional*||string| -|**Created**
*optional*|Created time of container in daemon. !! Incompatibility !! Moby has a type of int64.|string| +|**Created**
*optional*|Created time of container in daemon.|integer (int64)| |**HostConfig**
*optional*|In Moby's API, HostConfig field in Container struct has following type
struct { NetworkMode string `json:",omitempty"` }
In Pouch, we need to pick runtime field in HostConfig from daemon side to judge runtime type,
So Pouch changes this type to be the complete HostConfig.
Incompatibility exists, ATTENTION.|[HostConfig](#hostconfig)| |**ID**
*optional*||string| |**Image**
*optional*||string| @@ -1115,6 +1122,7 @@ GET "/containers/json" |**Labels**
*optional*||< string, string > map| |**Mounts**
*optional*|Set of mount point in a container.|< [MountPoint](#mountpoint) > array| |**Names**
*optional*|**Example** : `[ "container_1", "container_2" ]`|< string > array| +|**NetworkSettings**
*optional*||object| |**SizeRootFs**
*optional*||integer (int64)| |**SizeRw**
*optional*||integer (int64)| |**State**
*optional*||string| @@ -1134,6 +1142,7 @@ Configuration for a container that is portable between hosts |**AttachStdout**
*optional*|Whether to attach to `stdout`.
**Default** : `true`|boolean| |**Cmd**
*optional*|Command to run specified an array of strings.|< string > array| |**Domainname**
*optional*|The domain name to use for the container.|string| +|**EnableLxcfs**
*optional*|Whether to enable lxcfs.|boolean| |**Entrypoint**
*optional*|The entry point for the container as a string or an array of strings.
If the array consists of exactly one empty string (`[""]`) then the entry point is reset to system default (i.e., the entry point used by pouch when there is no `ENTRYPOINT` instruction in the `Dockerfile`).|< string > array| |**Env**
*optional*|A list of environment variables to set inside the container in the form `["VAR=value", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value.|< string > array| |**ExposedPorts**
*optional*|An object mapping ports to an empty object in the form:`{/: {}}`|< string, object > map| @@ -1171,6 +1180,7 @@ It can be used to encode client params in client and unmarshal request body in d |**AttachStdout**
*optional*|Whether to attach to `stdout`.
**Default** : `true`|boolean| |**Cmd**
*optional*|Command to run specified an array of strings.|< string > array| |**Domainname**
*optional*|The domain name to use for the container.|string| +|**EnableLxcfs**
*optional*|Whether to enable lxcfs.|boolean| |**Entrypoint**
*optional*|The entry point for the container as a string or an array of strings.
If the array consists of exactly one empty string (`[""]`) then the entry point is reset to system default (i.e., the entry point used by pouch when there is no `ENTRYPOINT` instruction in the `Dockerfile`).|< string > array| |**Env**
*optional*|A list of environment variables to set inside the container in the form `["VAR=value", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value.|< string > array| |**ExposedPorts**
*optional*|An object mapping ports to an empty object in the form:`{/: {}}`|< string, object > map|