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

update api docs & reformat code

pkg/apis/devops/v1alpha2/register.go

@@ -202,9 +202,15 @@ func addWebService(c *restful.Container) error {
 		To(devopsapi.GetDevOpsProjectCredentialHandler).
 		Doc("Get the specified credential of the DevOps project").
 		Metadata(restfulspec.KeyOpenAPITags, tags).
-		Param(webservice.PathParameter("devops", "DevOps project's ID, e.g. project-RRRRAzLBlLEm")).
-		Param(webservice.PathParameter("credential", "credential's ID, e.g. dockerhub-id")).
-		Param(webservice.QueryParameter("content", "Get extra content, if not none will get credential's content")).
+		Param(webservice.PathParameter("devops", "DevOps Project's Id, e.g. project-RRRRAzLBlLEm")).
+		Param(webservice.PathParameter("credential", "Credential's Id, e.g. dockerhub-id")).
+		Param(webservice.QueryParameter("content", `
+Get extra content, if not none will get credential's content.
+There are three main types of fields in the credential.
+All credential fields, such as name, id, etc., will be returned each time.
+Some credential non-encrypted fields, such as the username of the username-password type credential, which returns when the "content" parameter is set to non-empty.
+Some encrypted fields, such as the password of the username password type credential, this part of the field will never return.
+`)).
 		Returns(http.StatusOK, RespOK, devops.JenkinsCredential{}).
 		Reads(devops.JenkinsCredential{}))
 

pkg/models/devops/urlconfig.go

@@ -40,20 +40,20 @@ const (
 	ReplayPipelineUrl        = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/runs/%s/replay/"
 	GetBranchArtifactsUrl    = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/branches/%s/runs/%s/artifacts/?"
 	GetArtifactsUrl          = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/runs/%s/artifacts/?"
-	CheckBranchPipelineUrl = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/branches/%s/runs/%s/nodes/%s/steps/%s/"
-	CheckPipelineUrl       = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/runs/%s/nodes/%s/steps/%s/"
-	GetBranchNodeStepsUrl  = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/branches/%s/runs/%s/nodes/%s/steps/?"
-	GetNodeStepsUrl        = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/runs/%s/nodes/%s/steps/?"
-	ValidateUrl            = "/blue/rest/organizations/jenkins/scm/%s/validate"
-	GetSCMOrgUrl           = "/blue/rest/organizations/jenkins/scm/%s/organizations/?"
-	GetOrgRepoUrl          = "/blue/rest/organizations/jenkins/scm/%s/organizations/%s/repositories/?"
-	GetConsoleLogUrl       = "/job/%s/job/%s/indexing/consoleText"
-	ScanBranchUrl          = "/job/%s/job/%s/build?"
-	GetCrumbUrl            = "/crumbIssuer/api/json/"
-	CheckScriptCompileUrl  = "/job/init-job/descriptorByName/org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition/checkScriptCompile"
-	CheckCronUrl           = "/job/init-job/descriptorByName/hudson.triggers.TimerTrigger/checkSpec?"
-	ToJenkinsfileUrl       = "/pipeline-model-converter/toJenkinsfile"
-	ToJsonUrl              = "/pipeline-model-converter/toJson"
-	GetNotifyCommitUrl     = "/git/notifyCommit/?"
-	GithubWebhookUrl       = "/github-webhook/"
+	CheckBranchPipelineUrl   = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/branches/%s/runs/%s/nodes/%s/steps/%s/"
+	CheckPipelineUrl         = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/runs/%s/nodes/%s/steps/%s/"
+	GetBranchNodeStepsUrl    = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/branches/%s/runs/%s/nodes/%s/steps/?"
+	GetNodeStepsUrl          = "/blue/rest/organizations/jenkins/pipelines/%s/pipelines/%s/runs/%s/nodes/%s/steps/?"
+	ValidateUrl              = "/blue/rest/organizations/jenkins/scm/%s/validate"
+	GetSCMOrgUrl             = "/blue/rest/organizations/jenkins/scm/%s/organizations/?"
+	GetOrgRepoUrl            = "/blue/rest/organizations/jenkins/scm/%s/organizations/%s/repositories/?"
+	GetConsoleLogUrl         = "/job/%s/job/%s/indexing/consoleText"
+	ScanBranchUrl            = "/job/%s/job/%s/build?"
+	GetCrumbUrl              = "/crumbIssuer/api/json/"
+	CheckScriptCompileUrl    = "/job/init-job/descriptorByName/org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition/checkScriptCompile"
+	CheckCronUrl             = "/job/init-job/descriptorByName/hudson.triggers.TimerTrigger/checkSpec?"
+	ToJenkinsfileUrl         = "/pipeline-model-converter/toJenkinsfile"
+	ToJsonUrl                = "/pipeline-model-converter/toJson"
+	GetNotifyCommitUrl       = "/git/notifyCommit/?"
+	GithubWebhookUrl         = "/github-webhook/"
 )

pkg/utils/idutils/id_utils.go

@@ -116,4 +116,3 @@ func IPv4() (net.IP, error) {
 	}
 	return nil, errors.New("no ip address")
 }
-