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

update devops api doc

Browse Source 
Signed-off-by: soulseen <sunzhu@yunify.com>
This commit is contained in:
soulseen
2019-06-19 21:10:01 +08:00
parent 1f125bddf3
commit fbc5a9db03
3 changed files with 6 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
pkg/apis/devops/v1alpha2/register.go
View File

@@ -204,7 +204,6 @@ func addWebService(c *restful.Container) error {
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(webservice.PathParameter("devops", "devops project's Id")).
Param(webservice.PathParameter("credentials", "credential's Id")).
Param(webservice.QueryParameter("domain", "credential's domain")).
Param(webservice.QueryParameter("content", "get additional content")).
Returns(http.StatusOK, RespOK, devops.JenkinsCredential{}).
Reads(devops.JenkinsCredential{}))
@@ -214,8 +213,6 @@ func addWebService(c *restful.Container) error {
Doc("Get project credential pipeline").
Metadata(restfulspec.KeyOpenAPITags, tags).
Param(webservice.PathParameter("devops", "devops project's Id")).
Param(webservice.PathParameter("credentials", "credential's Id")).
Param(webservice.QueryParameter("domain", "credential's domain")).
Returns(http.StatusOK, RespOK, []devops.JenkinsCredential{}).
Reads([]devops.JenkinsCredential{}))
@@ -754,7 +751,7 @@ func addWebService(c *restful.Container) error {
webservice.Route(webservice.POST("/devops/notifycommit").
To(devopsapi.PostNotifyCommit).
Metadata(restfulspec.KeyOpenAPITags, tags).
Doc("Get notify commit by HTTP POST method.").
Doc("Get notification commit by HTTP POST method.").
Consumes("application/json").
Produces("text/plain; charset=utf-8").
Param(webservice.QueryParameter("url", "url of git scm").

8
pkg/models/devops/json.go
View File

@@ -1025,9 +1025,9 @@ type ReqJson struct {
// ToJenkinsfile response
type ResJenkinsfile struct {
Status string `json:"status,omitempty" description:"status"`
Status string `json:"status,omitempty" description:"status e.g. ok"`
Data struct {
Result string `json:"result,omitempty" description:"result"`
Result string `json:"result,omitempty" description:"result e.g. success"`
Jenkinsfile string `json:"jenkinsfile,omitempty" description:"jenkinsfile"`
Errors []struct {
Location []string `json:"location,omitempty" description:"err location"`
@@ -1041,9 +1041,9 @@ type ReqJenkinsfile struct {
}
type ResJson struct {
Status string `json:"status,omitempty" description:"status"`
Status string `json:"status,omitempty" description:"status e.g. ok"`
Data struct {
Result string `json:"result,omitempty" description:"result"`
Result string `json:"result,omitempty" description:"result e.g. success"`
JSON struct {
Pipeline struct {
Stages []interface{} `json:"stages,omitempty" description:"stages"`

2
pkg/models/devops/membership.go
View File

@@ -24,7 +24,7 @@ type DevOpsProjectMembership struct {
Username string `json:"username" description:"member's username，username can uniquely identify a user"`
ProjectId string `json:"project_id" db:"project_id" description:"the devops projects which project membership belongs to"`
Role string `json:"role" description:"devops project membership's role type. e.g. owner '"`
Status string `json:"status" description:"Desperated, status of project membership"`
Status string `json:"status" description:"Desperated, status of project membership. e.g. active "`
GrantBy string `json:"grand_by,omitempty" description:"Username of the user who assigned the role"`
}