Browse Source

Merge pull request #40491 from thaJeztah/remove_deprecated_filters_opt

API: remove deprecated "filter" parameter for API v1.41 and up
Sebastiaan van Stijn 5 years ago
parent
commit
cb3ec99b16
2 changed files with 9 additions and 4 deletions
  1. 6 4
      api/server/router/image/image_routes.go
  2. 3 0
      docs/api/version-history.md

+ 6 - 4
api/server/router/image/image_routes.go

@@ -231,10 +231,12 @@ func (s *imageRouter) getImagesJSON(ctx context.Context, w http.ResponseWriter,
 		return err
 		return err
 	}
 	}
 
 
-	filterParam := r.Form.Get("filter")
-	// FIXME(vdemeester) This has been deprecated in 1.13, and is target for removal for v17.12
-	if filterParam != "" {
-		imageFilters.Add("reference", filterParam)
+	version := httputils.VersionFromContext(ctx)
+	if versions.LessThan(version, "1.41") {
+		filterParam := r.Form.Get("filter")
+		if filterParam != "" {
+			imageFilters.Add("reference", filterParam)
+		}
 	}
 	}
 
 
 	images, err := s.backend.Images(imageFilters, httputils.BoolValue(r, "all"), false)
 	images, err := s.backend.Images(imageFilters, httputils.BoolValue(r, "all"), false)

+ 3 - 0
docs/api/version-history.md

@@ -17,6 +17,9 @@ keywords: "API, Docker, rcli, REST, documentation"
 
 
 [Docker Engine API v1.41](https://docs.docker.com/engine/api/v1.41/) documentation
 [Docker Engine API v1.41](https://docs.docker.com/engine/api/v1.41/) documentation
 
 
+* The `filter` (singular) query parameter, which was deprecated in favor of the
+  `filters` option in Docker 1.13, has now been removed from the `GET /images/json`
+  endpoint. The parameter remains available when using API version 1.40 or below.
 * `GET /services` now returns `Capabilities` as part of the `ContainerSpec`.
 * `GET /services` now returns `Capabilities` as part of the `ContainerSpec`.
 * `GET /services/{id}` now returns `Capabilities` as part of the `ContainerSpec`.
 * `GET /services/{id}` now returns `Capabilities` as part of the `ContainerSpec`.
 * `POST /services/create` now accepts `Capabilities` as part of the `ContainerSpec`.
 * `POST /services/create` now accepts `Capabilities` as part of the `ContainerSpec`.