From 51ea235ab855de7ffbd5627d7abc08030baff88d Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Mon, 28 Feb 2022 19:30:00 +0100 Subject: [PATCH] api: docs: remove deprecated RootFS.BaseLayer (API v1.25-v1.41) This field was used when Windows did not yet support regular images, and required the base-image to pre-exist on the Windows machine (as those layers were not yet allowed to be distributed). Commit f342b27145d8f5af27cd5de1501551af275e899b (docker 1.13.0, API v1.25) removed usage of the field. The field was not documented in the API, but because it was not removed from the Golang structs in the API, ended up in the API documentation when we switched to using Swagger instead of plain MarkDown for the API docs. Given that the field was never set in any of these API versions, and had an "omitempty", it was never actually returned in a response, so should be fine to remove from these API docs. Signed-off-by: Sebastiaan van Stijn (cherry picked from commit 8e9c8ff7f263751264ce9971be0478fc3bddd940) Signed-off-by: Sebastiaan van Stijn --- docs/api/v1.25.yaml | 2 -- docs/api/v1.26.yaml | 2 -- docs/api/v1.27.yaml | 2 -- docs/api/v1.28.yaml | 2 -- docs/api/v1.29.yaml | 2 -- docs/api/v1.30.yaml | 2 -- docs/api/v1.31.yaml | 2 -- docs/api/v1.32.yaml | 2 -- docs/api/v1.33.yaml | 2 -- docs/api/v1.34.yaml | 2 -- docs/api/v1.35.yaml | 2 -- docs/api/v1.36.yaml | 2 -- docs/api/v1.37.yaml | 2 -- docs/api/v1.38.yaml | 2 -- docs/api/v1.39.yaml | 4 ---- docs/api/v1.40.yaml | 4 ---- docs/api/v1.41.yaml | 4 ---- docs/api/version-history.md | 4 ++++ 18 files changed, 4 insertions(+), 40 deletions(-) diff --git a/docs/api/v1.25.yaml b/docs/api/v1.25.yaml index 761a1db00c..4c01f7f761 100644 --- a/docs/api/v1.25.yaml +++ b/docs/api/v1.25.yaml @@ -889,8 +889,6 @@ definitions: type: "array" items: type: "string" - BaseLayer: - type: "string" ImageSummary: type: "object" diff --git a/docs/api/v1.26.yaml b/docs/api/v1.26.yaml index 30f41303c5..780f49f6e2 100644 --- a/docs/api/v1.26.yaml +++ b/docs/api/v1.26.yaml @@ -890,8 +890,6 @@ definitions: type: "array" items: type: "string" - BaseLayer: - type: "string" ImageSummary: type: "object" diff --git a/docs/api/v1.27.yaml b/docs/api/v1.27.yaml index e94601b0c8..a86839f81d 100644 --- a/docs/api/v1.27.yaml +++ b/docs/api/v1.27.yaml @@ -896,8 +896,6 @@ definitions: type: "array" items: type: "string" - BaseLayer: - type: "string" ImageSummary: type: "object" diff --git a/docs/api/v1.28.yaml b/docs/api/v1.28.yaml index 13269c4097..96fcfad469 100644 --- a/docs/api/v1.28.yaml +++ b/docs/api/v1.28.yaml @@ -935,8 +935,6 @@ definitions: type: "array" items: type: "string" - BaseLayer: - type: "string" ImageSummary: type: "object" diff --git a/docs/api/v1.29.yaml b/docs/api/v1.29.yaml index 4a3472eedc..b3ac51cc29 100644 --- a/docs/api/v1.29.yaml +++ b/docs/api/v1.29.yaml @@ -942,8 +942,6 @@ definitions: type: "array" items: type: "string" - BaseLayer: - type: "string" ImageSummary: type: "object" diff --git a/docs/api/v1.30.yaml b/docs/api/v1.30.yaml index 3d9a8a84cb..b215b061ba 100644 --- a/docs/api/v1.30.yaml +++ b/docs/api/v1.30.yaml @@ -945,8 +945,6 @@ definitions: type: "array" items: type: "string" - BaseLayer: - type: "string" ImageSummary: type: "object" diff --git a/docs/api/v1.31.yaml b/docs/api/v1.31.yaml index c93b48587c..28e7b8e8ca 100644 --- a/docs/api/v1.31.yaml +++ b/docs/api/v1.31.yaml @@ -946,8 +946,6 @@ definitions: type: "array" items: type: "string" - BaseLayer: - type: "string" Metadata: type: "object" properties: diff --git a/docs/api/v1.32.yaml b/docs/api/v1.32.yaml index 0e99c43a19..1206560ff6 100644 --- a/docs/api/v1.32.yaml +++ b/docs/api/v1.32.yaml @@ -1204,8 +1204,6 @@ definitions: type: "array" items: type: "string" - BaseLayer: - type: "string" Metadata: type: "object" properties: diff --git a/docs/api/v1.33.yaml b/docs/api/v1.33.yaml index af71bb4658..4f714269cb 100644 --- a/docs/api/v1.33.yaml +++ b/docs/api/v1.33.yaml @@ -1209,8 +1209,6 @@ definitions: type: "array" items: type: "string" - BaseLayer: - type: "string" Metadata: type: "object" properties: diff --git a/docs/api/v1.34.yaml b/docs/api/v1.34.yaml index e6401e56ef..551cea3a81 100644 --- a/docs/api/v1.34.yaml +++ b/docs/api/v1.34.yaml @@ -1220,8 +1220,6 @@ definitions: type: "array" items: type: "string" - BaseLayer: - type: "string" Metadata: type: "object" properties: diff --git a/docs/api/v1.35.yaml b/docs/api/v1.35.yaml index 93dce8fd70..09072cdb77 100644 --- a/docs/api/v1.35.yaml +++ b/docs/api/v1.35.yaml @@ -1196,8 +1196,6 @@ definitions: type: "array" items: type: "string" - BaseLayer: - type: "string" Metadata: type: "object" properties: diff --git a/docs/api/v1.36.yaml b/docs/api/v1.36.yaml index bd803684f5..c36450949a 100644 --- a/docs/api/v1.36.yaml +++ b/docs/api/v1.36.yaml @@ -1196,8 +1196,6 @@ definitions: type: "array" items: type: "string" - BaseLayer: - type: "string" Metadata: type: "object" properties: diff --git a/docs/api/v1.37.yaml b/docs/api/v1.37.yaml index a216aa4021..fa3b072684 100644 --- a/docs/api/v1.37.yaml +++ b/docs/api/v1.37.yaml @@ -1199,8 +1199,6 @@ definitions: type: "array" items: type: "string" - BaseLayer: - type: "string" Metadata: type: "object" properties: diff --git a/docs/api/v1.38.yaml b/docs/api/v1.38.yaml index 2b1e640d5a..53eacaed93 100644 --- a/docs/api/v1.38.yaml +++ b/docs/api/v1.38.yaml @@ -1210,8 +1210,6 @@ definitions: type: "array" items: type: "string" - BaseLayer: - type: "string" Metadata: type: "object" properties: diff --git a/docs/api/v1.39.yaml b/docs/api/v1.39.yaml index 15bdc9ac28..321318103b 100644 --- a/docs/api/v1.39.yaml +++ b/docs/api/v1.39.yaml @@ -1620,10 +1620,6 @@ definitions: example: - "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6" - "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef" - BaseLayer: - type: "string" - x-nullable: true - example: "" Metadata: description: | Additional metadata of the image in the local cache. This information diff --git a/docs/api/v1.40.yaml b/docs/api/v1.40.yaml index f9ae3d46f8..34525860b9 100644 --- a/docs/api/v1.40.yaml +++ b/docs/api/v1.40.yaml @@ -1681,10 +1681,6 @@ definitions: example: - "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6" - "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef" - BaseLayer: - type: "string" - x-nullable: true - example: "" Metadata: description: | Additional metadata of the image in the local cache. This information diff --git a/docs/api/v1.41.yaml b/docs/api/v1.41.yaml index d911bcb867..35e2abb117 100644 --- a/docs/api/v1.41.yaml +++ b/docs/api/v1.41.yaml @@ -1713,10 +1713,6 @@ definitions: example: - "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6" - "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef" - BaseLayer: - type: "string" - x-nullable: true - example: "" Metadata: description: | Additional metadata of the image in the local cache. This information diff --git a/docs/api/version-history.md b/docs/api/version-history.md index f2dc76ce21..e8ca40e722 100644 --- a/docs/api/version-history.md +++ b/docs/api/version-history.md @@ -354,6 +354,10 @@ keywords: "API, Docker, rcli, REST, documentation" * `GET /version` now returns `MinAPIVersion`. * `POST /build` accepts `networkmode` parameter to specify network used during build. * `GET /images/(name)/json` now returns `OsVersion` if populated +* `GET /images/(name)/json` no longer contains the `RootFS.BaseLayer` field. This + field was used for Windows images that used a base-image that was pre-installed + on the host (`RootFS.Type` `layers+base`), which is no longer supported, and + the `RootFS.BaseLayer` field has been removed. * `GET /info` now returns `Isolation`. * `POST /containers/create` now takes `AutoRemove` in HostConfig, to enable auto-removal of the container on daemon side when the container's process exits. * `GET /containers/json` and `GET /containers/(id or name)/json` now return `"removing"` as a value for the `State.Status` field if the container is being removed. Previously, "exited" was returned as status.