summaryrefslogtreecommitdiff
path: root/API.md
diff options
context:
space:
mode:
authorDaniel J Walsh <dwalsh@redhat.com>2019-02-15 14:49:12 -0500
committerDaniel J Walsh <dwalsh@redhat.com>2019-02-15 15:30:09 -0500
commitb75dcd445848abad89e19f78193046a8de86c641 (patch)
treed9eec5056be5e240d49286f1d4894aedb252e407 /API.md
parent9c1b08fd79012c12d478edb13f6057a0414762db (diff)
downloadpodman-b75dcd445848abad89e19f78193046a8de86c641.tar.gz
podman-b75dcd445848abad89e19f78193046a8de86c641.tar.bz2
podman-b75dcd445848abad89e19f78193046a8de86c641.zip
Add registry name to fields returned by varlink image search
Cockpit team wants to list the registry name where the image was found. Also fix up SearchImages code to check if the user specified a registry in his call to use that rather then all the registries, This matches podman search command. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
Diffstat (limited to 'API.md')
-rwxr-xr-xAPI.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/API.md b/API.md
index a2d86d893..87cf6d242 100755
--- a/API.md
+++ b/API.md
@@ -107,7 +107,7 @@ in the [API.md](https://github.com/containers/libpod/blob/master/API.md) file in
[func RestartPod(name: string) string](#RestartPod)
-[func SearchImages(quety: string, limit: int, tlsVerify: ?bool) ImageSearchResult](#SearchImages)
+[func SearchImages(query: string, limit: int, tlsVerify: ?bool) ImageSearchResult](#SearchImages)
[func SendFile(type: string, length: int) string](#SendFile)
@@ -780,8 +780,9 @@ ReceiveFile allows the host to send a remote client a file
<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;">
method RemoveContainer(name: [string](https://godoc.org/builtin#string), force: [bool](https://godoc.org/builtin#bool), removeVolumes: [bool](https://godoc.org/builtin#bool)) [string](https://godoc.org/builtin#string)</div>
-RemoveContainer takes requires the name or ID of container as well a boolean representing whether a running
-container can be stopped and removed. It also takes a flag on whether or not to remove builtin volumes. Upon successful removal of the container, its ID is returned. If the
+RemoveContainer requires the name or ID of container as well a boolean representing whether a running container can be stopped and removed, and a boolean
+indicating whether to remove builtin volumes. Upon successful removal of the
+container, its ID is returned. If the
container cannot be found by name or ID, a [ContainerNotFound](#ContainerNotFound) error will be returned.
#### Example
~~~
@@ -1423,6 +1424,8 @@ is_official [bool](https://godoc.org/builtin#bool)
is_automated [bool](https://godoc.org/builtin#bool)
+registry [string](https://godoc.org/builtin#string)
+
name [string](https://godoc.org/builtin#string)
star_count [int](https://godoc.org/builtin#int)