summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrian Goff <cpuguy83@gmail.com>2016-09-20 09:14:08 -0400
committerGitHub <noreply@github.com>2016-09-20 09:14:08 -0400
commit5fa94084ac049d455603565f517ada00117bc4d4 (patch)
treebd319c9b62b3340f51f4fca4b5138f3dcd33a3f9
parent00615efced8c8bd27c61ebd1dfc704bcf870cbaf (diff)
parent36a25bdbe4d973aef308fa11b450264dae1bc0b4 (diff)
downloaddocker-5fa94084ac049d455603565f517ada00117bc4d4.tar.gz
Merge pull request #26741 from thaJeztah/fix-api-docs
Fix incorrectly named API options
-rw-r--r--docs/reference/api/docker_remote_api.md2
-rw-r--r--docs/reference/api/docker_remote_api_v1.24.md12
-rw-r--r--docs/reference/api/docker_remote_api_v1.25.md12
3 files changed, 13 insertions, 13 deletions
diff --git a/docs/reference/api/docker_remote_api.md b/docs/reference/api/docker_remote_api.md
index 034db60a63..05136451c4 100644
--- a/docs/reference/api/docker_remote_api.md
+++ b/docs/reference/api/docker_remote_api.md
@@ -134,7 +134,7 @@ This section lists each version from latest to oldest. Each listing includes a
with ContainerD in Docker 1.11.
* `GET /networks` now supports filtering by `label` and `driver`.
* `GET /containers/json` now supports filtering containers by `network` name or id.
-* `POST /containers/create` now takes `MaximumIOps` and `MaximumIOBps` fields. Windows daemon only.
+* `POST /containers/create` now takes `IOMaximumBandwidth` and `IOMaximumIOps` fields. Windows daemon only.
* `POST /containers/create` now returns an HTTP 400 "bad parameter" message
if no command is specified (instead of an HTTP 500 "server error")
* `GET /images/search` now takes a `filters` query parameter.
diff --git a/docs/reference/api/docker_remote_api_v1.24.md b/docs/reference/api/docker_remote_api_v1.24.md
index 33fce6fea3..aa47a8fb21 100644
--- a/docs/reference/api/docker_remote_api_v1.24.md
+++ b/docs/reference/api/docker_remote_api_v1.24.md
@@ -299,8 +299,8 @@ Create a container
"CpuQuota": 50000,
"CpusetCpus": "0,1",
"CpusetMems": "0,1",
- "MaximumIOps": 0,
- "MaximumIOBps": 0,
+ "IOMaximumBandwidth": 0,
+ "IOMaximumIOps": 0,
"BlkioWeight": 300,
"BlkioWeightDevice": [{}],
"BlkioDeviceReadBps": [{}],
@@ -409,8 +409,8 @@ Create a container
- **CpuQuota** - Microseconds of CPU time that the container can get in a CPU period.
- **CpusetCpus** - String value containing the `cgroups CpusetCpus` to use.
- **CpusetMems** - Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.
- - **MaximumIOps** - Maximum IO absolute rate in terms of IOps.
- - **MaximumIOBps** - Maximum IO absolute rate in terms of bytes per second.
+ - **IOMaximumBandwidth** - Maximum IO absolute rate in terms of IOps.
+ - **IOMaximumIOps** - Maximum IO absolute rate in terms of bytes per second.
- **BlkioWeight** - Block IO weight (relative weight) accepts a weight value between 10 and 1000.
- **BlkioWeightDevice** - Block IO weight (relative device weight) in the form of: `"BlkioWeightDevice": [{"Path": "device_path", "Weight": weight}]`
- **BlkioDeviceReadBps** - Limit read rate (bytes per second) from a device in the form of: `"BlkioDeviceReadBps": [{"Path": "device_path", "Rate": rate}]`, for example:
@@ -558,8 +558,8 @@ Return low-level information on the container `id`
"ExecIDs": null,
"HostConfig": {
"Binds": null,
- "MaximumIOps": 0,
- "MaximumIOBps": 0,
+ "IOMaximumBandwidth": 0,
+ "IOMaximumIOps": 0,
"BlkioWeight": 0,
"BlkioWeightDevice": [{}],
"BlkioDeviceReadBps": [{}],
diff --git a/docs/reference/api/docker_remote_api_v1.25.md b/docs/reference/api/docker_remote_api_v1.25.md
index f2cd21a366..1cfd2d24f9 100644
--- a/docs/reference/api/docker_remote_api_v1.25.md
+++ b/docs/reference/api/docker_remote_api_v1.25.md
@@ -299,8 +299,8 @@ Create a container
"CpuQuota": 50000,
"CpusetCpus": "0,1",
"CpusetMems": "0,1",
- "MaximumIOps": 0,
- "MaximumIOBps": 0,
+ "IOMaximumBandwidth": 0,
+ "IOMaximumIOps": 0,
"BlkioWeight": 300,
"BlkioWeightDevice": [{}],
"BlkioDeviceReadBps": [{}],
@@ -413,8 +413,8 @@ Create a container
- **CpuQuota** - Microseconds of CPU time that the container can get in a CPU period.
- **CpusetCpus** - String value containing the `cgroups CpusetCpus` to use.
- **CpusetMems** - Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.
- - **MaximumIOps** - Maximum IO absolute rate in terms of IOps.
- - **MaximumIOBps** - Maximum IO absolute rate in terms of bytes per second.
+ - **IOMaximumBandwidth** - Maximum IO absolute rate in terms of IOps.
+ - **IOMaximumIOps** - Maximum IO absolute rate in terms of bytes per second.
- **BlkioWeight** - Block IO weight (relative weight) accepts a weight value between 10 and 1000.
- **BlkioWeightDevice** - Block IO weight (relative device weight) in the form of: `"BlkioWeightDevice": [{"Path": "device_path", "Weight": weight}]`
- **BlkioDeviceReadBps** - Limit read rate (bytes per second) from a device in the form of: `"BlkioDeviceReadBps": [{"Path": "device_path", "Rate": rate}]`, for example:
@@ -582,8 +582,8 @@ Return low-level information on the container `id`
"ExecIDs": null,
"HostConfig": {
"Binds": null,
- "MaximumIOps": 0,
- "MaximumIOBps": 0,
+ "IOMaximumBandwidth": 0,
+ "IOMaximumIOps": 0,
"BlkioWeight": 0,
"BlkioWeightDevice": [{}],
"BlkioDeviceReadBps": [{}],