0ct0pu5/moby
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

api: docs: remove deprecated RootFS.BaseLayer (API v1.25-v1.41)

Browse source 
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 f342b27145 (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 <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2022-02-28 19:30:00 +01:00
parent fd1f34cacd
commit 8e9c8ff7f2
No known key found for this signature in database
GPG key ID: 76698F39D527CE8C
18 changed files with 4 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/api/v1.25.yaml
View file

@ -889,8 +889,6 @@ definitions:
type: "array"
items:
type: "string"
BaseLayer:
type: "string"
ImageSummary:
type: "object"

2
docs/api/v1.26.yaml
View file

@ -890,8 +890,6 @@ definitions:
type: "array"
items:
type: "string"
BaseLayer:
type: "string"
ImageSummary:
type: "object"

2
docs/api/v1.27.yaml
View file

@ -896,8 +896,6 @@ definitions:
type: "array"
items:
type: "string"
BaseLayer:
type: "string"
ImageSummary:
type: "object"

2
docs/api/v1.28.yaml
View file

@ -935,8 +935,6 @@ definitions:
type: "array"
items:
type: "string"
BaseLayer:
type: "string"
ImageSummary:
type: "object"

2
docs/api/v1.29.yaml
View file

@ -942,8 +942,6 @@ definitions:
type: "array"
items:
type: "string"
BaseLayer:
type: "string"
ImageSummary:
type: "object"

2
docs/api/v1.30.yaml
View file

@ -945,8 +945,6 @@ definitions:
type: "array"
items:
type: "string"
BaseLayer:
type: "string"
ImageSummary:
type: "object"

2
docs/api/v1.31.yaml
View file

@ -946,8 +946,6 @@ definitions:
type: "array"
items:
type: "string"
BaseLayer:
type: "string"
Metadata:
type: "object"
properties:

2
docs/api/v1.32.yaml
View file

@ -1204,8 +1204,6 @@ definitions:
type: "array"
items:
type: "string"
BaseLayer:
type: "string"
Metadata:
type: "object"
properties:

2
docs/api/v1.33.yaml
View file

@ -1209,8 +1209,6 @@ definitions:
type: "array"
items:
type: "string"
BaseLayer:
type: "string"
Metadata:
type: "object"
properties:

2
docs/api/v1.34.yaml
View file

@ -1220,8 +1220,6 @@ definitions:
type: "array"
items:
type: "string"
BaseLayer:
type: "string"
Metadata:
type: "object"
properties:

2
docs/api/v1.35.yaml
View file

@ -1196,8 +1196,6 @@ definitions:
type: "array"
items:
type: "string"
BaseLayer:
type: "string"
Metadata:
type: "object"
properties:

2
docs/api/v1.36.yaml
View file

@ -1196,8 +1196,6 @@ definitions:
type: "array"
items:
type: "string"
BaseLayer:
type: "string"
Metadata:
type: "object"
properties:

2
docs/api/v1.37.yaml
View file

@ -1199,8 +1199,6 @@ definitions:
type: "array"
items:
type: "string"
BaseLayer:
type: "string"
Metadata:
type: "object"
properties:

2
docs/api/v1.38.yaml
View file

@ -1210,8 +1210,6 @@ definitions:
type: "array"
items:
type: "string"
BaseLayer:
type: "string"
Metadata:
type: "object"
properties:

4
docs/api/v1.39.yaml
View file

@ -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

4
docs/api/v1.40.yaml
View file

@ -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

4
docs/api/v1.41.yaml
View file

@ -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

4
docs/api/version-history.md
View file

@ -384,6 +384,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.