api/server: Server.CreateMux: also register API-version debug endpoints

The debug endpoints are currently only provided non-versioned (e.g. `/debug/vars`). While this is convenient, we "officially" deprecated non-versioned endpoints in the API. This patch also registers the debug-endpoints under the API-versioned paths, so that they can be used either without version ("latest") and versioned paths. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
vvoland · Dec 9, 2024 · 27294df · 27294df
1 parent e2d2834
commit 27294df
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/api/server/server.go b/api/server/server.go
@@ -83,6 +83,7 @@ func (s *Server) CreateMux(routers ...router.Router) *mux.Router {
 	debugRouter := debug.NewRouter()
 	for _, r := range debugRouter.Routes() {
 		f := s.makeHTTPHandler(r.Handler(), r.Method()+" "+r.Path())
+		m.Path(versionMatcher + r.Path()).Methods(r.Method()).Handler(f)
 		m.Path(r.Path()).Methods(r.Method()).Handler(f)
 	}
 

diff --git a/docs/api/version-history.md b/docs/api/version-history.md
@@ -58,6 +58,10 @@ keywords: "API, Docker, rcli, REST, documentation"
   the one that sorts first is picked.
 * `GET /containers/json` now returns a `GwPriority` field in `NetworkSettings`
   for each network endpoint.
+* API debug endpoints (`GET /debug/vars`, `GET /debug/pprof/`, `GET /debug/pprof/cmdline`,
+  `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>`).
 
 ## v1.47 API changes