summaryrefslogtreecommitdiff
path: root/pkg/api
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2021-04-08 11:39:09 -0400
committerGitHub <noreply@github.com>2021-04-08 11:39:09 -0400
commit99e3111814225e4e0cb2c7dc882b7f2e450d70aa (patch)
tree2c1ffa43879efa345fc831507db92b2a3c676279 /pkg/api
parente6a5c0ffc1df78bf08aa25f4fe734b46a846a5d7 (diff)
parent6f6dad40484de4c776b6e880438652fd90bbb219 (diff)
downloadpodman-99e3111814225e4e0cb2c7dc882b7f2e450d70aa.tar.gz
podman-99e3111814225e4e0cb2c7dc882b7f2e450d70aa.tar.bz2
podman-99e3111814225e4e0cb2c7dc882b7f2e450d70aa.zip
Merge pull request #9968 from pablofsf/fix-libpod-container-wait-docs
[CI:DOCS] Adjust libpod API Container Wait documentation to the code
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: