From 3d8dec982f2dd4ad6eed56b5d694de66293e117d Mon Sep 17 00:00:00 2001 From: Jelle van der Waa Date: Fri, 24 Sep 2021 12:17:29 +0200 Subject: 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 --- pkg/api/server/register_images.go | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) 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=` 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=` 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: -- cgit v1.2.3-54-g00ecf