summaryrefslogtreecommitdiff
path: root/API.md
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2019-03-26 08:08:40 -0500
committerbaude <bbaude@redhat.com>2019-03-26 10:14:58 -0500
commit7f2221d48f7d0df8cc5beed70ff5dbc57bca3529 (patch)
tree7676e6ac3bd0ab34970d7a8f2616e4ebc5cd7ad8 /API.md
parent60b009af4ef1415b83e0419ba41381912693ab86 (diff)
downloadpodman-7f2221d48f7d0df8cc5beed70ff5dbc57bca3529.tar.gz
podman-7f2221d48f7d0df8cc5beed70ff5dbc57bca3529.tar.bz2
podman-7f2221d48f7d0df8cc5beed70ff5dbc57bca3529.zip
size is optional for container inspection
on the remote client, if a user wants to know the rootfs size of a container, a -s should be passed. this corrects a behavior where size was shown by default. Fixes #2765 Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'API.md')
-rwxr-xr-xAPI.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/API.md b/API.md
index 9751f5258..f7f5525bf 100755
--- a/API.md
+++ b/API.md
@@ -15,7 +15,7 @@ in the [API.md](https://github.com/containers/libpod/blob/master/API.md) file in
[func ContainerExists(name: string) int](#ContainerExists)
-[func ContainerInspectData(name: string) string](#ContainerInspectData)
+[func ContainerInspectData(name: string, size: bool) string](#ContainerInspectData)
[func ContainerRestore(name: string, keep: bool, tcpEstablished: bool) string](#ContainerRestore)
@@ -300,7 +300,7 @@ $ varlink call -m unix:/run/podman/io.podman/io.podman.ContainerExists '{"name":
### <a name="ContainerInspectData"></a>func ContainerInspectData
<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;">
-method ContainerInspectData(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div>
+method ContainerInspectData(name: [string](https://godoc.org/builtin#string), size: [bool](https://godoc.org/builtin#bool)) [string](https://godoc.org/builtin#string)</div>
ContainerInspectData returns a container's inspect data in string form. This call is for
development of Podman only and generally should not be used.
### <a name="ContainerRestore"></a>func ContainerRestore