diff options
author | Jelle van der Waa <jvanderwaa@redhat.com> | 2021-09-24 12:17:29 +0200 |
---|---|---|
committer | Jelle van der Waa <jvanderwaa@redhat.com> | 2021-09-24 12:27:55 +0200 |
commit | 3d8dec982f2dd4ad6eed56b5d694de66293e117d (patch) | |
tree | 3ffae06079ab94626d5bc4b103e8ebb7c27755f2 /pkg/api/server | |
parent | 800d594afa160353cc7134ef912bf82f266a122c (diff) | |
download | podman-3d8dec982f2dd4ad6eed56b5d694de66293e117d.tar.gz podman-3d8dec982f2dd4ad6eed56b5d694de66293e117d.tar.bz2 podman-3d8dec982f2dd4ad6eed56b5d694de66293e117d.zip |
Document missing /images/search query parameters
Include the tlsVerify, listTags query parameters for the compat and
libpod endpoint and document the default value for the amount of results
which are returned.
Signed-off-by: Jelle van der Waa <jvanderwaa@redhat.com>
Diffstat (limited to 'pkg/api/server')
-rw-r--r-- | pkg/api/server/register_images.go | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/pkg/api/server/register_images.go b/pkg/api/server/register_images.go index dce609a4e..5e0de7def 100644 --- a/pkg/api/server/register_images.go +++ b/pkg/api/server/register_images.go @@ -176,6 +176,7 @@ func (s *APIServer) registerImagesHandlers(r *mux.Router) error { // - in: query // name: limit // type: integer + // default: 25 // description: maximum number of results // - in: query // name: filters @@ -186,6 +187,11 @@ func (s *APIServer) registerImagesHandlers(r *mux.Router) error { // - `is-official=(true|false)` // - `stars=<number>` Matches images that has at least 'number' stars. // - in: query + // name: tlsVerify + // type: boolean + // default: false + // description: skip TLS verification for registries + // - in: query // name: listTags // type: boolean // description: list the available tags in the repository @@ -1075,6 +1081,7 @@ func (s *APIServer) registerImagesHandlers(r *mux.Router) error { // - in: query // name: limit // type: integer + // default: 25 // description: maximum number of results // - in: query // name: noTrunc @@ -1088,6 +1095,16 @@ func (s *APIServer) registerImagesHandlers(r *mux.Router) error { // - `is-automated=(true|false)` // - `is-official=(true|false)` // - `stars=<number>` Matches images that has at least 'number' stars. + // - in: query + // name: tlsVerify + // type: boolean + // default: false + // description: skip TLS verification for registries + // - in: query + // name: listTags + // type: boolean + // default: false + // description: list the available tags in the repository // produces: // - application/json // responses: |