GitList

Browse code

docs: fix NanoCPUs casing

While the field in the Go struct is named `NanoCPUs`, it has a JSON label to
use `NanoCpus`, which was added in the original pull request (not clear what
the reason was); 846baf1fd3efcbfbf9d3eb99e436ca9a59d3e185

Some notes:

- Golang processes field names case-insensitive, so when *using* the API,
both cases should work, but when inspecting a container, the field is
returned as `NanoCpus`.
- This only affects Containers.Resources. The `Limits` and `Reservation`
for SwarmKit services and SwarmKit "nodes" do not override the name
for JSON, so have the canonical (`NanoCPUs`) casing.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 8e2343ffd4cdaec67688a36aa82651b75806657a)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Sebastiaan van Stijn authored on 2021/02/10 21:02:27
Showing 18 changed files

docs/api/v1.25.yaml index 6328960..8b3e0e0 100644
docs/api/v1.26.yaml index 81e2961..5e3f8bd 100644
docs/api/v1.27.yaml index 29d8c6b..65e7251 100644
docs/api/v1.28.yaml index 3dcfb88..69e3c39 100644
docs/api/v1.29.yaml index 1e92ab4..d019c75 100644
docs/api/v1.30.yaml index 2a07117..a361ca0 100644
docs/api/v1.31.yaml index e8a4eba..f6eaf9a 100644
docs/api/v1.32.yaml index 499b11b..30e5975 100644
docs/api/v1.33.yaml index bf21ce9..6183925 100644
docs/api/v1.34.yaml index 11ac297..c81a4e4 100644
docs/api/v1.35.yaml index 0d78a41..43af829 100644
docs/api/v1.36.yaml index d381e38..91a5b3f 100644
docs/api/v1.37.yaml index a4de19d..8310ed7 100644
docs/api/v1.38.yaml index b29439f..45480c4 100644
docs/api/v1.39.yaml index ee017ea..2bec7bf 100644
docs/api/v1.40.yaml index 56a3e82..7c14ae0 100644
docs/api/v1.41.yaml index 9f10196..dc83822 100644
docs/api/version-history.md index 26637bf..65d6145 100644

@@ -416,7 +416,7 @@ definitions:
                              format: "int64"
                              minimum: 0
                              maximum: 100
                     -      NanoCPUs:
                     +      NanoCpus:
                              description: "CPU quota in units of 10<sup>-9</sup> CPUs."
                              type: "integer"
                              format: "int64"
@@ -2679,7 +2679,7 @@ paths:
                                      MemorySwap: 0
                                      MemoryReservation: 0
                                      KernelMemory: 0
                     -                NanoCPUs: 500000
                     +                NanoCpus: 500000
                                      CpuPercent: 80
                                      CpuShares: 512
                                      CpuPeriod: 100000

@@ -332,7 +332,7 @@ keywords: "API, Docker, rcli, REST, documentation"
                      * `POST /services/create` and `POST /services/(id or name)/update` now accept a `rollback` value for `FailureAction`.
                      * `POST /services/create` and `POST /services/(id or name)/update` now accept an optional `RollbackConfig` object which specifies rollback options.
                      * `GET /services` now supports a `mode` filter to filter services based on the service mode (either `global` or `replicated`).
                     -* `POST /containers/(name)/update` now supports updating `NanoCPUs` that represents CPU quota in units of 10<sup>-9</sup> CPUs.
                     +* `POST /containers/(name)/update` now supports updating `NanoCpus` that represents CPU quota in units of 10<sup>-9</sup> CPUs.
                      ## v1.27 API changes
@@ -388,7 +388,7 @@ keywords: "API, Docker, rcli, REST, documentation"
                      * The `hostConfig` option now accepts the fields `CpuRealtimePeriod` and `CpuRtRuntime` to allocate cpu runtime to rt tasks when `CONFIG_RT_GROUP_SCHED` is enabled in the kernel.
                      * The `SecurityOptions` field within the `GET /info` response now includes `userns` if user namespaces are enabled in the daemon.
                      * `GET /nodes` and `GET /node/(id or name)` now return `Addr` as part of a node's `Status`, which is the address that that node connects to the manager from.
                     -* The `HostConfig` field now includes `NanoCPUs` that represents CPU quota in units of 10<sup>-9</sup> CPUs.
                     +* The `HostConfig` field now includes `NanoCpus` that represents CPU quota in units of 10<sup>-9</sup> CPUs.
                      * `GET /info` now returns more structured information about security options.
                      * The `HostConfig` field now includes `CpuCount` that represents the number of CPUs available for execution by the container. Windows daemon only.
                      * `POST /services/create` and `POST /services/(id or name)/update` now accept the `TTY` parameter, which allocate a pseudo-TTY in container.