Files
moby/api/docs
Sebastiaan van Stijn bd8a99b400 api/types/image: InspectResponse: deprecate Parent, DockerVersion
The image inspect response has various fields that were deprecated as
part of the legacy builder, or Dockerfile syntax;

- The `Parent` field is only used for the legacy builder, and only set for
  images that are built locally (i.e., not persisted when pulling an image).
- The `DockerVersion` field is only set when building images with the legacy
  builder, and empty in most cases.

This patch deprecates the fields in the `InspectResponse` go struct, as
these fields will no longer be set in future once the legacy builder is
removed (`Parent`, `DockerVersion`). The legacy builder's deprecation in
[cli@4d8e457] / [cli@fd22746] (docker 23.0, API v1.42), however the related
API fields were kept so that information of legacy images would not be
discarded.

The API continues to return these fields if set, allowing the client to
print the fields for informational purposes when printing the raw response,
but these fields should be considered "transitional", and not be depended
on; deprecating the fields helps raise awareness.

[cli@4d8e457]: 4d8e45782b
[cli@fd22746]: fd2274692f

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2025-10-05 23:00:18 +02:00
..
2025-07-23 17:44:18 +02:00

API Documentation

This directory contains versioned documents for each version of the API specification supported by this module. While this module provides support for older API versions, support should be considered "best-effort", especially for very old versions. Users are recommended to use the latest API versions, and only rely on older API versions for compatibility with older clients.

Newer API versions tend to be backward-compatible with older versions, with some exceptions where features were deprecated. For an overview of changes for each version, refer to CHANGELOG.md.

The latest version of the API specification can be found at the root directory of this module which may contain unreleased changes.

For API version v1.24, documentation is only available in markdown format, for later versions Swagger (OpenAPI) v2.0 specifications can be found in this directory. The Moby project itself primarily uses these swagger files to produce the API documentation; while we attempt to make these files match the actual implementation, the OpenAPI 2.0 specification has limitations that prevent us from expressing all options provided. There may be discrepancies (for which we welcome contributions). If you find bugs, or discrepancies, please open a ticket (or pull request).