testing/server: docs for CustomHandler

fsouza · Jul 4, 2014 · e21b2a4 · e21b2a4
1 parent 064d3ea
commit e21b2a4
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/testing/server.go b/testing/server.go
@@ -115,6 +115,13 @@ func (s *DockerServer) ResetFailure(id string) {
 	delete(s.failures, id)
 }
 
+// CustomHandler registers a custom handler for a specific path.
+//
+// For example:
+//
+//     server.CustomHandler("/containers/json", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+//         http.Error(w, "Something wrong is not right", http.StatusInternalServerError)
+//     }))
 func (s *DockerServer) CustomHandler(path string, handler http.Handler) {
 	s.handlerMutex.Lock()
 	s.customHandlers[path] = handler