containers
/
podman
mirror of https://github.com/containers/podman.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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>
This commit is contained in:
Jelle van der Waa 2021-09-24 12:17:29 +02:00
parent 800d594afa
commit 3d8dec982f
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
pkg/api/server/register_images.go
View File

@ -176,6 +176,7 @@ func (s *APIServer) registerImagesHandlers(r *mux.Router) error {
// - in: query // - in: query
// name: limit // name: limit
// type: integer // type: integer
// default: 25
// description: maximum number of results // description: maximum number of results
// - in: query // - in: query
// name: filters // name: filters
@ -186,6 +187,11 @@ func (s *APIServer) registerImagesHandlers(r *mux.Router) error {
// - `is-official=(true|false)` // - `is-official=(true|false)`
// - `stars=<number>` Matches images that has at least 'number' stars. // - `stars=<number>` Matches images that has at least 'number' stars.
// - in: query // - in: query
// name: tlsVerify
// type: boolean
// default: false
// description: skip TLS verification for registries
// - in: query
// name: listTags // name: listTags
// type: boolean // type: boolean
// description: list the available tags in the repository // description: list the available tags in the repository
@ -1075,6 +1081,7 @@ func (s *APIServer) registerImagesHandlers(r *mux.Router) error {
// - in: query // - in: query
// name: limit // name: limit
// type: integer // type: integer
// default: 25
// description: maximum number of results // description: maximum number of results
// - in: query // - in: query
// name: noTrunc // name: noTrunc
@ -1088,6 +1095,16 @@ func (s *APIServer) registerImagesHandlers(r *mux.Router) error {
// - `is-automated=(true|false)` // - `is-automated=(true|false)`
// - `is-official=(true|false)` // - `is-official=(true|false)`
// - `stars=<number>` Matches images that has at least 'number' stars. // - `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: // produces:
// - application/json // - application/json
// responses: // responses: