Pārlūkot izejas kodu

Merge pull request #47451 from neersighted/image_created_omitempty_25.0

[25.0 backport] api: omit missing Created field from ImageInspect response
Bjorn Neergaard 1 gadu atpakaļ
vecāks
revīzija
6fb71a9764
4 mainītis faili ar 18 papildinājumiem un 8 dzēšanām
  1. 6 2
      api/swagger.yaml
  2. 4 1
      api/types/types.go
  3. 6 2
      docs/api/v1.44.yaml
  4. 2 3
      docs/api/version-history.md

+ 6 - 2
api/swagger.yaml

@@ -1742,9 +1742,13 @@ definitions:
       Created:
       Created:
         description: |
         description: |
           Date and time at which the image was created, formatted in
           Date and time at which the image was created, formatted in
-          [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds, or empty if the field was not set in the image config.
+          [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
+
+          This information is only available if present in the image,
+          and omitted otherwise.
         type: "string"
         type: "string"
-        x-nullable: false
+        format: "dateTime"
+        x-nullable: true
         example: "2022-02-04T21:20:12.497794809Z"
         example: "2022-02-04T21:20:12.497794809Z"
       Container:
       Container:
         description: |
         description: |

+ 4 - 1
api/types/types.go

@@ -72,7 +72,10 @@ type ImageInspect struct {
 
 
 	// Created is the date and time at which the image was created, formatted in
 	// Created is the date and time at which the image was created, formatted in
 	// RFC 3339 nano-seconds (time.RFC3339Nano).
 	// RFC 3339 nano-seconds (time.RFC3339Nano).
-	Created string
+	//
+	// This information is only available if present in the image,
+	// and omitted otherwise.
+	Created string `json:",omitempty"`
 
 
 	// Container is the ID of the container that was used to create the image.
 	// Container is the ID of the container that was used to create the image.
 	//
 	//

+ 6 - 2
docs/api/v1.44.yaml

@@ -1742,9 +1742,13 @@ definitions:
       Created:
       Created:
         description: |
         description: |
           Date and time at which the image was created, formatted in
           Date and time at which the image was created, formatted in
-          [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds, or empty if the field was not set in the image config.
+          [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
+
+          This information is only available if present in the image,
+          and omitted otherwise.
         type: "string"
         type: "string"
-        x-nullable: false
+        format: "dateTime"
+        x-nullable: true
         example: "2022-02-04T21:20:12.497794809Z"
         example: "2022-02-04T21:20:12.497794809Z"
       Container:
       Container:
         description: |
         description: |

+ 2 - 3
docs/api/version-history.md

@@ -79,9 +79,8 @@ keywords: "API, Docker, rcli, REST, documentation"
   `SecondaryIPv6Addresses` available in `NetworkSettings` when calling `GET /containers/{id}/json` are
   `SecondaryIPv6Addresses` available in `NetworkSettings` when calling `GET /containers/{id}/json` are
   deprecated and will be removed in a future release. You should instead look for the default network in
   deprecated and will be removed in a future release. You should instead look for the default network in
   `NetworkSettings.Networks`.
   `NetworkSettings.Networks`.
-* `GET /images/{id}/json` now responds with an empty `Created` field
-  (previously it was `0001-01-01T00:00:00Z`) if the `Created` field is missing
-  from the image config.
+* `GET /images/{id}/json` omits the `Created` field (previously it was `0001-01-01T00:00:00Z`)
+  if the `Created` field is missing from the image config.
 
 
 ## v1.43 API changes
 ## v1.43 API changes