Merge pull request #511 from runzexia/update-devops-api-docs

update api docs

pkg/apis/devops/v1alpha2/register.go

@@ -111,6 +111,7 @@ func addWebService(c *restful.Container) error {
 		Metadata(restfulspec.KeyOpenAPITags, tags).
 		Param(webservice.PathParameter("devops", "DevOps Project's Id, e.g. project-RRRRAzLBlLEm")).
 		Param(webservice.PathParameter("member", "Member's username, e.g. admin")).
+		Returns(http.StatusOK, RespOK, devops.DevOpsProjectMembership{}).
 		Reads(devops.DevOpsProjectMembership{}).
 		Writes(devops.DevOpsProjectMembership{}))
 
@@ -137,7 +138,6 @@ func addWebService(c *restful.Container) error {
 		Param(webservice.PathParameter("devops", "DevOps Project's Id, e.g. project-RRRRAzLBlLEm")).
 		Param(webservice.PathParameter("pipeline", "The name of pipeline, e.g. sample-pipeline")).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Returns(http.StatusOK, RespOK, devops.ProjectPipeline{}).
 		Writes(devops.ProjectPipeline{}).
 		Reads(devops.ProjectPipeline{}))
 

pkg/apis/resources/v1alpha2/register.go

@@ -227,11 +227,11 @@ func addWebService(c *restful.Container) error {
 		Returns(http.StatusOK, ok, errors.Error{}))
 
 	tags = []string{"Git"}
-	webservice.Route(webservice.POST("/git/readverify").
+	webservice.Route(webservice.POST("git/verify").
 		To(
 			git.GitReadVerify).
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Doc("secret git read verify").
+		Doc("Verify that the kubernetes secret has read access to the git repository").
 		Reads(gitmodel.AuthInfo{}).
 		Returns(http.StatusOK, ok, errors.Error{}),
 	)

pkg/models/devops/common.go

@@ -79,7 +79,7 @@ const (
 )
 
 type Role struct {
-	Name        string `json:"name" description:"role's name'"`
+	Name        string `json:"name" description:"role's name e.g. owner'"`
 	Description string `json:"description" description:"role 's description'"`
 }