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

api: document changed behavior of the Aliases field in v1.45

Browse source 
Signed-off-by: Bjorn Neergaard <bjorn.neergaard@docker.com>
This commit is contained in:
Bjorn Neergaard 2024-03-20 07:59:15 -06:00
parent 963e1f3eed
commit 22726fb63b
No known key found for this signature in database
1 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -25,6 +25,11 @@ keywords: "API, Docker, rcli, REST, documentation"
* `GET /images/{name}/json` no longer includes the `Container` and * `GET /images/{name}/json` no longer includes the `Container` and
`ContainerConfig` fields. To access image configuration, use `Config` field `ContainerConfig` fields. To access image configuration, use `Config` field
instead. instead.
* The `Aliases` field returned in calls to `GET /containers/{name:.*}/json` no
longer contains the short container ID, but instead will reflect exactly the
values originally submitted to the `POST /containers/create` endpoint. The
newly introduced `DNSNames` should now be used instead when short container
IDs are needed.
## v1.44 API changes ## v1.44 API changes
@ -83,9 +88,9 @@ keywords: "API, Docker, rcli, REST, documentation"
* `GET /info` now includes `status` properties in `Runtimes`. * `GET /info` now includes `status` properties in `Runtimes`.
* A new field named `DNSNames` and containing all non-fully qualified DNS names * A new field named `DNSNames` and containing all non-fully qualified DNS names
a container takes on a specific network has been added to `GET /containers/{name:.*}/json`. a container takes on a specific network has been added to `GET /containers/{name:.*}/json`.
* The `Aliases` field returned in calls to `GET /containers/{name:.*}/json` in v1.44 and older * The `Aliases` field returned in calls to `GET /containers/{name:.*}/json` in v1.44 and older
versions contains the short container ID. This will change in the next API version, v1.45. versions contains the short container ID. This will change in the next API version, v1.45.
Starting with that API version, this specific value will be removed from the `Aliases` field Starting with that API version, this specific value will be removed from the `Aliases` field
such that this field will reflect exactly the values originally submitted to the such that this field will reflect exactly the values originally submitted to the
`POST /containers/create` endpoint. The newly introduced `DNSNames` should now be used instead. `POST /containers/create` endpoint. The newly introduced `DNSNames` should now be used instead.
* The fields `HairpinMode`, `LinkLocalIPv6Address`, `LinkLocalIPv6PrefixLen`, `SecondaryIPAddresses`, * The fields `HairpinMode`, `LinkLocalIPv6Address`, `LinkLocalIPv6PrefixLen`, `SecondaryIPAddresses`,