Selaa lähdekoodia

Merge pull request #45467 from thaJeztah/sync_api_docs

api: synchronize api/swagger.yaml with docs/api/v1.43.yaml
Sebastiaan van Stijn 2 vuotta sitten
vanhempi
commit
8d9a40a820
2 muutettua tiedostoa jossa 55 lisäystä ja 36 poistoa
  1. 8 0
      api/swagger.yaml
  2. 47 36
      docs/api/v1.43.yaml

+ 8 - 0
api/swagger.yaml

@@ -976,6 +976,13 @@ definitions:
             items:
             items:
               type: "integer"
               type: "integer"
               minimum: 0
               minimum: 0
+          Annotations:
+            type: "object"
+            description: |
+              Arbitrary non-identifying metadata attached to container and
+              provided to the runtime when the container is started.
+            additionalProperties:
+              type: "string"
 
 
           # Applicable to UNIX platforms
           # Applicable to UNIX platforms
           CapAdd:
           CapAdd:
@@ -1122,6 +1129,7 @@ definitions:
               remapping option is enabled.
               remapping option is enabled.
           ShmSize:
           ShmSize:
             type: "integer"
             type: "integer"
+            format: "int64"
             description: |
             description: |
               Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.
               Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.
             minimum: 0
             minimum: 0

+ 47 - 36
docs/api/v1.43.yaml

@@ -1618,6 +1618,34 @@ definitions:
           "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work"
           "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work"
         }
         }
 
 
+  FilesystemChange:
+    description: |
+      Change in the container's filesystem.
+    type: "object"
+    required: [Path, Kind]
+    properties:
+      Path:
+        description: |
+          Path to file or directory that has changed.
+        type: "string"
+        x-nullable: false
+      Kind:
+        $ref: "#/definitions/ChangeType"
+
+  ChangeType:
+    description: |
+      Kind of change
+
+      Can be one of:
+
+      - `0`: Modified ("C")
+      - `1`: Added ("A")
+      - `2`: Deleted ("D")
+    type: "integer"
+    format: "uint8"
+    enum: [0, 1, 2]
+    x-nullable: false
+
   ImageInspect:
   ImageInspect:
     description: |
     description: |
       Information about an image in the local image cache.
       Information about an image in the local image cache.
@@ -1754,15 +1782,14 @@ definitions:
           Total size of the image including all layers it is composed of.
           Total size of the image including all layers it is composed of.
 
 
           In versions of Docker before v1.10, this field was calculated from
           In versions of Docker before v1.10, this field was calculated from
-          the image itself and all of its parent images. Docker v1.10 and up
-          store images self-contained, and no longer use a parent-chain, making
-          this field an equivalent of the Size field.
+          the image itself and all of its parent images. Images are now stored
+          self-contained, and no longer use a parent-chain, making this field
+          an equivalent of the Size field.
 
 
-          This field is kept for backward compatibility, but may be removed in
-          a future version of the API.
+          > **Deprecated**: this field is kept for backward compatibility, but
+          > will be removed in API v1.44.
         type: "integer"
         type: "integer"
         format: "int64"
         format: "int64"
-        x-nullable: false
         example: 1239828
         example: 1239828
       GraphDriver:
       GraphDriver:
         $ref: "#/definitions/GraphDriverData"
         $ref: "#/definitions/GraphDriverData"
@@ -1810,7 +1837,6 @@ definitions:
       - Created
       - Created
       - Size
       - Size
       - SharedSize
       - SharedSize
-      - VirtualSize
       - Labels
       - Labels
       - Containers
       - Containers
     properties:
     properties:
@@ -1896,19 +1922,17 @@ definitions:
         x-nullable: false
         x-nullable: false
         example: 1239828
         example: 1239828
       VirtualSize:
       VirtualSize:
-        description: |
+        description: |-
           Total size of the image including all layers it is composed of.
           Total size of the image including all layers it is composed of.
 
 
           In versions of Docker before v1.10, this field was calculated from
           In versions of Docker before v1.10, this field was calculated from
-          the image itself and all of its parent images. Docker v1.10 and up
-          store images self-contained, and no longer use a parent-chain, making
-          this field an equivalent of the Size field.
+          the image itself and all of its parent images. Images are now stored
+          self-contained, and no longer use a parent-chain, making this field
+          an equivalent of the Size field.
 
 
-          This field is kept for backward compatibility, but may be removed in
-          a future version of the API.
+          Deprecated: this field is kept for backward compatibility, and will be removed in API v1.44.
         type: "integer"
         type: "integer"
         format: "int64"
         format: "int64"
-        x-nullable: false
         example: 172064416
         example: 172064416
       Labels:
       Labels:
         description: "User-defined key/value metadata."
         description: "User-defined key/value metadata."
@@ -4660,7 +4684,8 @@ definitions:
         example: false
         example: false
       OOMKilled:
       OOMKilled:
         description: |
         description: |
-          Whether this container has been killed because it ran out of memory.
+          Whether a process within this container has been killed because it ran
+          out of memory since the container was last started.
         type: "boolean"
         type: "boolean"
         example: false
         example: false
       Dead:
       Dead:
@@ -5250,7 +5275,8 @@ definitions:
       SecurityOptions:
       SecurityOptions:
         description: |
         description: |
           List of security features that are enabled on the daemon, such as
           List of security features that are enabled on the daemon, such as
-          apparmor, seccomp, SELinux, user-namespaces (userns), and rootless.
+          apparmor, seccomp, SELinux, user-namespaces (userns), rootless and
+          no-new-privileges.
 
 
           Additional configuration options for each security feature may
           Additional configuration options for each security feature may
           be present, and are included as a comma-separated list of key/value
           be present, and are included as a comma-separated list of key/value
@@ -6883,9 +6909,9 @@ paths:
         Returns which files in a container's filesystem have been added, deleted,
         Returns which files in a container's filesystem have been added, deleted,
         or modified. The `Kind` of modification can be one of:
         or modified. The `Kind` of modification can be one of:
 
 
-        - `0`: Modified
-        - `1`: Added
-        - `2`: Deleted
+        - `0`: Modified ("C")
+        - `1`: Added ("A")
+        - `2`: Deleted ("D")
       operationId: "ContainerChanges"
       operationId: "ContainerChanges"
       produces: ["application/json"]
       produces: ["application/json"]
       responses:
       responses:
@@ -6894,22 +6920,7 @@ paths:
           schema:
           schema:
             type: "array"
             type: "array"
             items:
             items:
-              type: "object"
-              x-go-name: "ContainerChangeResponseItem"
-              title: "ContainerChangeResponseItem"
-              description: "change item in response to ContainerChanges operation"
-              required: [Path, Kind]
-              properties:
-                Path:
-                  description: "Path to file that has changed"
-                  type: "string"
-                  x-nullable: false
-                Kind:
-                  description: "Kind of change"
-                  type: "integer"
-                  format: "uint8"
-                  enum: [0, 1, 2]
-                  x-nullable: false
+              $ref: "#/definitions/FilesystemChange"
           examples:
           examples:
             application/json:
             application/json:
               - Path: "/dev"
               - Path: "/dev"
@@ -8236,7 +8247,7 @@ paths:
 
 
             Available filters:
             Available filters:
 
 
-            - `until=<duration>`: duration relative to daemon's time, during which build cache was not used, in Go's duration format (e.g., '24h')
+            - `until=<timestamp>` remove cache older than `<timestamp>`. The `<timestamp>` can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon's local time.
             - `id=<id>`
             - `id=<id>`
             - `parent=<id>`
             - `parent=<id>`
             - `type=<string>`
             - `type=<string>`