From 0d07e3ca6845dab57a53d8512c6903b236f248b4 Mon Sep 17 00:00:00 2001 From: Ray Zhou Date: Thu, 27 Jun 2019 18:53:36 +0800 Subject: [PATCH] Update components API doc. --- pkg/apis/resources/v1alpha2/register.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pkg/apis/resources/v1alpha2/register.go b/pkg/apis/resources/v1alpha2/register.go index c78ca754..bd4dd0c9 100644 --- a/pkg/apis/resources/v1alpha2/register.go +++ b/pkg/apis/resources/v1alpha2/register.go @@ -187,18 +187,18 @@ func addWebService(c *restful.Container) error { webservice.Route(webservice.GET("/components"). To(components.GetComponents). Metadata(restfulspec.KeyOpenAPITags, tags). - Doc(""). + Doc("List the system components."). Returns(http.StatusOK, ok, map[string]models.Component{})) webservice.Route(webservice.GET("/components/{component}"). To(components.GetComponentStatus). Metadata(restfulspec.KeyOpenAPITags, tags). - Doc(""). + Doc("Describe the specified system component."). Param(webservice.PathParameter("component", "component name")). Returns(http.StatusOK, ok, models.Component{})) webservice.Route(webservice.GET("/componenthealth"). To(components.GetSystemHealthStatus). Metadata(restfulspec.KeyOpenAPITags, tags). - Doc(""). + Doc("Get the health status of system components."). Returns(http.StatusOK, ok, map[string]int{})) tags = []string{"Quotas"} -- GitLab