docs/api: update /containers/{id}/wait "condition" parameter (v1.30-v1.41)
This patch updates the swagger, and: - adds an enum definition to document valid values (instead of describing them) - updates the description to mention both "omitted" and "empty" values (although the former is already implicitly covered by the field being "optional" and having a default value). Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
parent
0e5929f99d
commit
41b137962d
12 changed files with 93 additions and 15 deletions
|
@ -4408,8 +4408,15 @@ paths:
|
|||
type: "string"
|
||||
- name: "condition"
|
||||
in: "query"
|
||||
description: "Wait until a container state reaches the given condition, either 'not-running' (default), 'next-exit', or 'removed'."
|
||||
description: |
|
||||
Wait until a container state reaches the given condition.
|
||||
|
||||
Defaults to `not-running` if omitted or empty.
|
||||
type: "string"
|
||||
enum:
|
||||
- "not-running"
|
||||
- "next-exit"
|
||||
- "removed"
|
||||
default: "not-running"
|
||||
tags: ["Container"]
|
||||
/containers/{id}:
|
||||
|
|
|
@ -4478,8 +4478,15 @@ paths:
|
|||
type: "string"
|
||||
- name: "condition"
|
||||
in: "query"
|
||||
description: "Wait until a container state reaches the given condition, either 'not-running' (default), 'next-exit', or 'removed'."
|
||||
description: |
|
||||
Wait until a container state reaches the given condition.
|
||||
|
||||
Defaults to `not-running` if omitted or empty.
|
||||
type: "string"
|
||||
enum:
|
||||
- "not-running"
|
||||
- "next-exit"
|
||||
- "removed"
|
||||
default: "not-running"
|
||||
tags: ["Container"]
|
||||
/containers/{id}:
|
||||
|
|
|
@ -5715,8 +5715,15 @@ paths:
|
|||
type: "string"
|
||||
- name: "condition"
|
||||
in: "query"
|
||||
description: "Wait until a container state reaches the given condition, either 'not-running' (default), 'next-exit', or 'removed'."
|
||||
description: |
|
||||
Wait until a container state reaches the given condition.
|
||||
|
||||
Defaults to `not-running` if omitted or empty.
|
||||
type: "string"
|
||||
enum:
|
||||
- "not-running"
|
||||
- "next-exit"
|
||||
- "removed"
|
||||
default: "not-running"
|
||||
tags: ["Container"]
|
||||
/containers/{id}:
|
||||
|
|
|
@ -5720,8 +5720,15 @@ paths:
|
|||
type: "string"
|
||||
- name: "condition"
|
||||
in: "query"
|
||||
description: "Wait until a container state reaches the given condition, either 'not-running' (default), 'next-exit', or 'removed'."
|
||||
description: |
|
||||
Wait until a container state reaches the given condition.
|
||||
|
||||
Defaults to `not-running` if omitted or empty.
|
||||
type: "string"
|
||||
enum:
|
||||
- "not-running"
|
||||
- "next-exit"
|
||||
- "removed"
|
||||
default: "not-running"
|
||||
tags: ["Container"]
|
||||
/containers/{id}:
|
||||
|
|
|
@ -5756,8 +5756,15 @@ paths:
|
|||
type: "string"
|
||||
- name: "condition"
|
||||
in: "query"
|
||||
description: "Wait until a container state reaches the given condition, either 'not-running' (default), 'next-exit', or 'removed'."
|
||||
description: |
|
||||
Wait until a container state reaches the given condition.
|
||||
|
||||
Defaults to `not-running` if omitted or empty.
|
||||
type: "string"
|
||||
enum:
|
||||
- "not-running"
|
||||
- "next-exit"
|
||||
- "removed"
|
||||
default: "not-running"
|
||||
tags: ["Container"]
|
||||
/containers/{id}:
|
||||
|
|
|
@ -5743,8 +5743,15 @@ paths:
|
|||
type: "string"
|
||||
- name: "condition"
|
||||
in: "query"
|
||||
description: "Wait until a container state reaches the given condition, either 'not-running' (default), 'next-exit', or 'removed'."
|
||||
description: |
|
||||
Wait until a container state reaches the given condition.
|
||||
|
||||
Defaults to `not-running` if omitted or empty.
|
||||
type: "string"
|
||||
enum:
|
||||
- "not-running"
|
||||
- "next-exit"
|
||||
- "removed"
|
||||
default: "not-running"
|
||||
tags: ["Container"]
|
||||
/containers/{id}:
|
||||
|
|
|
@ -5767,8 +5767,15 @@ paths:
|
|||
type: "string"
|
||||
- name: "condition"
|
||||
in: "query"
|
||||
description: "Wait until a container state reaches the given condition, either 'not-running' (default), 'next-exit', or 'removed'."
|
||||
description: |
|
||||
Wait until a container state reaches the given condition.
|
||||
|
||||
Defaults to `not-running` if omitted or empty.
|
||||
type: "string"
|
||||
enum:
|
||||
- "not-running"
|
||||
- "next-exit"
|
||||
- "removed"
|
||||
default: "not-running"
|
||||
tags: ["Container"]
|
||||
/containers/{id}:
|
||||
|
|
|
@ -5794,8 +5794,15 @@ paths:
|
|||
type: "string"
|
||||
- name: "condition"
|
||||
in: "query"
|
||||
description: "Wait until a container state reaches the given condition, either 'not-running' (default), 'next-exit', or 'removed'."
|
||||
description: |
|
||||
Wait until a container state reaches the given condition.
|
||||
|
||||
Defaults to `not-running` if omitted or empty.
|
||||
type: "string"
|
||||
enum:
|
||||
- "not-running"
|
||||
- "next-exit"
|
||||
- "removed"
|
||||
default: "not-running"
|
||||
tags: ["Container"]
|
||||
/containers/{id}:
|
||||
|
|
|
@ -5855,8 +5855,15 @@ paths:
|
|||
type: "string"
|
||||
- name: "condition"
|
||||
in: "query"
|
||||
description: "Wait until a container state reaches the given condition, either 'not-running' (default), 'next-exit', or 'removed'."
|
||||
description: |
|
||||
Wait until a container state reaches the given condition.
|
||||
|
||||
Defaults to `not-running` if omitted or empty.
|
||||
type: "string"
|
||||
enum:
|
||||
- "not-running"
|
||||
- "next-exit"
|
||||
- "removed"
|
||||
default: "not-running"
|
||||
tags: ["Container"]
|
||||
/containers/{id}:
|
||||
|
|
|
@ -6572,9 +6572,14 @@ paths:
|
|||
- name: "condition"
|
||||
in: "query"
|
||||
description: |
|
||||
Wait until a container state reaches the given condition, either
|
||||
'not-running' (default), 'next-exit', or 'removed'.
|
||||
Wait until a container state reaches the given condition.
|
||||
|
||||
Defaults to `not-running` if omitted or empty.
|
||||
type: "string"
|
||||
enum:
|
||||
- "not-running"
|
||||
- "next-exit"
|
||||
- "removed"
|
||||
default: "not-running"
|
||||
tags: ["Container"]
|
||||
/containers/{id}:
|
||||
|
|
|
@ -6710,9 +6710,14 @@ paths:
|
|||
- name: "condition"
|
||||
in: "query"
|
||||
description: |
|
||||
Wait until a container state reaches the given condition, either
|
||||
'not-running' (default), 'next-exit', or 'removed'.
|
||||
Wait until a container state reaches the given condition.
|
||||
|
||||
Defaults to `not-running` if omitted or empty.
|
||||
type: "string"
|
||||
enum:
|
||||
- "not-running"
|
||||
- "next-exit"
|
||||
- "removed"
|
||||
default: "not-running"
|
||||
tags: ["Container"]
|
||||
/containers/{id}:
|
||||
|
|
|
@ -6878,9 +6878,14 @@ paths:
|
|||
- name: "condition"
|
||||
in: "query"
|
||||
description: |
|
||||
Wait until a container state reaches the given condition, either
|
||||
'not-running' (default), 'next-exit', or 'removed'.
|
||||
Wait until a container state reaches the given condition.
|
||||
|
||||
Defaults to `not-running` if omitted or empty.
|
||||
type: "string"
|
||||
enum:
|
||||
- "not-running"
|
||||
- "next-exit"
|
||||
- "removed"
|
||||
default: "not-running"
|
||||
tags: ["Container"]
|
||||
/containers/{id}:
|
||||
|
|
Loading…
Reference in a new issue