summaryrefslogtreecommitdiff
path: root/API.md
diff options
context:
space:
mode:
authorMatthew Heon <matthew.heon@pm.me>2019-10-21 14:08:41 -0400
committerMatthew Heon <matthew.heon@pm.me>2019-10-21 14:37:27 -0400
commit03da8b641df1c03aea6f9faa3ddc2b0df64ec68b (patch)
treeb0df0c2407d83bbd8577edf830ff9436d9bee9c8 /API.md
parent6456f6da1742863e8119c0f4b2927f3b1300a942 (diff)
downloadpodman-03da8b641df1c03aea6f9faa3ddc2b0df64ec68b.tar.gz
podman-03da8b641df1c03aea6f9faa3ddc2b0df64ec68b.tar.bz2
podman-03da8b641df1c03aea6f9faa3ddc2b0df64ec68b.zip
Rewrite backend for remote 'volume inspect'
We need to use the new Inspect() endpoint instead of trying to JSON the actual volume structs. Currently, the output seems completely nonsensical; it seems like we're JSONing the struct for the Varlink connection itself? This should restore sanity and match the format of remote and local inspect on volumes. Signed-off-by: Matthew Heon <matthew.heon@pm.me>
Diffstat (limited to 'API.md')
-rwxr-xr-xAPI.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/API.md b/API.md
index a2a093bec..1cbdacb12 100755
--- a/API.md
+++ b/API.md
@@ -107,6 +107,8 @@ in the [API.md](https://github.com/containers/libpod/blob/master/API.md) file in
[func InspectPod(name: string) string](#InspectPod)
+[func InspectVolume(name: string) string](#InspectVolume)
+
[func KillContainer(name: string, signal: int) string](#KillContainer)
[func KillPod(name: string, signal: int) string](#KillPod)
@@ -804,6 +806,12 @@ method InspectPod(name: [string](https://godoc.org/builtin#string)) [string](htt
InspectPod takes the name or ID of an image and returns a string representation of data associated with the
pod. You must serialize the string into JSON to use it further. A [PodNotFound](#PodNotFound) error will
be returned if the pod cannot be found.
+### <a name="InspectVolume"></a>func InspectVolume
+<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;">
+
+method InspectVolume(name: [string](https://godoc.org/builtin#string)) [string](https://godoc.org/builtin#string)</div>
+InspectVolume inspects a single volume. Returns inspect JSON in the form of a
+string.
### <a name="KillContainer"></a>func KillContainer
<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;">