api: fix deprecation of "keep-storage" /build/prune query parameter

Signed-off-by: Austin Vazquez <austin.vazquez@docker.com>
This commit is contained in:
Austin Vazquez
2025-09-03 17:13:38 -05:00
parent 5f8fd1f195
commit a4a90c2248
5 changed files with 7 additions and 5 deletions

View File

@@ -97,6 +97,8 @@ keywords: "API, Docker, rcli, REST, documentation"
`GET /info` response are now always be `false` and will be omitted in API
v1.49. The netfilter module is now loaded on-demand, and no longer during
daemon startup, making these fields obsolete.
* Deprecated: The `POST /build/prune` `keep-storage` query parameter has been
renamed to `reserved-space`. `keep-storage` support will be removed in API v1.52.
* `GET /images/{name}/history` now supports a `platform` parameter (JSON
encoded OCI Platform type) that allows to specify a platform to show the
history of.
@@ -151,7 +153,7 @@ keywords: "API, Docker, rcli, REST, documentation"
`GET /debug/pprof/profile`, `GET /debug/pprof/symbol`, `GET /debug/pprof/trace`,
`GET /debug/pprof/{name}`) are now also accessible through the versioned-API
paths (`/v<API-version>/<endpoint>`).
* `POST /build/prune` renames `keep-bytes` to `reserved-space` and now supports
* `POST /build/prune` renames `keep-storage` to `reserved-space` and now supports
additional prune parameters `max-used-space` and `min-free-space`.
* `GET /containers/json` now returns an `ImageManifestDescriptor` field
matching the same field in `/containers/{name}/json`.

View File

@@ -9509,7 +9509,7 @@ paths:
Amount of disk space in bytes to keep for cache
> **Deprecated**: This parameter is deprecated and has been renamed to "reserved-space".
> It is kept for backward compatibility and will be removed in API v1.49.
> It is kept for backward compatibility and will be removed in API v1.52.
type: "integer"
format: "int64"
- name: "reserved-space"

View File

@@ -9509,7 +9509,7 @@ paths:
Amount of disk space in bytes to keep for cache
> **Deprecated**: This parameter is deprecated and has been renamed to "reserved-space".
> It is kept for backward compatibility and will be removed in API v1.49.
> It is kept for backward compatibility and will be removed in API v1.52.
type: "integer"
format: "int64"
- name: "reserved-space"

View File

@@ -9393,7 +9393,7 @@ paths:
Amount of disk space in bytes to keep for cache
> **Deprecated**: This parameter is deprecated and has been renamed to "reserved-space".
> It is kept for backward compatibility and will be removed in API v1.49.
> It is kept for backward compatibility and will be removed in API v1.52.
type: "integer"
format: "int64"
- name: "reserved-space"

View File

@@ -9394,7 +9394,7 @@ paths:
Amount of disk space in bytes to keep for cache
> **Deprecated**: This parameter is deprecated and has been renamed to "reserved-space".
> It is kept for backward compatibility and will be removed in API v1.49.
> It is kept for backward compatibility and will be removed in API v1.52.
type: "integer"
format: "int64"
- name: "reserved-space"