address comments

Signed-off-by: lhy1024 <[email protected]>
lhy1024 · Oct 12, 2023 · f6e209d · f6e209d
1 parent 4bd7f02
commit f6e209d
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 5 deletions.
diff --git a/pkg/mcs/scheduling/server/apis/v1/api.go b/pkg/mcs/scheduling/server/apis/v1/api.go
@@ -73,7 +73,7 @@ type server struct {
 	*scheserver.Server
 }
 
-func (s *server) GetCluster() sche.SharedCluster {
+func (s *server) GetCluster() sche.SchedulerCluster {
 	return s.Server.GetCluster()
 }
 
@@ -439,6 +439,8 @@ func pauseOrResumeScheduler(c *gin.Context) {
 // @Summary  List the hot write regions.
 // @Produce  json
 // @Success  200  {object}  statistics.StoreHotPeersInfos
+// @Failure  400  {string}  string  "The request is invalid."
+// @Failure  500  {string}  string  "PD server failed to proceed the request."
 // @Router   /hotspot/regions/write [get]
 func getHotWriteRegions(c *gin.Context) {
 	getHotRegions(utils.Write, c)
@@ -448,6 +450,8 @@ func getHotWriteRegions(c *gin.Context) {
 // @Summary  List the hot read regions.
 // @Produce  json
 // @Success  200  {object}  statistics.StoreHotPeersInfos
+// @Failure  400  {string}  string  "The request is invalid."
+// @Failure  500  {string}  string  "PD server failed to proceed the request."
 // @Router   /hotspot/regions/read [get]
 func getHotReadRegions(c *gin.Context) {
 	getHotRegions(utils.Read, c)
@@ -494,6 +498,7 @@ func getHotRegions(typ utils.RWType, c *gin.Context) {
 // @Summary  List the hot stores.
 // @Produce  json
 // @Success  200  {object}  handler.HotStoreStats
+// @Failure  500  {string}  string  "PD server failed to proceed the request."
 // @Router   /hotspot/stores [get]
 func getHotStores(c *gin.Context) {
 	handler := c.MustGet(handlerKey).(*handler.Handler)
@@ -509,6 +514,7 @@ func getHotStores(c *gin.Context) {
 // @Summary  List the hot buckets.
 // @Produce  json
 // @Success  200  {object}  handler.HotBucketsResponse
+// @Failure  500  {string}  string  "PD server failed to proceed the request."
 // @Router   /hotspot/buckets [get]
 func getHotBuckets(c *gin.Context) {
 	handler := c.MustGet(handlerKey).(*handler.Handler)

diff --git a/pkg/schedule/core/cluster_informer.go b/pkg/schedule/core/cluster_informer.go
@@ -56,9 +56,7 @@ type CheckerCluster interface {
 // SharedCluster is an aggregate interface that wraps multiple interfaces
 type SharedCluster interface {
 	BasicCluster
-	statistics.StoreStatInformer
 	statistics.RegionStatInformer
-	buckets.BucketStatInformer
 
 	GetBasicCluster() *core.BasicCluster
 	GetSharedConfig() sc.SharedConfigProvider

diff --git a/pkg/schedule/handler/handler.go b/pkg/schedule/handler/handler.go
@@ -45,7 +45,7 @@ import (
 // TODO: remove it after GetCluster is unified between PD server and Scheduling server.
 type Server interface {
 	GetCoordinator() *schedule.Coordinator
-	GetCluster() sche.SharedCluster
+	GetCluster() sche.SchedulerCluster
 }
 
 // Handler is a handler to handle http request about schedule.

diff --git a/server/api/hot_status.go b/server/api/hot_status.go
@@ -42,6 +42,8 @@ func newHotStatusHandler(handler *server.Handler, rd *render.Render) *hotStatusH
 // @Summary  List the hot write regions.
 // @Produce  json
 // @Success  200  {object}  statistics.StoreHotPeersInfos
+// @Failure  400  {string}  string  "The request is invalid."
+// @Failure  500  {string}  string  "PD server failed to proceed the request."
 // @Router   /hotspot/regions/write [get]
 func (h *hotStatusHandler) GetHotWriteRegions(w http.ResponseWriter, r *http.Request) {
 	h.getHotRegions(utils.Write, w, r)
@@ -51,6 +53,8 @@ func (h *hotStatusHandler) GetHotWriteRegions(w http.ResponseWriter, r *http.Req
 // @Summary  List the hot read regions.
 // @Produce  json
 // @Success  200  {object}  statistics.StoreHotPeersInfos
+// @Failure  400  {string}  string  "The request is invalid."
+// @Failure  500  {string}  string  "PD server failed to proceed the request."
 // @Router   /hotspot/regions/read [get]
 func (h *hotStatusHandler) GetHotReadRegions(w http.ResponseWriter, r *http.Request) {
 	h.getHotRegions(utils.Read, w, r)
@@ -95,6 +99,7 @@ func (h *hotStatusHandler) getHotRegions(typ utils.RWType, w http.ResponseWriter
 // @Summary  List the hot stores.
 // @Produce  json
 // @Success  200  {object}  handler.HotStoreStats
+// @Failure  500  {string}  string  "PD server failed to proceed the request."
 // @Router   /hotspot/stores [get]
 func (h *hotStatusHandler) GetHotStores(w http.ResponseWriter, r *http.Request) {
 	stats, err := h.Handler.GetHotStores()
@@ -109,6 +114,7 @@ func (h *hotStatusHandler) GetHotStores(w http.ResponseWriter, r *http.Request)
 // @Summary  List the hot buckets.
 // @Produce  json
 // @Success  200  {object}  handler.HotBucketsResponse
+// @Failure  500  {string}  string  "PD server failed to proceed the request."
 // @Router   /hotspot/buckets [get]
 func (h *hotStatusHandler) GetHotBuckets(w http.ResponseWriter, r *http.Request) {
 	regionIDs := r.URL.Query()["region_id"]

diff --git a/server/handler.go b/server/handler.go
@@ -61,7 +61,7 @@ func (s *server) GetCoordinator() *schedule.Coordinator {
 	return c.GetCoordinator()
 }
 
-func (s *server) GetCluster() sche.SharedCluster {
+func (s *server) GetCluster() sche.SchedulerCluster {
 	return s.GetRaftCluster()
 }