Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[20.10 backport] docs: assorted docs and swagger fixes #43260

Merged
merged 6 commits into from Mar 3, 2022
Merged

[20.10 backport] docs: assorted docs and swagger fixes #43260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ca5ba48
Fix typo on the v1.41 changelog
feliperuhland Apr 7, 2021
aa69e8e
Fixed exec resize success code in API docs
th0m4s Jan 5, 2022
42b13c0
Added error codes for exec resize in API docs
th0m4s Jan 5, 2022
a5a6971
docs: fixing /exec/{id}/resize response code in API documentation
thaJeztah Jan 10, 2022
fbbe1fc
api: remove HostConfig.LxcConf field
thaJeztah Jan 20, 2022
4679ffd
docs: remove HostConfig.LxcConf field from API docs
thaJeztah Jan 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 9 additions & 2 deletions api/swagger.yaml
View file
Open in desktop
Expand Up @@ -5755,7 +5755,6 @@ paths:
property1: "string"
property2: "string"
IpcMode: ""
LxcConf: []
Memory: 0
MemorySwap: 0
MemoryReservation: 0
Expand Down Expand Up @@ -8607,12 +8606,20 @@ paths:
if `tty` was specified as part of creating and starting the exec instance.
operationId: "ExecResize"
responses:
201:
200:
description: "No error"
400:
description: "bad parameter"
schema:
$ref: "#/definitions/ErrorResponse"
404:
description: "No such exec instance"
schema:
$ref: "#/definitions/ErrorResponse"
500:
description: "Server error"
schema:
$ref: "#/definitions/ErrorResponse"
parameters:
- name: "id"
in: "path"
Expand Down
1 change: 0 additions & 1 deletion docs/api/v1.22.md
View file
Open in desktop
Expand Up @@ -553,7 +553,6 @@ Return low-level information on the container `id`
"ExtraHosts": null,
"IpcMode": "",
"Links": null,
"LxcConf": [],
"Memory": 0,
"MemorySwap": 0,
"MemoryReservation": 0,
Expand Down
1 change: 0 additions & 1 deletion docs/api/v1.23.md
View file
Open in desktop
Expand Up @@ -579,7 +579,6 @@ Return low-level information on the container `id`
"ExtraHosts": null,
"IpcMode": "",
"Links": null,
"LxcConf": [],
"Memory": 0,
"MemorySwap": 0,
"MemoryReservation": 0,
Expand Down
1 change: 0 additions & 1 deletion docs/api/v1.24.md
View file
Open in desktop
Expand Up @@ -624,7 +624,6 @@ Return low-level information on the container `id`
"ExtraHosts": null,
"IpcMode": "",
"Links": null,
"LxcConf": [],
"Memory": 0,
"MemorySwap": 0,
"MemoryReservation": 0,
Expand Down
11 changes: 9 additions & 2 deletions docs/api/v1.25.yaml
View file
Open in desktop
Expand Up @@ -2975,7 +2975,6 @@ paths:
CpuRealtimeRuntime: 10000
Devices: []
IpcMode: ""
LxcConf: []
Memory: 0
MemorySwap: 0
MemoryReservation: 0
Expand Down Expand Up @@ -5679,12 +5678,20 @@ paths:
description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance."
operationId: "ExecResize"
responses:
201:
200:
description: "No error"
400:
description: "bad parameter"
schema:
$ref: "#/definitions/ErrorResponse"
404:
description: "No such exec instance"
schema:
$ref: "#/definitions/ErrorResponse"
500:
description: "Server error"
schema:
$ref: "#/definitions/ErrorResponse"
parameters:
- name: "id"
in: "path"
Expand Down
11 changes: 9 additions & 2 deletions docs/api/v1.26.yaml
View file
Open in desktop
Expand Up @@ -2980,7 +2980,6 @@ paths:
CpuRealtimeRuntime: 10000
Devices: []
IpcMode: ""
LxcConf: []
Memory: 0
MemorySwap: 0
MemoryReservation: 0
Expand Down Expand Up @@ -5688,12 +5687,20 @@ paths:
description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance."
operationId: "ExecResize"
responses:
201:
200:
description: "No error"
400:
description: "bad parameter"
schema:
$ref: "#/definitions/ErrorResponse"
404:
description: "No such exec instance"
schema:
$ref: "#/definitions/ErrorResponse"
500:
description: "Server error"
schema:
$ref: "#/definitions/ErrorResponse"
parameters:
- name: "id"
in: "path"
Expand Down
11 changes: 9 additions & 2 deletions docs/api/v1.27.yaml
View file
Open in desktop
Expand Up @@ -3040,7 +3040,6 @@ paths:
CpuRealtimeRuntime: 10000
Devices: []
IpcMode: ""
LxcConf: []
Memory: 0
MemorySwap: 0
MemoryReservation: 0
Expand Down Expand Up @@ -5763,12 +5762,20 @@ paths:
description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance."
operationId: "ExecResize"
responses:
201:
200:
description: "No error"
400:
description: "bad parameter"
schema:
$ref: "#/definitions/ErrorResponse"
404:
description: "No such exec instance"
schema:
$ref: "#/definitions/ErrorResponse"
500:
description: "Server error"
schema:
$ref: "#/definitions/ErrorResponse"
parameters:
- name: "id"
in: "path"
Expand Down
11 changes: 9 additions & 2 deletions docs/api/v1.28.yaml
View file
Open in desktop
Expand Up @@ -3130,7 +3130,6 @@ paths:
CpuRealtimeRuntime: 10000
Devices: []
IpcMode: ""
LxcConf: []
Memory: 0
MemorySwap: 0
MemoryReservation: 0
Expand Down Expand Up @@ -5879,12 +5878,20 @@ paths:
description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance."
operationId: "ExecResize"
responses:
201:
200:
description: "No error"
400:
description: "bad parameter"
schema:
$ref: "#/definitions/ErrorResponse"
404:
description: "No such exec instance"
schema:
$ref: "#/definitions/ErrorResponse"
500:
description: "Server error"
schema:
$ref: "#/definitions/ErrorResponse"
parameters:
- name: "id"
in: "path"
Expand Down
11 changes: 9 additions & 2 deletions docs/api/v1.29.yaml
View file
Open in desktop
Expand Up @@ -3164,7 +3164,6 @@ paths:
CpuRealtimeRuntime: 10000
Devices: []
IpcMode: ""
LxcConf: []
Memory: 0
MemorySwap: 0
MemoryReservation: 0
Expand Down Expand Up @@ -5913,12 +5912,20 @@ paths:
description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance."
operationId: "ExecResize"
responses:
201:
200:
description: "No error"
400:
description: "bad parameter"
schema:
$ref: "#/definitions/ErrorResponse"
404:
description: "No such exec instance"
schema:
$ref: "#/definitions/ErrorResponse"
500:
description: "Server error"
schema:
$ref: "#/definitions/ErrorResponse"
parameters:
- name: "id"
in: "path"
Expand Down
11 changes: 9 additions & 2 deletions docs/api/v1.30.yaml
View file
Open in desktop
Expand Up @@ -3382,7 +3382,6 @@ paths:
CpuRealtimeRuntime: 10000
Devices: []
IpcMode: ""
LxcConf: []
Memory: 0
MemorySwap: 0
MemoryReservation: 0
Expand Down Expand Up @@ -6149,12 +6148,20 @@ paths:
description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance."
operationId: "ExecResize"
responses:
201:
200:
description: "No error"
400:
description: "bad parameter"
schema:
$ref: "#/definitions/ErrorResponse"
404:
description: "No such exec instance"
schema:
$ref: "#/definitions/ErrorResponse"
500:
description: "Server error"
schema:
$ref: "#/definitions/ErrorResponse"
parameters:
- name: "id"
in: "path"
Expand Down
11 changes: 9 additions & 2 deletions docs/api/v1.31.yaml
View file
Open in desktop
Expand Up @@ -3452,7 +3452,6 @@ paths:
CpuRealtimeRuntime: 10000
Devices: []
IpcMode: ""
LxcConf: []
Memory: 0
MemorySwap: 0
MemoryReservation: 0
Expand Down Expand Up @@ -6242,12 +6241,20 @@ paths:
description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance."
operationId: "ExecResize"
responses:
201:
200:
description: "No error"
400:
description: "bad parameter"
schema:
$ref: "#/definitions/ErrorResponse"
404:
description: "No such exec instance"
schema:
$ref: "#/definitions/ErrorResponse"
500:
description: "Server error"
schema:
$ref: "#/definitions/ErrorResponse"
parameters:
- name: "id"
in: "path"
Expand Down
11 changes: 9 additions & 2 deletions docs/api/v1.32.yaml
View file
Open in desktop
Expand Up @@ -4691,7 +4691,6 @@ paths:
CpuRealtimeRuntime: 10000
Devices: []
IpcMode: ""
LxcConf: []
Memory: 0
MemorySwap: 0
MemoryReservation: 0
Expand Down Expand Up @@ -7279,12 +7278,20 @@ paths:
description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance."
operationId: "ExecResize"
responses:
201:
200:
description: "No error"
400:
description: "bad parameter"
schema:
$ref: "#/definitions/ErrorResponse"
404:
description: "No such exec instance"
schema:
$ref: "#/definitions/ErrorResponse"
500:
description: "Server error"
schema:
$ref: "#/definitions/ErrorResponse"
parameters:
- name: "id"
in: "path"
Expand Down
11 changes: 9 additions & 2 deletions docs/api/v1.33.yaml
View file
Open in desktop
Expand Up @@ -4696,7 +4696,6 @@ paths:
CpuRealtimeRuntime: 10000
Devices: []
IpcMode: ""
LxcConf: []
Memory: 0
MemorySwap: 0
MemoryReservation: 0
Expand Down Expand Up @@ -7288,12 +7287,20 @@ paths:
description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance."
operationId: "ExecResize"
responses:
201:
200:
description: "No error"
400:
description: "bad parameter"
schema:
$ref: "#/definitions/ErrorResponse"
404:
description: "No such exec instance"
schema:
$ref: "#/definitions/ErrorResponse"
500:
description: "Server error"
schema:
$ref: "#/definitions/ErrorResponse"
parameters:
- name: "id"
in: "path"
Expand Down
11 changes: 9 additions & 2 deletions docs/api/v1.34.yaml
View file
Open in desktop
Expand Up @@ -4725,7 +4725,6 @@ paths:
CpuRealtimeRuntime: 10000
Devices: []
IpcMode: ""
LxcConf: []
Memory: 0
MemorySwap: 0
MemoryReservation: 0
Expand Down Expand Up @@ -7334,12 +7333,20 @@ paths:
description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance."
operationId: "ExecResize"
responses:
201:
200:
description: "No error"
400:
description: "bad parameter"
schema:
$ref: "#/definitions/ErrorResponse"
404:
description: "No such exec instance"
schema:
$ref: "#/definitions/ErrorResponse"
500:
description: "Server error"
schema:
$ref: "#/definitions/ErrorResponse"
parameters:
- name: "id"
in: "path"
Expand Down
11 changes: 9 additions & 2 deletions docs/api/v1.35.yaml
View file
Open in desktop
Expand Up @@ -4707,7 +4707,6 @@ paths:
CpuRealtimeRuntime: 10000
Devices: []
IpcMode: ""
LxcConf: []
Memory: 0
MemorySwap: 0
MemoryReservation: 0
Expand Down Expand Up @@ -7346,12 +7345,20 @@ paths:
description: "Resize the TTY session used by an exec instance. This endpoint only works if `tty` was specified as part of creating and starting the exec instance."
operationId: "ExecResize"
responses:
201:
200:
description: "No error"
400:
description: "bad parameter"
schema:
$ref: "#/definitions/ErrorResponse"
404:
description: "No such exec instance"
schema:
$ref: "#/definitions/ErrorResponse"
500:
description: "Server error"
schema:
$ref: "#/definitions/ErrorResponse"
parameters:
- name: "id"
in: "path"
Expand Down