summaryrefslogtreecommitdiff
path: root/API.md
diff options
context:
space:
mode:
authorValentin Rothberg <rothberg@redhat.com>2019-02-19 16:29:14 +0100
committerValentin Rothberg <rothberg@redhat.com>2019-02-20 10:25:25 +0100
commit6ae4401bd1c7988b84c6e1f715ca85ad74ee4048 (patch)
treef31b1150514ca1a1bfa64fc1ba1effb857d0c537 /API.md
parent8a49b59ed403b25340f315b3cb9ea90482ad6cd9 (diff)
downloadpodman-6ae4401bd1c7988b84c6e1f715ca85ad74ee4048.tar.gz
podman-6ae4401bd1c7988b84c6e1f715ca85ad74ee4048.tar.bz2
podman-6ae4401bd1c7988b84c6e1f715ca85ad74ee4048.zip
iopodman.SearchImages: add ImageSearchFilter to Varlink API
Also add some argument checks to the Varlink function to avoid referencing nil pointers, and complement the API.md descriptions. The varlink endpoint can be tested via varlink CLI: $ varlink call -m unix:/run/podman/io.podman/io.podman.SearchImages \ '{"query": "ruby", "limit": 0, "tlsVerify": false, "filter": {}}' Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
Diffstat (limited to 'API.md')
-rwxr-xr-xAPI.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/API.md b/API.md
index f61afbee4..c1d8c6a36 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(query: string, limit: int, tlsVerify: ?bool, filter: []string) ImageSearchResult](#SearchImages)
+[func SearchImages(query: string, limit: int, tlsVerify: ?bool, filter: ImageSearchFilter) ImageSearchResult](#SearchImages)
[func SendFile(type: string, length: int) string](#SendFile)
@@ -163,6 +163,8 @@ in the [API.md](https://github.com/containers/libpod/blob/master/API.md) file in
[type ImageHistory](#ImageHistory)
+[type ImageSearchFilter](#ImageSearchFilter)
+
[type ImageSearchResult](#ImageSearchResult)
[type InfoDistribution](#InfoDistribution)
@@ -1408,6 +1410,15 @@ tags [[]string](#[]string)
size [int](https://godoc.org/builtin#int)
comment [string](https://godoc.org/builtin#string)
+### <a name="ImageSearchFilter"></a>type ImageSearchFilter
+
+Represents a filter for SearchImages
+
+is_official [bool](https://godoc.org/builtin#bool)
+
+is_automated [bool](https://godoc.org/builtin#bool)
+
+star_count [int](https://godoc.org/builtin#int)
### <a name="ImageSearchResult"></a>type ImageSearchResult
Represents a single search result from SearchImages