Преглед на файлове

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>
Sebastiaan van Stijn преди 2 години
родител
ревизия
982f09f837
променени са 1 файла, в които са добавени 22 реда и са изтрити 0 реда
  1. 22 0
      docs/api/v1.42.yaml

+ 22 - 0
docs/api/v1.42.yaml

@@ -6210,6 +6210,28 @@ paths:
             `/?[a-zA-Z0-9][a-zA-Z0-9_.-]+`.
             `/?[a-zA-Z0-9][a-zA-Z0-9_.-]+`.
           type: "string"
           type: "string"
           pattern: "^/?[a-zA-Z0-9][a-zA-Z0-9_.-]+$"
           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"
         - name: "body"
           in: "body"
           in: "body"
           description: "Container to create"
           description: "Container to create"