summaryrefslogtreecommitdiff
path: root/pkg/api
diff options
context:
space:
mode:
authorPablo Correa Gómez <ablocorrea@hotmail.com>2021-04-07 18:56:37 +0200
committerPablo Correa Gómez <ablocorrea@hotmail.com>2021-04-07 19:01:10 +0200
commit6f6dad40484de4c776b6e880438652fd90bbb219 (patch)
treee1fb9163f1b8ea065c18042b78c5be10bcc50ee3 /pkg/api
parentf44645aad6822aee27c241f2f0f43bdbc652dc0a (diff)
downloadpodman-6f6dad40484de4c776b6e880438652fd90bbb219.tar.gz
podman-6f6dad40484de4c776b6e880438652fd90bbb219.tar.bz2
podman-6f6dad40484de4c776b6e880438652fd90bbb219.zip
Adjust libpod API Container Wait documentation to the code
Closes #9960 Signed-off-by: Pablo Correa Gómez <ablocorrea@hotmail.com>
Diffstat (limited to 'pkg/api')
-rw-r--r--pkg/api/server/register_containers.go13
1 files changed, 12 insertions, 1 deletions
diff --git a/pkg/api/server/register_containers.go b/pkg/api/server/register_containers.go
index c2bb44c8f..536c4707a 100644
--- a/pkg/api/server/register_containers.go
+++ b/pkg/api/server/register_containers.go
@@ -1194,11 +1194,22 @@ func (s *APIServer) registerContainersHandlers(r *mux.Router) error {
// - removing
// - stopping
// description: "Conditions to wait for. If no condition provided the 'exited' condition is assumed."
+ // - in: query
+ // name: interval
+ // type: string
+ // default: "250ms"
+ // description: Time Interval to wait before polling for completion.
// produces:
// - application/json
+ // - text/plain
// responses:
// 200:
- // $ref: "#/responses/ContainerWaitResponse"
+ // description: Status code
+ // schema:
+ // type: integer
+ // format: int32
+ // examples:
+ // text/plain: 137
// 404:
// $ref: "#/responses/NoSuchContainer"
// 500: