未验证 提交 a9237a5c 编写于 作者: R runzexia

update docs

Signed-off-by: Nrunzexia <runzexia@yunify.com>
上级 d5aa90bb
......@@ -247,17 +247,17 @@ type SCMOrg struct {
Class string `json:"_class,omitempty" description:"It’s a fully qualified name and is an identifier of the producer of this resource's capability."`
Links struct {
Repositories struct {
Class string `json:"_class,omitempty"`
Href string `json:"href,omitempty"`
Class string `json:"_class,omitempty" description:"It’s a fully qualified name and is an identifier of the producer of this resource's capability."`
Href string `json:"href,omitempty" description:"url in api"`
} `json:"repositories,omitempty"`
Self struct {
Class string `json:"_class,omitempty"`
Href string `json:"href,omitempty"`
} `json:"self,omitempty"`
Class string `json:"_class,omitempty" description:"It’s a fully qualified name and is an identifier of the producer of this resource's capability."`
Href string `json:"href,omitempty" description:"self url in api"`
} `json:"self,omitempty" description:"scm org self info"`
} `json:"_links,omitempty" description:"references the reachable path to this resource"`
Avatar string `json:"avatar,omitempty" description:"avatar url"`
JenkinsOrganizationPipeline bool `json:"jenkinsOrganizationPipeline,omitempty" description:"jenkins organization pipeline"`
Name string `json:"name,omitempty" description:"name "`
Name string `json:"name,omitempty" description:"org name "`
}
// GetOrgRepo
......@@ -733,10 +733,10 @@ type Crumb struct {
// CheckScriptCompile
type CheckScript struct {
Column int `json:"column,omitempty" description:"column"`
Line int `json:"line,omitempty" description:"line"`
Message string `json:"message,omitempty" description:"message"`
Status string `json:"status,omitempty" description:"statue"`
Column int `json:"column,omitempty" description:"column e.g. 0"`
Line int `json:"line,omitempty" description:"line e.g. 0"`
Message string `json:"message,omitempty" description:"message e.g. success"`
Status string `json:"status,omitempty" description:"status e.g. success"`
}
// CheckCron
......
......@@ -23,7 +23,7 @@ const (
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'"`
Role string `json:"role" description:"devops project membership's role type. e.g. owner '"`
Status string `json:"status" description:"Desperated, status of project membership"`
GrantBy string `json:"grand_by,omitempty" description:"Username of the user who assigned the role"`
}
......
......@@ -47,7 +47,7 @@ type DevOpsProject struct {
CreateTime time.Time `json:"create_time" description:"DevOps Project's Creation time'"`
Status string `json:"status" description:"DevOps project's status"`
Status string `json:"status" description:"DevOps project's status. e.g. active"`
Visibility string `json:"visibility,omitempty" description:"Desperated Field"`
......
......@@ -43,7 +43,7 @@ type JenkinsCredential struct {
} `json:"usage,omitempty" description:"all usage of credential"`
} `json:"fingerprint,omitempty" description:"usage of credential"`
Description string `json:"description,omitempty" description:"credential's description'"`
Domain string `json:"domain,omitempty" description:"credential's domain, default '_''"`
Domain string `json:"domain,omitempty" description:"credential's domain,In ks we only use the default domain, default '_''"`
CreateTime *time.Time `json:"create_time,omitempty" description:"credential's create_time'"`
Creator string `json:"creator,omitempty" description:"creator's username"`
UsernamePasswordCredential *UsernamePasswordCredential `json:"username_password,omitempty" description:"username password credential struct"`
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册