summaryrefslogtreecommitdiff
path: root/cmd/podman/varlink
diff options
context:
space:
mode:
authorLars Karlitski <lars@karlitski.net>2019-02-04 20:39:23 +0100
committerLars Karlitski <lars@karlitski.net>2019-02-12 14:48:19 +0100
commit2448129e4d27b95ce172f0ab5ac32c891aae7519 (patch)
treea1476517f5beff8963246363da181a887ac8c7a1 /cmd/podman/varlink
parent5a325181709041ec01a4e60ed039bbd8cb7a20db (diff)
downloadpodman-2448129e4d27b95ce172f0ab5ac32c891aae7519.tar.gz
podman-2448129e4d27b95ce172f0ab5ac32c891aae7519.tar.bz2
podman-2448129e4d27b95ce172f0ab5ac32c891aae7519.zip
varlink: Rename `SearchImage` to `SearchImages`
Also rename image result struct to `ImageSearchResult` and make `limit` parameter optional. Signed-off-by: Lars Karlitski <lars@karlitski.net>
Diffstat (limited to 'cmd/podman/varlink')
-rw-r--r--cmd/podman/varlink/io.podman.varlink13
1 files changed, 6 insertions, 7 deletions
diff --git a/cmd/podman/varlink/io.podman.varlink b/cmd/podman/varlink/io.podman.varlink
index b53bc0788..72182cdc9 100644
--- a/cmd/podman/varlink/io.podman.varlink
+++ b/cmd/podman/varlink/io.podman.varlink
@@ -46,9 +46,8 @@ type ImageHistory (
comment: string
)
-# ImageSearch is the returned structure for SearchImage. It is returned
-# in array form.
-type ImageSearch (
+# Represents a single search result from SearchImages
+type ImageSearchResult (
description: string,
is_official: bool,
is_automated: bool,
@@ -644,10 +643,10 @@ method TagImage(name: string, tagged: string) -> (image: string)
# ~~~
method RemoveImage(name: string, force: bool) -> (image: string)
-# SearchImage takes the string of an image name and a limit of searches from each registries to be returned. SearchImage
-# will then use a glob-like match to find the image you are searching for. The images are returned in an array of
-# ImageSearch structures which contain information about the image as well as its fully-qualified name.
-method SearchImage(name: string, limit: int) -> (images: []ImageSearch)
+# SearchImages searches available registries for images that contain the
+# contents of "query" in their name. If "limit" is given, limits the amount of
+# search results per registry.
+method SearchImages(query: string, limit: ?int) -> (results: []ImageSearchResult)
# DeleteUnusedImages deletes any images not associated with a container. The IDs of the deleted images are returned
# in a string array.