Commit Graph
124 Commits
Author SHA1 Message Date
Florian Stellbrink 42382e218c fix(swagger): replace incorrect indentation in versioned docs
the versioned api docs have the same indentation errors as
swagger.yaml. spec compliant parsers like js-yaml or libfyaml fail to
parse all of them.

flow collections that span lines are converted from flow style to
block style. continuation lines of multi-line double-quoted strings
are indented deeper than their key. the parsed data does not change.

Signed-off-by: Florian Stellbrink <flo@stellbr.ink>
2026-09-30 20:48:15 +02:00
Paweł Gronowski d5da23345d api/docs: Backport HTTP response status code quoting to older API specs
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2026-09-23 17:07:17 +02:00
Sebastiaan van Stijn 63a1f3471a api/docs: backport ImageManifestSummary.ImageData: fix invalid required field
The `UnpackedSize` field was added in 050afe1e1a,
which originally had it as a top-level field, but later moved it to
`Size.Unpacked`.

This caused issues with current (v3.6) versions of go-swagger, which added
validation for this;

    2026/09/22 12:33:56 reading config from /go/src/github.com/moby/moby/api/swagger-gen.yaml
    2026/09/22 12:33:56 validating spec /go/src/github.com/moby/moby/api/swagger.yaml
    The swagger spec at "/go/src/github.com/moby/moby/api/swagger.yaml" is invalid against the swagger specification 2.0. See errors :
    - "UnpackedSize" is present in required but not defined as property in schema "ImageManifestSummary.ImageData"

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-09-22 14:57:18 +02:00
Paweł Gronowski bee87d96f8 api/docs: Backport RemoteManagers default fix
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2026-09-21 12:19:32 +02:00
Paweł Gronowski 1bb816fa5b api/docs: Backport response media type fixes
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2026-09-21 12:19:32 +02:00
Paweł Gronowski 5aadb457c8 api/docs: Backport query parameter encoding fixes
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2026-09-21 12:19:32 +02:00
Paweł Gronowski 20beedbee6 api/docs: Cut v1.56
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2026-09-03 22:17:46 +02:00
Paweł Gronowski cc3463aaf8 api/docs: Align Healthcheck name in older API versions
Keep the archived Swagger specifications consistent with the current
API specification and the Go struct field name.

Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2026-09-03 20:05:20 +02:00
Paweł GronowskiandYoufu Zhang 235d2876f8 api: Add container umask configuration
Add HostConfig.Umask and pass it to the OCI process spec for container
entrypoints, exec processes, and healthchecks.

Preserve the configured umask when exec user resolution reconstructs the
OCI User value, so runtimes receive it in the per-exec process spec.

Keep the field aligned with OCI's uint32 representation - raw JSON
clients need to use 18 for octal 0022 for example.

Co-authored-by: Youfu Zhang <zhangyoufu@gmail.com>
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2026-09-03 10:41:23 +02:00
Sebastiaan van Stijn bef664b955 Merge pull request #53447 from mwihoti/fix-33509-api-docs
api/docs: fix Secret.Spec ref and config names filter
2026-09-01 18:33:10 +02:00
Sebastiaan van Stijn 72a8f1dc56 Merge pull request #53538 from ndeloof/ps-annotation-filter
daemon: add annotation filter for container list
2026-09-01 17:34:59 +02:00
Nicolas De Loof a991b0e390 daemon: add annotation filter for container list
Add support for filtering containers by annotation on
GET /containers/json, similar to the existing label filter:
`annotation=key` matches containers carrying the annotation key,
and `annotation=key=value` also matches its value.

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2026-09-01 16:00:05 +02:00
Niel Drummond 03c577dce8 docs: api: Use int64 for build query params
The POST /build resource query parameters are declared as bare
integers, which code generators commonly map to 32-bit values. The
daemon parses these parameters as signed 64-bit integers.

Add the int64 format to the affected versioned API documents so
generated clients can represent valid resource limits above i32::MAX.

Signed-off-by: Niel Drummond <niel@drummond.lu>
2026-08-30 12:53:40 +01:00
mwihoti 78484bc3e1 api/docs: fix Secret.Spec ref and config names filter
Signed-off-by: mwihoti <danielmwihoti@gmail.com>
2026-08-22 18:49:54 +00:00
Sebastiaan van Stijn f4cf04858e Merge pull request #53377 from vvoland/checkpoint-id-sanitize
daemon: Prevent checkpoint ID path traversal
2026-08-21 14:05:46 +02:00
Paweł Gronowski 29faac60e0 api: Bump to 1.56
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2026-08-20 17:02:53 +02:00
Paweł Gronowski 2339385bba api/docs: Document invalid checkpoint IDs in older APIs
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2026-08-20 14:51:38 +02:00
Paweł Gronowski 528b9b600f api/docs: Document invalid checkpoint ID responses
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2026-08-20 14:51:38 +02:00
Sebastiaan van Stijn 03920ad960 api/docs: sync API docs v1.25 - v1.55
Update older versions of the API docs with the changes made in
37302166e0 (api: document
Task.NetworksAttachments in the swagger definition) and
99c1a9c778 (daemon: Add
configurable default container stop timeout).

For older API versions I slightly adjusted the wording for the
timeout to not mention `default-stop-timeout`, because that option
is not present on older daemons, so I kept it to "daemon defaults".

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-07-30 19:07:52 +02:00
Paweł Gronowski 826b3f64b8 api/docs: Cut v1.55
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2026-06-12 18:13:47 +02:00
Sebastiaan van Stijn 6f484306ab Merge pull request #52651 from acouvreur/fix/container-update-blkio-device-throttle
daemon: support per-device blkio throttle in ContainerUpdate
2026-06-12 16:04:38 +02:00
Sebastiaan van Stijn 53ecd322ff Merge pull request #52828 from thaJeztah/sync_api
api/swagger: sync changes to versioned copies
2026-06-12 16:01:47 +02:00
Paweł Gronowski dc97f25cbf daemon/router: Gate ContainerUpdate blkio device fields by API version
ContainerUpdate only starts applying per-device blkio settings in the
current API version.

The fields existed in the Go request type before that because it shares
`container.Resources` with other endpoints, but they were not documented
as supported for container update and older daemons ignored them.

Clear these fields when handling requests for older API versions so
clients pinned to those versions keep the previous behavior, while v1.55
clients can use the newly supported fields.

Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2026-06-12 15:52:31 +02:00
Sopho Merkviladze 0b2c3780be api: declare ImageAttestations platform and type as repeatable
Both query parameters are now collectionFormat: multi arrays in the
swagger so they can accept multiple values later without an API
version bump. The server still operates on a single platform and
rejects requests passing more than one; type is read directly as a
list of repeated values instead of a comma-separated string.

Signed-off-by: Sopho Merkviladze <smerkviladze@mirantis.com>
2026-06-12 16:20:52 +04:00
Sopho Merkviladze a0b6dbc2fc api: add GET /images/{name}/attestations endpoint
Add a new Engine API endpoint that returns the in-toto attestation
statements attached to an image for a given platform. The endpoint
locates the attestation manifest(s) referencing the requested platform's
image manifest, enumerates the statement layers, and returns each
layer's OCI descriptor (including media type, digest, size, and
annotations) together with its in-toto predicate type.

Query parameters:
  - platform: JSON-encoded OCI platform; defaults to the daemon's host
    platform if omitted.
  - type: comma-separated list of in-toto predicate type URIs; if
    omitted, all statements are returned.
  - statement: boolean, defaults to false. When true, the daemon reads
    each matching statement blob and includes the verbatim in-toto JSON
    in the response. When false (or omitted), statement blobs are not
    read and the Statement field is absent from each entry.

The manifest-chain walk (locating the platform image manifest and its
associated attestation manifest) is delegated to policy-helpers'
image.ResolveSignatureChain so that moby and BuildKit agree on how to
interpret the attestation storage format. The statement-layer iteration
and blob reading is inlined: when statement bodies are requested it
fails fast on the first unreadable blob and reads matching blobs
eagerly into memory; otherwise statement-layer blobs are never read
from the content store.

The endpoint is implemented for the containerd image store. The legacy
graphdriver store returns errdefs.NotImplemented (HTTP 501).

Signed-off-by: Sopho Merkviladze <smerkviladze@mirantis.com>
2026-06-12 13:40:58 +04:00
Sebastiaan van Stijn bff5b9cf84 api/swagger: sync swarm join endpoint to older docs versions
Syncs changes from 2ecaac9631
and d5f6bdb027 to older API
versions, in addition to formatting changes.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-06-11 15:38:04 +02:00
Sebastiaan van Stijn 8368bcd28f api/swagger: move position of ImageInspect.Identity
commit 6d133c5ec6 moved this field in
the swagger; move it back to align with older API versions.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-06-11 15:37:38 +02:00
Ashutosh Anand 2ecaac9631 docs: clarify swarm join required fields
Document that /swarm/join requires ListenAddr, RemoteAddrs, and JoinToken in the Engine API spec.

ListenAddr is already required by join validation, while a non-empty listen address without a port uses the default swarm listening port. This keeps the API docs aligned with current behavior without changing swarm runtime behavior.

Fixes #49159

Signed-off-by: Ashutosh Anand <ashutoshanand2560@gmail.com>
2026-06-05 10:11:41 +05:30
Sebastiaan van Stijn 179985cf89 Merge pull request #52358 from geekcoderr/52355-topology-swagger
api: align Topology swagger with Segments JSON shape
2026-04-19 02:28:58 +02:00
Sebastiaan van Stijn dc48cea266 api/docs: cleanup changelog
Follow-up to ca69153e28 and
0d2d3f348d, which restored old API docs.

This patch aligns the formatting of older versions with the format we use now.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-04-16 13:46:49 +02:00
Nishant Maheshwari 5c80a6e826 api: align Topology in versioned OpenAPI specs with Segments JSON shape
Apply the same Topology schema fix as api/swagger.yaml to v1.42–v1.54
document snapshots so clients generating from pinned API versions see the
correct Segments map shape.

Signed-off-by: Nishant Maheshwari <mnishant222@gmail.com>
Made-with: Cursor
2026-04-16 01:26:25 +05:30
Sebastiaan van Stijn 3d5c9936a3 Merge pull request #52312 from thaJeztah/api_restore_history
api/docs: restore API docs and change-logs for API v1.0 - v1.23
2026-04-09 14:24:26 +02:00
Sebastiaan van Stijn a2eaebb011 api/docs: lower deprecation heading to a h4
Prevent the heading to show up in the TOC on docs.docker.com

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-04-06 01:10:03 +02:00
Sebastiaan van Stijn ca69153e28 api/docs: restore changelog for API v1.0 - v1.13
This reverts commit 1d5f479e01.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-04-05 15:53:20 +02:00
Sebastiaan van Stijn 1055b7a1a6 api/docs: restore API versions v1.0 - v1.13
This reverts commit d2382f7b96.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-04-05 15:53:19 +02:00
Sebastiaan van Stijn 0d2d3f348d api/docs: restore API versions v1.14 - v1.17
This reverts commit 68f9a45440.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-04-05 15:53:16 +02:00
Sebastiaan van Stijn dc824e3d8d api/docs: restore API versions v1.18 - v1.23
This reverts commit d54be2ee6d.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-04-05 15:53:15 +02:00
Paweł Gronowski 2fa6029be4 network/connect: Support MacAddress
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2026-03-05 14:11:08 +01:00
chemodax e04bd2649e Rename disk usage properties in v1.54.yamlBackport c07043e36f to api/docs/v1.54.yaml.
Signed-off-by: chemodax <53048645+chemodax@users.noreply.github.com>
2026-03-01 21:38:51 +01:00
chemodax 5272ef1422 Backport c07043e36f to api/docs/v1.53.yaml.
Signed-off-by: chemodax <53048645+chemodax@users.noreply.github.com>
2026-03-01 21:37:55 +01:00
chemodax 076100ddcc Backport c07043e36f to api/docs/v1.52.yaml.
Signed-off-by: chemodax <53048645+chemodax@users.noreply.github.com>
2026-03-01 21:36:56 +01:00
Paweł Gronowski 74ad89c189 api: Cut v1.54
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2026-02-27 19:34:41 +01:00
CrazyMax 6d133c5ec6 image: add opt-in identity support to image list API
Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
2026-02-27 16:35:31 +01:00
Sebastiaan van Stijn 320b010add api/docs: add "platform" param for GET /image/{name}/json (API v1.49-v1.53)
This parameter was added in 59169d0f97
(API v1.49, docker 28.5.1), but forgot to update the swagger definition.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-02-23 10:31:46 +01:00
Paweł Gronowski 4fa326fa85 api: Cut v1.53
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2026-01-26 19:00:50 +01:00
Sebastiaan van Stijn bd660c390b api/docs: sync MountType to versioned swagger specs
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-01-19 16:01:58 +01:00
Tonis Tiigi 7745b7135f api: add swagger definitions for new Identity type
Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-01-16 08:07:15 -08:00
Sebastiaan van Stijn 41d19f6644 api/docs: backport assorted fixes and enhancements to older api versions
This syncs the versioned swagger files with some fixes and enhancements
made in:

- 955897fe21
- 22345e3369
- 917d66d833
- 1fd2395cd3

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-01-06 22:37:50 +01:00
Nicolas De Loof aef5d996ce use mime-type application/jsonl to align with openapi 3.2
Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2025-12-17 11:37:48 +01:00
Sebastiaan van Stijn b2d84a3ef5 Merge pull request #51732 from thaJeztah/sync_swagger_docs
api/docs: move ImageHistoryResponseItem to definitions (API v1.25-v1.52)
2025-12-16 13:50:34 +01:00