Skip to content

Commit 9cc2a2b

Browse files
authored
Merge pull request #6129 from vvoland/docs-deprecated
docs: deprecate empty Config fields in image inspect API
2 parents 082d23d + 181563e commit 9cc2a2b

1 file changed

Lines changed: 29 additions & 1 deletion

File tree

docs/deprecated.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ The following table provides an overview of the current status of deprecated fea
5353

5454
| Status | Feature | Deprecated | Remove |
5555
|------------|------------------------------------------------------------------------------------------------------------------------------------|------------|--------|
56+
| Deprecated | [Empty/nil fields in image Config from inspect API](#emptynil-fields-in-image-config-from-inspect-api) | v28.3 | v29.0 |
5657
| Deprecated | [Configuration for pushing non-distributable artifacts](#configuration-for-pushing-non-distributable-artifacts) | v28.0 | v29.0 |
5758
| Deprecated | [`--time` option on `docker stop` and `docker restart`](#--time-option-on-docker-stop-and-docker-restart) | v28.0 | - |
5859
| Removed | [Non-standard fields in image inspect](#non-standard-fields-in-image-inspect) | v27.0 | v28.2 |
@@ -120,7 +121,34 @@ The following table provides an overview of the current status of deprecated fea
120121
| Removed | [`--run` flag on `docker commit`](#--run-flag-on-docker-commit) | v0.10 | v1.13 |
121122
| Removed | [Three arguments form in `docker import`](#three-arguments-form-in-docker-import) | v0.6.7 | v1.12 |
122123

123-
## Configuration for pushing non-distributable artifacts
124+
### Empty/nil fields in image Config from inspect API
125+
126+
**Deprecated in Release: v28.3**
127+
**Target For Removal In Release: v29.0**
128+
129+
The `Config` field returned by `docker image inspect` (and the `GET /images/{name}/json`
130+
API endpoint) currently includes certain fields even when they are empty or nil.
131+
Starting in Docker v29.0, the following fields will be omitted from the API response
132+
when they contain empty or default values:
133+
134+
- `Cmd`
135+
- `Entrypoint`
136+
- `Env`
137+
- `Labels`
138+
- `OnBuild`
139+
- `User`
140+
- `Volumes`
141+
- `WorkingDir`
142+
143+
Applications consuming the image inspect API should be updated to handle the
144+
absence of these fields gracefully, treating missing fields as having their
145+
default/empty values.
146+
147+
For API version corresponding to Docker v29.0, these fields will be omitted when
148+
empty. They will continue to be included when using clients that request an older
149+
API version for backward compatibility.
150+
151+
### Configuration for pushing non-distributable artifacts
124152

125153
**Deprecated in Release: v28.0**
126154
**Target For Removal In Release: v29.0**

0 commit comments

Comments
 (0)