Browse code

Merge pull request #34183 from thaJeztah/api-changelog-add-volume-created-at

Update API history and example response for volume CreatedAt

Sebastiaan van Stijn authored on 2017/07/20 05:13:34
Showing 3 changed files
... ...
@@ -1058,7 +1058,7 @@ definitions:
1058 1058
       CreatedAt:
1059 1059
         type: "string"
1060 1060
         format: "dateTime"
1061
-        description: "Time volume was created."
1061
+        description: "Date/Time the volume was created."
1062 1062
       Status:
1063 1063
         type: "object"
1064 1064
         description: |
... ...
@@ -6320,7 +6320,8 @@ paths:
6320 6320
           examples:
6321 6321
             application/json:
6322 6322
               Volumes:
6323
-                - Name: "tardis"
6323
+                - CreatedAt: "2017-07-19T12:00:26Z"
6324
+                  Name: "tardis"
6324 6325
                   Driver: "local"
6325 6326
                   Mountpoint: "/var/lib/docker/volumes/tardis"
6326 6327
                   Labels:
... ...
@@ -7,7 +7,7 @@ package types
7 7
 // swagger:model Volume
8 8
 type Volume struct {
9 9
 
10
-	// Time volume was created.
10
+	// Date/Time the volume was created.
11 11
 	CreatedAt string `json:"CreatedAt,omitempty"`
12 12
 
13 13
 	// Name of the volume driver used by the volume.
... ...
@@ -28,6 +28,13 @@ keywords: "API, Docker, rcli, REST, documentation"
28 28
 * `GET /images/(name)/get` now includes an `ImageMetadata` field which contains image metadata that is local to the engine and not part of the image config.
29 29
 * `POST /services/create` now accepts a `PluginSpec` when `TaskTemplate.Runtime` is set to `plugin`
30 30
 * `GET /events` now supports config events `create`, `update` and `remove` that are emitted when users create, update or remove a config
31
+* `GET /volumes/` and `GET /volumes/{name}` now return a `CreatedAt` field,
32
+  containing the date/time the volume was created. This field is omitted if the
33
+  creation date/time for the volume is unknown. For volumes with scope "global",
34
+  this field represents the creation date/time of the local _instance_ of the
35
+  volume, which may differ from instances of the same volume on different nodes.
36
+* `GET /system/df` now returns a `CreatedAt` field for `Volumes`. Refer to the
37
+  `/volumes/` endpoint for a description of this field.
31 38
 
32 39
 ## v1.30 API changes
33 40