summaryrefslogtreecommitdiff
path: root/API.md
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2019-02-18 13:32:54 +0100
committerGitHub <noreply@github.com>2019-02-18 13:32:54 +0100
commite738ef16225395f5f5e4b93ba1a43ae9449ae11b (patch)
tree00c7d016a064a6efdf96d7fbcf5deb5e56ddf9ee /API.md
parentf2139a651706b10824a1641a360020d932798827 (diff)
parentb75dcd445848abad89e19f78193046a8de86c641 (diff)
downloadpodman-e738ef16225395f5f5e4b93ba1a43ae9449ae11b.tar.gz
podman-e738ef16225395f5f5e4b93ba1a43ae9449ae11b.tar.bz2
podman-e738ef16225395f5f5e4b93ba1a43ae9449ae11b.zip
Merge pull request #2354 from rhatdan/varlink
Add registry name to fields returned by varlink image search
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)