Skip to content

Commit 4a19009

Browse files
committed
API: remove deprecated "filter" parameter for API v1.41 and up
This query-parameter was deprecated in docker 1.13 in commit 820b809, and scheduled for removal in docker 17.12, so we should remove it for the next API version. Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent adf0664 commit 4a19009

2 files changed

Lines changed: 9 additions & 4 deletions

File tree

api/server/router/image/image_routes.go

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -231,10 +231,12 @@ func (s *imageRouter) getImagesJSON(ctx context.Context, w http.ResponseWriter,
231231
return err
232232
}
233233

234-
filterParam := r.Form.Get("filter")
235-
// FIXME(vdemeester) This has been deprecated in 1.13, and is target for removal for v17.12
236-
if filterParam != "" {
237-
imageFilters.Add("reference", filterParam)
234+
version := httputils.VersionFromContext(ctx)
235+
if versions.LessThan(version, "1.41") {
236+
filterParam := r.Form.Get("filter")
237+
if filterParam != "" {
238+
imageFilters.Add("reference", filterParam)
239+
}
238240
}
239241

240242
images, err := s.backend.Images(imageFilters, httputils.BoolValue(r, "all"), false)

docs/api/version-history.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ keywords: "API, Docker, rcli, REST, documentation"
1717

1818
[Docker Engine API v1.41](https://docs.docker.com/engine/api/v1.41/) documentation
1919

20+
* The `filter` (singular) query parameter, which was deprecated in favor of the
21+
`filters` option in Docker 1.13, has now been removed from the `GET /images/json`
22+
endpoint. The parameter remains available when using API version 1.40 or below.
2023
* `GET /services` now returns `Capabilities` as part of the `ContainerSpec`.
2124
* `GET /services/{id}` now returns `Capabilities` as part of the `ContainerSpec`.
2225
* `POST /services/create` now accepts `Capabilities` as part of the `ContainerSpec`.

0 commit comments

Comments
 (0)