API-Docker

 view release on metacpan or  search on metacpan

misc/agent-context/.claude/skills/docker-engine-api/references/compatibility-policy.md  view on Meta::CPAN

# Compatibility policy and contract acquisition

> Read when: starting a client or adding an API-dependent feature.

Declare supported client API range, Engine families/versions, operating systems, transports, and optional feature gates. Do not publish “Docker compatible” based on a successful ping. API version, implementation, operating mode, and feature avail...

The upstream version matrix is the current starting point. This package uses **Moby 28.5.2 / API 1.51** source snapshots to make framing/auth/filter observations reproducible. That is an implementation reference, not a claim that 1.51 is the latest A...

## Contract evidence order

Use the target release's API schema and official change history first. Use pinned implementation source when the schema omits a wire detail. Use an integration test against the supported engine for observable behavior. Record discrepancies rather tha...

The schema is open to additional fields, so tolerate unknown response fields while validating the fields necessary for your operation. Unknown or unsupported request fields may be ignored; a successful status is not proof that a requested security re...

## Capability record

Store daemon identity, detected implementation, negotiated version, OS/architecture, rootless status where exposed, and outcomes of safe feature probes. Cache these per endpoint/connection generation, not globally across all daemons. Re-evaluate afte...

Raw Engine API is not the complete protocol surface of every Docker ecosystem tool. Buildx/BuildKit sessions and Compose orchestration can require their own interfaces. If reproducing a CLI operation would require inventing undocumented endpoints, pr...

## Primary sources

- [Engine API overview and version matrix](https://docs.docker.com/reference/api/engine/)
- [Engine API version history](https://docs.docker.com/reference/api/engine/version-history/)
- [Pinned Moby 28.5.2 API 1.51 schema (compatibility evidence, not latest)](https://raw.githubusercontent.com/moby/moby/v28.5.2/docs/api/v1.51.yaml)
- [Engine SDK guidance](https://docs.docker.com/reference/api/engine/sdk/)
- [Compose SDK and CLI history](https://docs.docker.com/compose/intro/history/)



( run in 1.243 second using v1.01-cache-2.11-cpan-1bcd28dbaf1 )