From 1000e4ee7df6d973098565b3bf63687de2239492 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Fri, 29 Jul 2022 22:08:48 +0200 Subject: [PATCH] docs: api: add missing "platform" query-arg on create (v1.41) Commit 7a9cb29fb980c0ab3928272cdc24c7089b2fcf64 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 --- docs/api/v1.41.yaml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/api/v1.41.yaml b/docs/api/v1.41.yaml index e5653eed5a..87425ae9c0 100644 --- a/docs/api/v1.41.yaml +++ b/docs/api/v1.41.yaml @@ -5960,6 +5960,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"