admin/kubesphere
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #510 from rayzhou2017/api-docs

Browse Source 
Update components API doc.
This commit is contained in:
rayzhou2017
2019-06-28 10:53:00 +08:00
committed by GitHub
parent fdf5279f2f 0d07e3ca68
commit a336bae8ec
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
pkg/apis/resources/v1alpha2/register.go
View File

@@ -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"}