beenull/moby
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

api: swagger: add missing "platform" query-arg on create

Browse source 
Commit 7a9cb29fb9 added a new "platform" query-
parameter to the `POST /containers/create` endpoint, but did not update the
swagger file and documentation.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit 3dae8e9fc2)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2022-07-29 22:05:10 +02:00
parent ad0ee82f0d
commit af7c8ff045
No known key found for this signature in database
GPG key ID: 76698F39D527CE8C
2 changed files with 38 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
api/swagger.yaml
View file

@ -6210,6 +6210,28 @@ paths:
`/?[a-zA-Z0-9][a-zA-Z0-9_.-]+`.
type: "string"
pattern: "^/?[a-zA-Z0-9][a-zA-Z0-9_.-]+$"
- name: "platform"
in: "query"
description: |
Platform in the format `os[/arch[/variant]]` used for image lookup.
When specified, the daemon checks if the requested image is present
in the local image cache with the given OS and Architecture, and
otherwise returns a `404` status.
If the option is not set, the host's native OS and Architecture are
used to look up the image in the image cache. However, if no platform
is passed and the given image does exist in the local image cache,
but its OS or architecture does not match, the container is created
with the available image, and a warning is added to the `Warnings`
field in the response, for example;
WARNING: The requested image's platform (linux/arm64/v8) does not
match the detected host platform (linux/amd64) and no
specific platform was requested
type: "string"
default: ""
- name: "body"
in: "body"
description: "Container to create"

16
docs/api/version-history.md
View file

@ -136,6 +136,22 @@ keywords: "API, Docker, rcli, REST, documentation"
to limit the maximum number of PIDs.
* `GET /tasks` now returns `Pids` in `TaskTemplate.Resources.Limits`.
* `GET /tasks/{id}` now returns `Pids` in `TaskTemplate.Resources.Limits`.
* `POST /containers/create` now accepts a `platform` query parameter in the format
`os[/arch[/variant]]`.
When set, the daemon checks if the requested image is present in the local image
cache with the given OS and Architecture, and otherwise returns a `404` status.
If the option is _not_ set, the host's native OS and Architecture are used to
look up the image in the image cache. However, if no platform is passed and the
given image _does_ exist in the local image cache, but its OS or architecture
do not match, the container is created with the available image, and a warning
is added to the `Warnings` field in the response, for example;
WARNING: The requested image's platform (linux/arm64/v8) does not
match the detected host platform (linux/amd64) and no
specific platform was requested
* `POST /containers/create` on Linux now accepts the `HostConfig.CgroupnsMode` property.
Set the property to `host` to create the container in the daemon's cgroup namespace, or
`private` to create the container in its own private cgroup namespace. The per-daemon