Skip to content

Commit

Permalink
api: document changed behavior of the Aliases field in v1.45
Browse files Browse the repository at this point in the history
Signed-off-by: Bjorn Neergaard <bjorn.neergaard@docker.com>
  • Loading branch information
neersighted committed Mar 20, 2024
1 parent 963e1f3 commit 94c3533
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docs/api/version-history.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ keywords: "API, Docker, rcli, REST, documentation"
* `GET /images/{name}/json` no longer includes the `Container` and
`ContainerConfig` fields. To access image configuration, use `Config` field
instead.
* The `Aliases` field returned in calls to `GET /containers/{name:.*}/json` will no longer
contain 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

Expand Down Expand Up @@ -83,9 +87,9 @@ keywords: "API, Docker, rcli, REST, documentation"
* `GET /info` now includes `status` properties in `Runtimes`.
* 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`.
* 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.
Starting with that API version, this specific value will be removed from the `Aliases` field
* 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.
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
`POST /containers/create` endpoint. The newly introduced `DNSNames` should now be used instead.
* The fields `HairpinMode`, `LinkLocalIPv6Address`, `LinkLocalIPv6PrefixLen`, `SecondaryIPAddresses`,
Expand Down

0 comments on commit 94c3533

Please sign in to comment.