summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorSebastiaan van Stijn <github@gone.nl>2022-07-29 22:10:01 +0200
committerSebastiaan van Stijn <github@gone.nl>2022-07-29 23:21:02 +0200
commit982f09f837ccfd40751bebbc8d4459530f3bb02f (patch)
tree7bebbe386b68556fdef36eacdba2812cf99495b3 /docs/api
parent1000e4ee7df6d973098565b3bf63687de2239492 (diff)
downloaddocker-982f09f837ccfd40751bebbc8d4459530f3bb02f.tar.gz
docs: api: add missing "platform" query-arg on create (v1.42)
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 <github@gone.nl>
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/v1.42.yaml22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/api/v1.42.yaml b/docs/api/v1.42.yaml
index 8f223c4a90..45b04e21f9 100644
--- a/docs/api/v1.42.yaml
+++ b/docs/api/v1.42.yaml
@@ -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"