diff --git a/pkg/apis/devops/v1alpha2/register.go b/pkg/apis/devops/v1alpha2/register.go index 69637263c..bfc2e3df8 100644 --- a/pkg/apis/devops/v1alpha2/register.go +++ b/pkg/apis/devops/v1alpha2/register.go @@ -135,7 +135,7 @@ func addWebService(c *restful.Container) error { To(devopsapi.UpdateDevOpsProjectPipelineHandler). Doc("Update devops project pipeline"). Param(webservice.PathParameter("devops", "devops project's Id")). - Param(webservice.PathParameter("pipelines", "pipeline name")). + Param(webservice.PathParameter("pipelines", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). Metadata(restfulspec.KeyOpenAPITags, tags). Returns(http.StatusOK, RespOK, devops.ProjectPipeline{}). Writes(devops.ProjectPipeline{}). @@ -146,7 +146,7 @@ func addWebService(c *restful.Container) error { Doc("Get devops project pipeline config"). Metadata(restfulspec.KeyOpenAPITags, tags). Param(webservice.PathParameter("devops", "devops project's Id")). - Param(webservice.PathParameter("pipelines", "pipeline name")). + Param(webservice.PathParameter("pipelines", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). Returns(http.StatusOK, RespOK, devops.ProjectPipeline{}). Writes(devops.ProjectPipeline{})) @@ -155,7 +155,7 @@ func addWebService(c *restful.Container) error { Doc("Get devops project pipeline sonarStatus"). Metadata(restfulspec.KeyOpenAPITags, tags). Param(webservice.PathParameter("devops", "devops project's Id")). - Param(webservice.PathParameter("pipelines", "pipeline name")). + Param(webservice.PathParameter("pipelines", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). Returns(http.StatusOK, RespOK, []devops.SonarStatus{}). Writes([]devops.SonarStatus{})) @@ -164,7 +164,7 @@ func addWebService(c *restful.Container) error { Doc("Get devops project pipeline sonarStatus"). Metadata(restfulspec.KeyOpenAPITags, tags). Param(webservice.PathParameter("devops", "devops project's Id")). - Param(webservice.PathParameter("pipelines", "pipeline name")). + Param(webservice.PathParameter("pipelines", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). Param(webservice.PathParameter("branches", "branch name")). Returns(http.StatusOK, RespOK, []devops.SonarStatus{}). Writes([]devops.SonarStatus{})) @@ -174,7 +174,7 @@ func addWebService(c *restful.Container) error { Doc("Delete devops project pipeline"). Metadata(restfulspec.KeyOpenAPITags, tags). Param(webservice.PathParameter("devops", "devops project's Id")). - Param(webservice.PathParameter("pipelines", "pipeline name"))) + Param(webservice.PathParameter("pipelines", "the name of pipeline, which helps to deliver continuous integration continuous deployment."))) webservice.Route(webservice.POST("/devops/{devops}/credentials"). To(devopsapi.CreateDevOpsProjectCredentialHandler). @@ -224,8 +224,8 @@ func addWebService(c *restful.Container) error { To(devopsapi.GetPipeline). Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Get DevOps Pipelines."). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("projectName", "devops project name")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). Returns(http.StatusOK, RespOK, devops.Pipeline{}). Writes(devops.Pipeline{})) @@ -234,16 +234,16 @@ func addWebService(c *restful.Container) error { To(devopsapi.SearchPipelines). Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Search DevOps resource."). - Param(webservice.QueryParameter("q", "query pipelines"). + Param(webservice.QueryParameter("q", "query pipelines, condition for filtering."). Required(false). DataFormat("q=%s")). - Param(webservice.QueryParameter("filter", "filter resource"). + Param(webservice.QueryParameter("filter", "Condition for filteringfilter folders or not.."). Required(false). DataFormat("filter=%s")). - Param(webservice.QueryParameter("start", "start page"). + Param(webservice.QueryParameter("start", "the count of item start."). Required(false). DataFormat("start=%d")). - Param(webservice.QueryParameter("limit", "limit count"). + Param(webservice.QueryParameter("limit", "the count of item limit."). Required(false). DataFormat("limit=%d")). Returns(http.StatusOK, RespOK, []devops.Pipeline{}). @@ -254,15 +254,15 @@ func addWebService(c *restful.Container) error { To(devopsapi.SearchPipelineRuns). Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Search DevOps Pipelines runs in branch."). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.QueryParameter("start", "start page"). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.QueryParameter("start", "the count of item start."). Required(false). DataFormat("start=%d")). - Param(webservice.QueryParameter("limit", "limit count"). + Param(webservice.QueryParameter("limit", "the count of item limit."). Required(false). DataFormat("limit=%d")). - Param(webservice.QueryParameter("branch", "branch "). + Param(webservice.QueryParameter("branch", "the name of branch, same as repository brnach, will be filter by branch."). Required(false). DataFormat("branch=%s")). Returns(http.StatusOK, RespOK, []devops.BranchPipelineRun{}). @@ -273,11 +273,11 @@ func addWebService(c *restful.Container) error { To(devopsapi.GetBranchPipelineRun). Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Get DevOps Pipelines run in branch."). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("branchName", "pipeline branch name")). - Param(webservice.PathParameter("runId", "pipeline runs id")). - Param(webservice.QueryParameter("start", "start"). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("branchName", "the name of branch, same as repository brnach.")). + Param(webservice.PathParameter("runId", "pipeline run id, the unique id for a pipeline once build.")). + Param(webservice.QueryParameter("start", "the count of item start."). Required(false). DataFormat("start=%d")). Returns(http.StatusOK, RespOK, devops.BranchPipelineRun{}). @@ -288,11 +288,11 @@ func addWebService(c *restful.Container) error { To(devopsapi.GetPipelineRunNodesbyBranch). Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Get node on DevOps Pipelines run."). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("branchName", "pipeline branch name")). - Param(webservice.PathParameter("runId", "pipeline runs id")). - Param(webservice.QueryParameter("limit", "limit"). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("branchName", "the name of branch, same as repository brnach.")). + Param(webservice.PathParameter("runId", "pipeline run id, the unique id for a pipeline once build.")). + Param(webservice.QueryParameter("limit", "the count of item limit."). Required(false). DataFormat("limit=%d"). DefaultValue("limit=10000")). @@ -305,13 +305,13 @@ func addWebService(c *restful.Container) error { Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Get pipelines step log."). Produces("text/plain; charset=utf-8"). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("branchName", "pipeline branch name")). - Param(webservice.PathParameter("runId", "pipeline runs id")). - Param(webservice.PathParameter("nodeId", "pipeline runs node id")). - Param(webservice.PathParameter("stepId", "pipeline runs step id")). - Param(webservice.QueryParameter("start", "start"). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("branchName", "the name of branch, same as repository brnach.")). + Param(webservice.PathParameter("runId", "pipeline run id, the unique id for a pipeline once build.")). + Param(webservice.PathParameter("nodeId", "pipeline node id, the one node in pipeline.")). + Param(webservice.PathParameter("stepId", "pipeline step id, the one step in pipeline.")). + Param(webservice.QueryParameter("start", "the count of item start."). Required(true). DataFormat("start=%d"). DefaultValue("start=0"))) @@ -322,12 +322,12 @@ func addWebService(c *restful.Container) error { Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Get pipelines step log."). Produces("text/plain; charset=utf-8"). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("runId", "pipeline runs id")). - Param(webservice.PathParameter("nodeId", "pipeline runs node id")). - Param(webservice.PathParameter("stepId", "pipeline runs step id")). - Param(webservice.QueryParameter("start", "start"). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("runId", "pipeline run id, the unique id for a pipeline once build.")). + Param(webservice.PathParameter("nodeId", "pipeline node id, the one node in pipeline.")). + Param(webservice.PathParameter("stepId", "pipeline step id, the one step in pipeline.")). + Param(webservice.QueryParameter("start", "the count of item start."). Required(true). DataFormat("start=%d"). DefaultValue("start=0"))) @@ -337,7 +337,7 @@ func addWebService(c *restful.Container) error { To(devopsapi.Validate). Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Validate Github personal access token."). - Param(webservice.PathParameter("scmId", "SCM id")). + Param(webservice.PathParameter("scmId", "the id of SCM.")). Returns(http.StatusOK, RespOK, devops.Validates{}). Writes(devops.Validates{})) @@ -346,8 +346,8 @@ func addWebService(c *restful.Container) error { To(devopsapi.GetSCMOrg). Metadata(restfulspec.KeyOpenAPITags, tags). Doc("List organizations of SCM"). - Param(webservice.PathParameter("scmId", "SCM id")). - Param(webservice.QueryParameter("credentialId", "credential id for SCM"). + Param(webservice.PathParameter("scmId", "the id of SCM.")). + Param(webservice.QueryParameter("credentialId", "credential id for SCM."). Required(true). DataFormat("credentialId=%s")). Returns(http.StatusOK, RespOK, []devops.SCMOrg{}). @@ -359,14 +359,14 @@ func addWebService(c *restful.Container) error { Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Get SCM repositories in an organization"). Param(webservice.PathParameter("scmId", "SCM id")). - Param(webservice.PathParameter("organizationId", "organization Id, such as github username")). - Param(webservice.QueryParameter("credentialId", "credential id for SCM"). + Param(webservice.PathParameter("organizationId", "organization Id, such as github username.")). + Param(webservice.QueryParameter("credentialId", "credential id for SCM."). Required(true). DataFormat("credentialId=%s")). - Param(webservice.QueryParameter("pageNumber", "page number"). + Param(webservice.QueryParameter("pageNumber", "the number of page."). Required(true). DataFormat("pageNumber=%d")). - Param(webservice.QueryParameter("pageSize", "page size"). + Param(webservice.QueryParameter("pageSize", "the size of page."). Required(true). DataFormat("pageSize=%d")). Returns(http.StatusOK, RespOK, []devops.OrgRepo{}). @@ -377,15 +377,15 @@ func addWebService(c *restful.Container) error { To(devopsapi.StopBranchPipeline). Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Stop pipeline in running"). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("branchName", "pipeline branch name")). - Param(webservice.PathParameter("runId", "pipeline runs id")). - Param(webservice.QueryParameter("blocking", "stop and between each retries will sleep"). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("branchName", "the name of branch, same as repository brnach.")). + Param(webservice.PathParameter("runId", "pipeline run id, the unique id for a pipeline once build.")). + Param(webservice.QueryParameter("blocking", "stop and between each retries will sleep."). Required(false). DataFormat("blocking=%t"). DefaultValue("blocking=false")). - Param(webservice.QueryParameter("timeOutInSecs", "the time of stop and between each retries sleep"). + Param(webservice.QueryParameter("timeOutInSecs", "the time of stop and between each retries sleep."). Required(false). DataFormat("timeOutInSecs=%d"). DefaultValue("timeOutInSecs=10")). @@ -397,14 +397,14 @@ func addWebService(c *restful.Container) error { To(devopsapi.StopPipeline). Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Stop pipeline in running"). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("runId", "pipeline runs id")). - Param(webservice.QueryParameter("blocking", "stop and between each retries will sleep"). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("runId", "pipeline run id, the unique id for a pipeline once build.")). + Param(webservice.QueryParameter("blocking", "stop and between each retries will sleep."). Required(false). DataFormat("blocking=%t"). DefaultValue("blocking=false")). - Param(webservice.QueryParameter("timeOutInSecs", "the time of stop and between each retries sleep"). + Param(webservice.QueryParameter("timeOutInSecs", "the time of stop and between each retries sleep."). Required(false). DataFormat("timeOutInSecs=%d"). DefaultValue("timeOutInSecs=10")). @@ -416,10 +416,10 @@ func addWebService(c *restful.Container) error { To(devopsapi.ReplayBranchPipeline). Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Replay pipeline"). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("branchName", "pipeline branch name")). - Param(webservice.PathParameter("runId", "pipeline runs id")). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("branchName", "the name of branch, same as repository brnach.")). + Param(webservice.PathParameter("runId", "pipeline run id, the unique id for a pipeline once build.")). Returns(http.StatusOK, RespOK, devops.ReplayPipe{}). Writes(devops.ReplayPipe{})) @@ -428,9 +428,9 @@ func addWebService(c *restful.Container) error { To(devopsapi.ReplayPipeline). Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Replay pipeline"). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("runId", "pipeline runs id")). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("runId", "pipeline run id, the unique id for a pipeline once build.")). Returns(http.StatusOK, RespOK, devops.ReplayPipe{}). Writes(devops.ReplayPipe{})) @@ -440,11 +440,11 @@ func addWebService(c *restful.Container) error { Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Get Pipelines run log."). Produces("text/plain; charset=utf-8"). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("branchName", "pipeline branch name")). - Param(webservice.PathParameter("runId", "pipeline runs id")). - Param(webservice.QueryParameter("start", "start"). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("branchName", "the name of branch, same as repository brnach.")). + Param(webservice.PathParameter("runId", "pipeline run id, the unique id for a pipeline once build.")). + Param(webservice.QueryParameter("start", "the count of item start."). Required(true). DataFormat("start=%d"). DefaultValue("start=0"))) @@ -455,10 +455,10 @@ func addWebService(c *restful.Container) error { Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Get Pipelines run log."). Produces("text/plain; charset=utf-8"). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("runId", "pipeline runs id")). - Param(webservice.QueryParameter("start", "start"). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("runId", "pipeline run id, the unique id for a pipeline once build.")). + Param(webservice.QueryParameter("start", "the count of item start."). Required(true). DataFormat("start=%d"). DefaultValue("start=0"))) @@ -468,14 +468,14 @@ func addWebService(c *restful.Container) error { To(devopsapi.GetBranchArtifacts). Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Get pipeline artifacts."). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("branchName", "pipeline branch name")). - Param(webservice.PathParameter("runId", "pipeline runs id")). - Param(webservice.QueryParameter("start", "start page"). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("branchName", "the name of branch, same as repository brnach.")). + Param(webservice.PathParameter("runId", "pipeline run id, the unique id for a pipeline once build.")). + Param(webservice.QueryParameter("start", "the count of item start."). Required(false). DataFormat("start=%d")). - Param(webservice.QueryParameter("limit", "limit count"). + Param(webservice.QueryParameter("limit", "the count of item limit."). Required(false). DataFormat("limit=%d")). Returns(http.StatusOK, "The filed of \"Url\" in response can download artifacts", []devops.Artifacts{}). @@ -486,13 +486,13 @@ func addWebService(c *restful.Container) error { To(devopsapi.GetArtifacts). Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Get pipeline artifacts."). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("runId", "pipeline runs id")). - Param(webservice.QueryParameter("start", "start page"). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("runId", "pipeline run id, the unique id for a pipeline once build.")). + Param(webservice.QueryParameter("start", "the count of item start."). Required(false). DataFormat("start=%d")). - Param(webservice.QueryParameter("limit", "limit count"). + Param(webservice.QueryParameter("limit", "the count of item limit."). Required(false). DataFormat("limit=%d")). Returns(http.StatusOK, "The filed of \"Url\" in response can download artifacts", []devops.Artifacts{}). @@ -503,15 +503,15 @@ func addWebService(c *restful.Container) error { To(devopsapi.GetPipeBranch). Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Get pipeline of branch."). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). Param(webservice.QueryParameter("filter", "filter remote"). Required(true). DataFormat("filter=%s")). - Param(webservice.QueryParameter("start", "start"). + Param(webservice.QueryParameter("start", "the count of item start."). Required(true). DataFormat("start=%d")). - Param(webservice.QueryParameter("limit", "limit count"). + Param(webservice.QueryParameter("limit", "the count of item limit."). Required(true). DataFormat("limit=%d")). Returns(http.StatusOK, RespOK, []devops.PipeBranch{}). @@ -524,12 +524,12 @@ func addWebService(c *restful.Container) error { Doc("Pauses pipeline execution and allows the user to interact and control the flow of the build."). Reads(devops.CheckPlayload{}). Produces("text/plain; charset=utf-8"). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("branchName", "pipeline branch name")). - Param(webservice.PathParameter("runId", "pipeline runs id")). - Param(webservice.PathParameter("nodeId", "pipeline node id")). - Param(webservice.PathParameter("stepId", "pipeline step id"))) + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("branchName", "the name of branch, same as repository brnach.")). + Param(webservice.PathParameter("runId", "pipeline run id, the unique id for a pipeline once build.")). + Param(webservice.PathParameter("nodeId", "pipeline node id, the one node in pipeline.")). + Param(webservice.PathParameter("stepId", "pipeline step id, the one step in pipeline."))) // match /blue/rest/organizations/jenkins/pipelines/{projectName}/pipelines/{pipelineName}/runs/{runId}/nodes/{nodeId}/steps/{stepId} webservice.Route(webservice.POST("/devops/{projectName}/pipelines/{pipelineName}/runs/{runId}/nodes/{nodeId}/steps/{stepId}"). @@ -538,10 +538,10 @@ func addWebService(c *restful.Container) error { Doc("Pauses pipeline execution and allows the user to interact and control the flow of the build."). Reads(devops.CheckPlayload{}). Produces("text/plain; charset=utf-8"). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("runId", "pipeline runs id")). - Param(webservice.PathParameter("nodeId", "pipeline node id")). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("runId", "pipeline run id, the unique id for a pipeline once build.")). + Param(webservice.PathParameter("nodeId", "pipeline node id, the one node in pipeline.")). Param(webservice.PathParameter("stepId", "pipeline step id"))) // match /job/project-8QnvykoJw4wZ/job/test-1/indexing/consoleText @@ -550,8 +550,8 @@ func addWebService(c *restful.Container) error { Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Get index console log."). Produces("text/plain; charset=utf-8"). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name"))) + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment."))) // match /job/{projectName}/job/{pipelineName}/build?delay=0 webservice.Route(webservice.POST("/devops/{projectName}/pipelines/{pipelineName}/scan"). @@ -559,10 +559,10 @@ func addWebService(c *restful.Container) error { Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Start a build."). Produces("text/html; charset=utf-8"). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.QueryParameter("delay", "delay time"). - Required(true). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.QueryParameter("delay", "will be delay time to scan."). + Required(false). DataFormat("delay=%d"))) // match /blue/rest/organizations/jenkins/pipelines/{projectName}/{pipelineName}/branches/{}/runs/ @@ -571,9 +571,9 @@ func addWebService(c *restful.Container) error { Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Run pipeline."). Reads(devops.RunPayload{}). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("branchName", "pipeline branch name")). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("branchName", "the name of branch, same as repository brnach.")). Returns(http.StatusOK, RespOK, devops.QueuedBlueRun{}). Writes(devops.QueuedBlueRun{})) @@ -583,8 +583,8 @@ func addWebService(c *restful.Container) error { Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Run pipeline."). Reads(devops.RunPayload{}). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). Returns(http.StatusOK, RespOK, devops.QueuedBlueRun{}). Writes(devops.QueuedBlueRun{})) @@ -593,12 +593,12 @@ func addWebService(c *restful.Container) error { To(devopsapi.GetBranchStepsStatus). Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Get pipeline steps status."). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("branchName", "pipeline branch name")). - Param(webservice.PathParameter("runId", "pipeline run name")). - Param(webservice.PathParameter("nodeId", "pipeline node id")). - Param(webservice.QueryParameter("limit", "limit count"). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("branchName", "the name of branch, same as repository brnach.")). + Param(webservice.PathParameter("runId", "pipeline run id, the unique id for a pipeline once build.")). + Param(webservice.PathParameter("nodeId", "pipeline node id, the one node in pipeline.")). + Param(webservice.QueryParameter("limit", "the count of item limit."). Required(true). DataFormat("limit=%d")). Returns(http.StatusOK, RespOK, []devops.QueuedBlueRun{}). @@ -609,11 +609,11 @@ func addWebService(c *restful.Container) error { To(devopsapi.GetStepsStatus). Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Get pipeline steps status."). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("runId", "pipeline run name")). - Param(webservice.PathParameter("nodeId", "pipeline node id")). - Param(webservice.QueryParameter("limit", "limit count"). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("runId", "pipeline run id, the unique id for a pipeline once build.")). + Param(webservice.PathParameter("nodeId", "pipeline node id, the one node in pipeline.")). + Param(webservice.QueryParameter("limit", "the count of item limit."). Required(true). DataFormat("limit=%d")). Returns(http.StatusOK, RespOK, []devops.QueuedBlueRun{}). @@ -623,7 +623,7 @@ func addWebService(c *restful.Container) error { webservice.Route(webservice.GET("/devops/crumbissuer"). To(devopsapi.GetCrumb). Metadata(restfulspec.KeyOpenAPITags, tags). - Doc("Get crumb"). + Doc("Get crumb issuer."). Returns(http.StatusOK, RespOK, devops.Crumb{}). Writes(devops.Crumb{})) @@ -644,7 +644,7 @@ func addWebService(c *restful.Container) error { Metadata(restfulspec.KeyOpenAPITags, tags). Produces("application/json", "charset=utf-8"). Doc("Check cron script compile."). - Param(webservice.QueryParameter("value", "cpec value"). + Param(webservice.QueryParameter("value", "string of cron script."). Required(true). DataFormat("value=%s")). Returns(http.StatusOK, RespOK, []devops.QueuedBlueRun{}). @@ -656,9 +656,9 @@ func addWebService(c *restful.Container) error { To(devopsapi.GetPipelineRun). Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Get run pipeline in project."). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("runId", "pipeline run id")). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("runId", "pipeline run id, the unique id for a pipeline once build.")). Returns(http.StatusOK, RespOK, devops.PipelineRun{}). Writes(devops.PipelineRun{})) @@ -666,10 +666,10 @@ func addWebService(c *restful.Container) error { webservice.Route(webservice.GET("/devops/{projectName}/pipelines/{pipelineName}/branches/{branchName}"). To(devopsapi.GetBranchPipeline). Metadata(restfulspec.KeyOpenAPITags, tags). - Doc("Get Pipeline run in branch."). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("branchName", "pipeline branch name")). + Doc("Get Pipeline run by branch."). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("branchName", "the name of branch, same as repository brnach")). Returns(http.StatusOK, RespOK, devops.BranchPipeline{}). Writes(devops.BranchPipeline{})) @@ -678,10 +678,10 @@ func addWebService(c *restful.Container) error { To(devopsapi.GetPipelineRunNodes). Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Get Pipeline run nodes."). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("runId", "pipeline run id")). - Param(webservice.QueryParameter("limit", "limit count"). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("runId", "pipeline run id, the unique id for a pipeline once build")). + Param(webservice.QueryParameter("limit", "the count of item limit"). Required(false). DataFormat("limit=%d")). Returns(http.StatusOK, RespOK, []devops.PipelineRunNodes{}). @@ -691,13 +691,13 @@ func addWebService(c *restful.Container) error { webservice.Route(webservice.GET("/devops/{projectName}/pipelines/{pipelineName}/branches/{branchName}/runs/{runId}/nodes/{nodeId}/steps"). To(devopsapi.GetBranchNodeSteps). Metadata(restfulspec.KeyOpenAPITags, tags). - Doc("Get steps in node."). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("branchName", "pipeline branch name")). - Param(webservice.PathParameter("runId", "pipeline run id")). - Param(webservice.PathParameter("nodeId", "pipeline node id")). - Param(webservice.QueryParameter("limit", "limit count"). + Doc("Get steps in node by branch."). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("branchName", "the name of branch, same as repository brnach.")). + Param(webservice.PathParameter("runId", "pipeline run id, the unique id for a pipeline once build.")). + Param(webservice.PathParameter("nodeId", "pipeline node id, the one node in pipeline.")). + Param(webservice.QueryParameter("limit", "the count of item limit."). Required(false). DataFormat("limit=%d")). Returns(http.StatusOK, RespOK, []devops.NodeSteps{}). @@ -708,11 +708,11 @@ func addWebService(c *restful.Container) error { To(devopsapi.GetNodeSteps). Metadata(restfulspec.KeyOpenAPITags, tags). Doc("Get steps in node."). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("runId", "pipeline run id")). - Param(webservice.PathParameter("nodeId", "pipeline node id")). - Param(webservice.QueryParameter("limit", "limit count"). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("runId", "pipeline run id, the unique id for a pipeline once build")). + Param(webservice.PathParameter("nodeId", "pipeline node id, the one node in pipeline.")). + Param(webservice.QueryParameter("limit", "the count of item limit."). Required(false). DataFormat("limit=%d")). Returns(http.StatusOK, RespOK, []devops.NodeSteps{}). @@ -724,7 +724,7 @@ func addWebService(c *restful.Container) error { Metadata(restfulspec.KeyOpenAPITags, tags). Consumes("application/x-www-form-urlencoded"). Produces("application/json", "charset=utf-8"). - Doc("Json to Jenkinsfile."). + Doc("Convert json to jenkinsfile format."). Reads(devops.ReqJson{}). Returns(http.StatusOK, RespOK, devops.NodeSteps{}). Writes(devops.ResJenkinsfile{})) @@ -735,7 +735,7 @@ func addWebService(c *restful.Container) error { Metadata(restfulspec.KeyOpenAPITags, tags). Consumes("application/x-www-form-urlencoded"). Produces("application/json", "charset=utf-8"). - Doc("Jenkinsfile to Json."). + Doc("Convert jenkinsfile to json format."). Reads(devops.ReqJenkinsfile{}). Returns(http.StatusOK, RespOK, devops.ResJson{}). Writes(devops.ResJson{})) @@ -744,7 +744,7 @@ func addWebService(c *restful.Container) error { webservice.Route(webservice.GET("/devops/notifycommit"). To(devopsapi.GetNotifyCommit). Metadata(restfulspec.KeyOpenAPITags, tags). - Doc("Get Notify Commit by GET HTTP method."). + Doc("Get notify commit by GET HTTP method."). Produces("text/plain; charset=utf-8"). Param(webservice.QueryParameter("url", "the url for webhook to push."). Required(true). @@ -754,7 +754,7 @@ func addWebService(c *restful.Container) error { webservice.Route(webservice.POST("/devops/notifycommit"). To(devopsapi.GetNotifyCommit). Metadata(restfulspec.KeyOpenAPITags, tags). - Doc("Get Notify Commit by POST HTTP method."). + Doc("Get notify commit by POST HTTP method."). Consumes("application/json"). Produces("text/plain; charset=utf-8"). Param(webservice.QueryParameter("url", "the url for webhook to push."). @@ -770,12 +770,12 @@ func addWebService(c *restful.Container) error { webservice.Route(webservice.GET("/devops/{projectName}/pipelines/{pipelineName}/branches/{branchName}/runs/{runId}/nodesdetail"). To(devopsapi.GetBranchNodesDetail). Metadata(restfulspec.KeyOpenAPITags, tags). - Doc("Get pipeline nodes stages detail"). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("branchName", "pipeline branch name")). - Param(webservice.PathParameter("runId", "pipeline runs id")). - Param(webservice.QueryParameter("limit", "limit count"). + Doc("Gives steps details inside a pipeline node by branch. For a Stage, the steps will include all the steps defined inside the stage."). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("branchName", "the name of branch, same as repository brnach.")). + Param(webservice.PathParameter("runId", "pipeline run id, the unique id for a pipeline once build.")). + Param(webservice.QueryParameter("limit", "the count of item limit."). Required(true). DataFormat("limit=%d")). Returns(http.StatusOK, RespOK, []devops.NodesDetail{}). @@ -785,12 +785,12 @@ func addWebService(c *restful.Container) error { webservice.Route(webservice.GET("/devops/{projectName}/pipelines/{pipelineName}/runs/{runId}/nodesdetail"). To(devopsapi.GetNodesDetail). Metadata(restfulspec.KeyOpenAPITags, tags). - Doc("Get pipeline nodes stages detail"). - Param(webservice.PathParameter("pipelineName", "pipeline name")). - Param(webservice.PathParameter("projectName", "devops project name")). - Param(webservice.PathParameter("branchName", "pipeline branch name")). - Param(webservice.PathParameter("runId", "pipeline runs id")). - Param(webservice.QueryParameter("limit", "limit count"). + Doc("Gives steps details inside a pipeline node. For a Stage, the steps will include all the steps defined inside the stage."). + Param(webservice.PathParameter("projectName", "the name of devops project, the project set of software development practices that combines software development (Dev) and information technology operations (Ops) to shorten the systems development life cycle while delivering features, fixes, and updates frequently in close alignment with business objectives.")). + Param(webservice.PathParameter("pipelineName", "the name of pipeline, which helps to deliver continuous integration continuous deployment.")). + Param(webservice.PathParameter("branchName", "the name of branch, same as repository brnach.")). + Param(webservice.PathParameter("runId", "pipeline run id, the unique id for a pipeline once build.")). + Param(webservice.QueryParameter("limit", "the count of item limit."). Required(true). DataFormat("limit=%d")). Returns(http.StatusOK, RespOK, []devops.NodesDetail{}). diff --git a/pkg/models/devops/json.go b/pkg/models/devops/json.go index 3f746c819..6c6c72bce 100644 --- a/pkg/models/devops/json.go +++ b/pkg/models/devops/json.go @@ -19,7 +19,7 @@ package devops // GetPipeline & SearchPipelines type Pipeline struct { - Class string `json:"_class,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." ` Links struct { Self struct { Class string `json:"_class,omitempty"` @@ -49,44 +49,44 @@ type Pipeline struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` } `json:"queue,omitempty"` - } `json:"_links,omitempty"` - Actions []interface{} `json:"actions,omitempty"` - Disabled interface{} `json:"disabled,omitempty"` - DisplayName string `json:"displayName,omitempty"` - FullDisplayName string `json:"fullDisplayName,omitempty"` - FullName string `json:"fullName,omitempty"` - Name string `json:"name,omitempty"` - Organization string `json:"organization,omitempty"` - Parameters interface{} `json:"parameters,omitempty"` + } `json:"_links,omitempty" description:"references the reachable path to this resource."` + Actions []interface{} `json:"actions,omitempty" description:"the list of actions."` + Disabled interface{} `json:"disabled,omitempty" description:"disable or not"` + DisplayName string `json:"displayName,omitempty" description:"display name"` + FullDisplayName string `json:"fullDisplayName,omitempty" description:"full display name"` + FullName string `json:"fullName,omitempty" description:"full name"` + Name string `json:"name,omitempty" description:"name"` + Organization string `json:"organization,omitempty" description:"organization name"` + Parameters interface{} `json:"parameters,omitempty" description:"parameters of pipeline"` Permissions struct { - Create bool `json:"create,omitempty"` - Configure bool `json:"configure,omitempty"` - Read bool `json:"read,omitempty"` - Start bool `json:"start,omitempty"` - Stop bool `json:"stop,omitempty"` - } `json:"permissions,omitempty"` - EstimatedDurationInMillis int `json:"estimatedDurationInMillis,omitempty"` - NumberOfFolders int `json:"numberOfFolders,omitempty"` - NumberOfPipelines int `json:"numberOfPipelines,omitempty"` - PipelineFolderNames []interface{} `json:"pipelineFolderNames,omitempty"` - WeatherScore int `json:"weatherScore,omitempty"` - BranchNames []string `json:"branchNames,omitempty"` - NumberOfFailingBranches int `json:"numberOfFailingBranches,omitempty"` - NumberOfFailingPullRequests int `json:"numberOfFailingPullRequests,omitempty"` - NumberOfSuccessfulBranches int `json:"numberOfSuccessfulBranches,omitempty"` - NumberOfSuccessfulPullRequests int `json:"numberOfSuccessfulPullRequests,omitempty"` + Create bool `json:"create,omitempty" description:"create action"` + Configure bool `json:"configure,omitempty" description:"configure action"` + Read bool `json:"read,omitempty" description:"read action"` + Start bool `json:"start,omitempty" description:"start action"` + Stop bool `json:"stop,omitempty" description:"stop action"` + } `json:"permissions,omitempty" description:"permissions"` + EstimatedDurationInMillis int `json:"estimatedDurationInMillis,omitempty" description:"estimated duration time, unit is millis"` + NumberOfFolders int `json:"numberOfFolders,omitempty" description:"number of folders"` + NumberOfPipelines int `json:"numberOfPipelines,omitempty" description:"number of pipelines"` + PipelineFolderNames []interface{} `json:"pipelineFolderNames,omitempty" description:"pipeline folder names"` + WeatherScore int `json:"weatherScore,omitempty" description:"the score to description the result of pipeline"` + BranchNames []string `json:"branchNames,omitempty" description:"branch names"` + NumberOfFailingBranches int `json:"numberOfFailingBranches,omitempty" description:"number of failing branches"` + NumberOfFailingPullRequests int `json:"numberOfFailingPullRequests,omitempty" description:"number of failing pull requests"` + NumberOfSuccessfulBranches int `json:"numberOfSuccessfulBranches,omitempty" description:"number of successful pull requests"` + NumberOfSuccessfulPullRequests int `json:"numberOfSuccessfulPullRequests,omitempty" description:"number of successful pull requests"` ScmSource struct { - Class string `json:"_class,omitempty"` - APIURL interface{} `json:"apiUrl,omitempty"` - ID string `json:"id,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."` + APIURL interface{} `json:"apiUrl,omitempty" description:"api url"` + ID string `json:"id,omitempty" description:"scm source id"` } `json:"scmSource,omitempty"` - TotalNumberOfBranches int `json:"totalNumberOfBranches,omitempty"` - TotalNumberOfPullRequests int `json:"totalNumberOfPullRequests,omitempty"` + TotalNumberOfBranches int `json:"totalNumberOfBranches,omitempty" description:"total number of branches"` + TotalNumberOfPullRequests int `json:"totalNumberOfPullRequests,omitempty" description:"total number of pull requests"` } // GetPipeBranchRun & SearchPipelineRuns type BranchPipelineRun struct { - Class string `json:"_class,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."` Links struct { PrevRun struct { Class string `json:"_class,omitempty"` @@ -132,45 +132,45 @@ type BranchPipelineRun struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` } `json:"nextRun,omitempty"` - } `json:"_links,omitempty"` - Actions []interface{} `json:"actions,omitempty"` - ArtifactsZipFile interface{} `json:"artifactsZipFile,omitempty"` - CauseOfBlockage interface{} `json:"causeOfBlockage,omitempty"` + } `json:"_links,omitempty" description:"references the reachable path to this resource"` + Actions []interface{} `json:"actions,omitempty" description:"the list of actions"` + ArtifactsZipFile interface{} `json:"artifactsZipFile,omitempty" description:"the artifacts zip file"` + CauseOfBlockage interface{} `json:"causeOfBlockage,omitempty" description:"cause of blockage"` Causes []struct { - Class string `json:"_class,omitempty"` - ShortDescription string `json:"shortDescription,omitempty"` - UserID string `json:"userId,omitempty"` - UserName string `json:"userName,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."` + ShortDescription string `json:"shortDescription,omitempty" description:"short description"` + UserID string `json:"userId,omitempty" description:"user id"` + UserName string `json:"userName,omitempty" description:"user name"` } `json:"causes,omitempty"` - ChangeSet []interface{} `json:"changeSet,omitempty"` - Description interface{} `json:"description,omitempty"` - DurationInMillis int `json:"durationInMillis,omitempty"` - EnQueueTime string `json:"enQueueTime,omitempty"` - EndTime string `json:"endTime,omitempty"` - EstimatedDurationInMillis int `json:"estimatedDurationInMillis,omitempty"` - ID string `json:"id,omitempty"` - Name interface{} `json:"name,omitempty"` - Organization string `json:"organization,omitempty"` - Pipeline string `json:"pipeline,omitempty"` - Replayable bool `json:"replayable,omitempty"` - Result string `json:"result,omitempty"` - RunSummary string `json:"runSummary,omitempty"` - StartTime string `json:"startTime,omitempty"` - State string `json:"state,omitempty"` - Type string `json:"type,omitempty"` + ChangeSet []interface{} `json:"changeSet,omitempty" description:"change set"` + Description interface{} `json:"description,omitempty" description:"description of resource"` + DurationInMillis int `json:"durationInMillis,omitempty" description:"duration time in millis"` + EnQueueTime string `json:"enQueueTime,omitempty" description:"enqueue time"` + EndTime string `json:"endTime,omitempty" description:"end time"` + EstimatedDurationInMillis int `json:"estimatedDurationInMillis,omitempty" description:"estimated duration time in millis"` + ID string `json:"id,omitempty" description:"id"` + Name interface{} `json:"name,omitempty" description:"name"` + Organization string `json:"organization,omitempty" description:"organization name"` + Pipeline string `json:"pipeline,omitempty" description:"pipeline name"` + Replayable bool `json:"replayable,omitempty" description:"replayable or not"` + Result string `json:"result,omitempty" description:"result"` + RunSummary string `json:"runSummary,omitempty" description:"pipeline run summary"` + StartTime string `json:"startTime,omitempty" description:"start time"` + State string `json:"state,omitempty" description:"pipeline run state"` + Type string `json:"type,omitempty" description:"source type"` Branch struct { - IsPrimary bool `json:"isPrimary,omitempty"` - Issues []interface{} `json:"issues,omitempty"` - URL string `json:"url,omitempty"` + IsPrimary bool `json:"isPrimary,omitempty" description:"primary or not"` + Issues []interface{} `json:"issues,omitempty" description:"issues"` + URL string `json:"url,omitempty" description:"url"` } `json:"branch,omitempty"` - CommitID string `json:"commitId,omitempty"` - CommitURL interface{} `json:"commitUrl,omitempty"` - PullRequest interface{} `json:"pullRequest,omitempty"` + CommitID string `json:"commitId,omitempty" description:"commit id"` + CommitURL interface{} `json:"commitUrl,omitempty" description:"commit url "` + PullRequest interface{} `json:"pullRequest,omitempty" description:"pull request"` } // GetBranchPipeRunNodes type BranchPipelineRunNodes struct { - Class string `json:"_class,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."` Links struct { Self struct { Class string `json:"_class,omitempty"` @@ -184,27 +184,27 @@ type BranchPipelineRunNodes struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` } `json:"steps,omitempty"` - } `json:"_links,omitempty"` - Actions []interface{} `json:"actions,omitempty"` - DisplayDescription interface{} `json:"displayDescription,omitempty"` - DisplayName string `json:"displayName,omitempty"` - DurationInMillis int `json:"durationInMillis,omitempty"` - ID string `json:"id,omitempty"` - Input interface{} `json:"input,omitempty"` - Result string `json:"result,omitempty"` - StartTime string `json:"startTime,omitempty"` - State string `json:"state,omitempty"` - Type string `json:"type,omitempty"` - CauseOfBlockage interface{} `json:"causeOfBlockage,omitempty"` + } `json:"_links,omitempty" description:"references the reachable path to this resource"` + Actions []interface{} `json:"actions,omitempty" description:"the list of actions"` + DisplayDescription interface{} `json:"displayDescription,omitempty" description:"display description"` + DisplayName string `json:"displayName,omitempty" description:"display name"` + DurationInMillis int `json:"durationInMillis,omitempty" description:"duration time in millis"` + ID string `json:"id,omitempty" description:"id"` + Input interface{} `json:"input,omitempty" description:"input"` + Result string `json:"result,omitempty" description:"result"` + StartTime string `json:"startTime,omitempty" description:"start time"` + State string `json:"state,omitempty" description:"statue"` + Type string `json:"type,omitempty" description:"source type"` + CauseOfBlockage interface{} `json:"causeOfBlockage,omitempty" description:"cause of blockage"` Edges []struct { - Class string `json:"_class,omitempty"` - ID string `json:"id,omitempty"` - Type string `json:"type,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."` + ID string `json:"id,omitempty" description:"id"` + Type string `json:"type,omitempty" description:"source type"` } `json:"edges,omitempty"` - FirstParent interface{} `json:"firstParent,omitempty"` - Restartable bool `json:"restartable,omitempty"` + FirstParent interface{} `json:"firstParent,omitempty" description:"first parent resource"` + Restartable bool `json:"restartable,omitempty" description:"restartable or not"` Steps []struct { - Class string `json:"_class,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."` Links struct { Self struct { Class string `json:"_class,omitempty"` @@ -224,27 +224,27 @@ type BranchPipelineRunNodes struct { } `json:"self,omitempty"` } `json:"_links,omitempty"` URLName string `json:"urlName,omitempty"` - } `json:"actions,omitempty"` - DisplayDescription interface{} `json:"displayDescription,omitempty"` - DisplayName string `json:"displayName,omitempty"` - DurationInMillis int `json:"durationInMillis,omitempty"` - ID string `json:"id,omitempty"` - Input interface{} `json:"input,omitempty"` - Result string `json:"result,omitempty"` - StartTime string `json:"startTime,omitempty"` - State string `json:"state,omitempty"` - Type string `json:"type,omitempty"` + } `json:"actions,omitempty" description:"references the reachable path to this resource"` + DisplayDescription interface{} `json:"displayDescription,omitempty" description:"display description"` + DisplayName string `json:"displayName,omitempty" description:"display name"` + DurationInMillis int `json:"durationInMillis,omitempty" description:"duration time in millis"` + ID string `json:"id,omitempty" description:"id"` + Input interface{} `json:"input,omitempty" description:"input"` + Result string `json:"result,omitempty" description:"result"` + StartTime string `json:"startTime,omitempty" description:"start time"` + State string `json:"state,omitempty" description:"source state"` + Type string `json:"type,omitempty" description:"source type"` } `json:"steps,omitempty"` } // Validate type Validates struct { - CredentialID string `json:"credentialId,omitempty"` + CredentialID string `json:"credentialId,omitempty" description:"credential id"` } // GetSCMOrg type SCMOrg struct { - Class string `json:"_class,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."` Links struct { Repositories struct { Class string `json:"_class,omitempty"` @@ -254,57 +254,57 @@ type SCMOrg struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` } `json:"self,omitempty"` - } `json:"_links,omitempty"` - Avatar string `json:"avatar,omitempty"` - JenkinsOrganizationPipeline bool `json:"jenkinsOrganizationPipeline,omitempty"` - Name string `json:"name,omitempty"` + } `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 "` } // GetOrgRepo type OrgRepo struct { - Class string `json:"_class,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."` Links struct { Self struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` } `json:"self,omitempty"` - } `json:"_links,omitempty"` + } `json:"_links,omitempty" description:"references the reachable path to this resource"` Repositories struct { - Class string `json:"_class,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."` Links struct { Self struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` } `json:"self,omitempty"` - } `json:"_links,omitempty"` + } `json:"_links,omitempty" description:"references the reachable path to this resource"` Items []struct { - Class string `json:"_class,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."` Links struct { Self struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` } `json:"self,omitempty"` - } `json:"_links,omitempty"` - DefaultBranch string `json:"defaultBranch,omitempty"` - Description string `json:"description,omitempty"` - Name string `json:"name,omitempty"` + } `json:"_links,omitempty" description:"references the reachable path to this resource"` + DefaultBranch string `json:"defaultBranch,omitempty" description:"default branch"` + Description string `json:"description,omitempty" description:"description"` + Name string `json:"name,omitempty" description:"name"` Permissions struct { - Admin bool `json:"admin,omitempty"` - Push bool `json:"push,omitempty"` - Pull bool `json:"pull,omitempty"` + Admin bool `json:"admin,omitempty" description:"admin"` + Push bool `json:"push,omitempty" description:"push action"` + Pull bool `json:"pull,omitempty" description:"pull action"` } `json:"permissions,omitempty"` - Private bool `json:"private,omitempty"` - FullName string `json:"fullName,omitempty"` + Private bool `json:"private,omitempty" description:"private"` + FullName string `json:"fullName,omitempty" description:"full name"` } `json:"items,omitempty"` - LastPage interface{} `json:"lastPage,omitempty"` - NextPage interface{} `json:"nextPage,omitempty"` - PageSize int `json:"pageSize,omitempty"` + LastPage interface{} `json:"lastPage,omitempty" description:"last page"` + NextPage interface{} `json:"nextPage,omitempty" description:"next page"` + PageSize int `json:"pageSize,omitempty" description:"page size"` } `json:"repositories,omitempty"` } // StopPipeline type StopPipe struct { - Class string `json:"_class,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."` Links struct { Parent struct { Class string `json:"_class,omitempty"` @@ -342,43 +342,43 @@ type StopPipe struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` } `json:"artifacts,omitempty"` - } `json:"_links,omitempty"` - Actions []interface{} `json:"actions,omitempty"` - ArtifactsZipFile interface{} `json:"artifactsZipFile,omitempty"` - CauseOfBlockage interface{} `json:"causeOfBlockage,omitempty"` + } `json:"_links,omitempty" description:"references the reachable path to this resource"` + Actions []interface{} `json:"actions,omitempty" description:"the list of actions."` + ArtifactsZipFile interface{} `json:"artifactsZipFile,omitempty" description:"the artifacts zip file"` + CauseOfBlockage interface{} `json:"causeOfBlockage,omitempty" description:"cause of blockage"` Causes []struct { - Class string `json:"_class,omitempty"` - ShortDescription string `json:"shortDescription,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."` + ShortDescription string `json:"shortDescription,omitempty" description:"short description"` } `json:"causes,omitempty"` - ChangeSet []interface{} `json:"changeSet,omitempty"` - Description interface{} `json:"description,omitempty"` - DurationInMillis int `json:"durationInMillis,omitempty"` - EnQueueTime string `json:"enQueueTime,omitempty"` - EndTime string `json:"endTime,omitempty"` - EstimatedDurationInMillis int `json:"estimatedDurationInMillis,omitempty"` - ID string `json:"id,omitempty"` - Name interface{} `json:"name,omitempty"` - Organization string `json:"organization,omitempty"` - Pipeline string `json:"pipeline,omitempty"` - Replayable bool `json:"replayable,omitempty"` - Result string `json:"result,omitempty"` - RunSummary string `json:"runSummary,omitempty"` - StartTime string `json:"startTime,omitempty"` - State string `json:"state,omitempty"` - Type string `json:"type,omitempty"` + ChangeSet []interface{} `json:"changeSet,omitempty" description:"change set"` + Description interface{} `json:"description,omitempty" description:"description"` + DurationInMillis int `json:"durationInMillis,omitempty" description:"duration time in millis"` + EnQueueTime string `json:"enQueueTime,omitempty" description:"enqueue time"` + EndTime string `json:"endTime,omitempty" description:"end time"` + EstimatedDurationInMillis int `json:"estimatedDurationInMillis,omitempty" description:"estimated duration time in millis"` + ID string `json:"id,omitempty" description:"id"` + Name interface{} `json:"name,omitempty" description:"name"` + Organization string `json:"organization,omitempty" description:"organization"` + Pipeline string `json:"pipeline,omitempty" description:"pipeline"` + Replayable bool `json:"replayable,omitempty" description:"replayable or not"` + Result string `json:"result,omitempty" description:"result"` + RunSummary string `json:"runSummary,omitempty" description:"pipeline run summary"` + StartTime string `json:"startTime,omitempty" description:"start time"` + State string `json:"state,omitempty" description:"State"` + Type string `json:"type,omitempty" description:"type"` Branch struct { - IsPrimary bool `json:"isPrimary,omitempty"` - Issues []interface{} `json:"issues,omitempty"` - URL string `json:"url,omitempty"` + IsPrimary bool `json:"isPrimary,omitempty" description:"primary or not"` + Issues []interface{} `json:"issues,omitempty" description:"issues"` + URL string `json:"url,omitempty" description:"url"` } `json:"branch,omitempty"` - CommitID string `json:"commitId,omitempty"` - CommitURL interface{} `json:"commitUrl,omitempty"` - PullRequest interface{} `json:"pullRequest,omitempty"` + CommitID string `json:"commitId,omitempty" description:"commit id"` + CommitURL interface{} `json:"commitUrl,omitempty" description:"commit url"` + PullRequest interface{} `json:"pullRequest,omitempty" description:"pull request"` } // ReplayPipeline type ReplayPipe struct { - Class string `json:"_class,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."` Links struct { Parent struct { Class string `json:"_class,omitempty"` @@ -408,55 +408,55 @@ type ReplayPipe struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` } `json:"artifacts,omitempty"` - } `json:"_links,omitempty"` - Actions []interface{} `json:"actions,omitempty"` - ArtifactsZipFile interface{} `json:"artifactsZipFile,omitempty"` - CauseOfBlockage string `json:"causeOfBlockage,omitempty"` + } `json:"_links,omitempty" description:"references the reachable path to this resource"` + Actions []interface{} `json:"actions,omitempty" description:"the list of actions."` + ArtifactsZipFile interface{} `json:"artifactsZipFile,omitempty" description:"the artifacts zip file"` + CauseOfBlockage string `json:"causeOfBlockage,omitempty" description:"cause of blockage"` Causes []struct { - Class string `json:"_class,omitempty"` - ShortDescription string `json:"shortDescription,omitempty"` - UserID string `json:"userId,omitempty"` - UserName string `json:"userName,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."` + ShortDescription string `json:"shortDescription,omitempty" description:"short description"` + UserID string `json:"userId,omitempty" description:"user id"` + UserName string `json:"userName,omitempty" description:"user name"` } `json:"causes,omitempty"` - ChangeSet []interface{} `json:"changeSet,omitempty"` - Description interface{} `json:"description,omitempty"` - DurationInMillis interface{} `json:"durationInMillis,omitempty"` - EnQueueTime interface{} `json:"enQueueTime,omitempty"` - EndTime interface{} `json:"endTime,omitempty"` - EstimatedDurationInMillis interface{} `json:"estimatedDurationInMillis,omitempty"` - ID string `json:"id,omitempty"` - Name interface{} `json:"name,omitempty"` - Organization string `json:"organization,omitempty"` - Pipeline string `json:"pipeline,omitempty"` - Replayable bool `json:"replayable,omitempty"` - Result string `json:"result,omitempty"` - RunSummary interface{} `json:"runSummary,omitempty"` - StartTime interface{} `json:"startTime,omitempty"` - State string `json:"state,omitempty"` - Type string `json:"type,omitempty"` - QueueID string `json:"queueId,omitempty"` + ChangeSet []interface{} `json:"changeSet,omitempty" description:"change set"` + Description interface{} `json:"description,omitempty" description:"description"` + DurationInMillis interface{} `json:"durationInMillis,omitempty" description:"duration time in millis"` + EnQueueTime interface{} `json:"enQueueTime,omitempty" description:"enqueue time"` + EndTime interface{} `json:"endTime,omitempty" description:"end time"` + EstimatedDurationInMillis interface{} `json:"estimatedDurationInMillis,omitempty" description:"estimated duration time, unit is millis"` + ID string `json:"id,omitempty" description:"id"` + Name interface{} `json:"name,omitempty" description:"name"` + Organization string `json:"organization,omitempty" description:"organization"` + Pipeline string `json:"pipeline,omitempty" description:"pipeline"` + Replayable bool `json:"replayable,omitempty" description:"replayable or not"` + Result string `json:"result,omitempty" description:"result"` + RunSummary interface{} `json:"runSummary,omitempty" description:"pipeline run summary"` + StartTime interface{} `json:"startTime,omitempty" description:"start time"` + State string `json:"state,omitempty" description:"state"` + Type string `json:"type,omitempty" description:"type"` + QueueID string `json:"queueId,omitempty" description:"queue id"` } // GetArtifacts type Artifacts struct { - Class string `json:"_class,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."` Links struct { Self struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` } `json:"self,omitempty"` - } `json:"_links,omitempty"` - Downloadable bool `json:"downloadable,omitempty"` - ID string `json:"id,omitempty"` - Name string `json:"name,omitempty"` - Path string `json:"path,omitempty"` - Size int `json:"size,omitempty"` - URL string `json:"url,omitempty"` // The url for Download artifacts + } `json:"_links,omitempty" description:"references the reachable path to this resource"` + Downloadable bool `json:"downloadable,omitempty" description:"downloadable or not"` + ID string `json:"id,omitempty" description:"id"` + Name string `json:"name,omitempty" description:"name"` + Path string `json:"path,omitempty" description:"path"` + Size int `json:"size,omitempty" description:"size"` + URL string `json:"url,omitempty" description:"The url for Download artifacts"` } // GetPipeBranch type PipeBranch struct { - Class string `json:"_class,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."` Links struct { Self struct { Class string `json:"_class,omitempty"` @@ -482,15 +482,15 @@ type PipeBranch struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` } `json:"queue,omitempty"` - } `json:"_links,omitempty"` - Actions []interface{} `json:"actions,omitempty"` - Disabled bool `json:"disabled,omitempty"` - DisplayName string `json:"displayName,omitempty"` - EstimatedDurationInMillis int `json:"estimatedDurationInMillis,omitempty"` - FullDisplayName string `json:"fullDisplayName,omitempty"` - FullName string `json:"fullName,omitempty"` + } `json:"_links,omitempty" description:"references the reachable path to this resource"` + Actions []interface{} `json:"actions,omitempty" description:"the list of actions."` + Disabled bool `json:"disabled,omitempty" description:"disable or not"` + DisplayName string `json:"displayName,omitempty" description:"display name"` + EstimatedDurationInMillis int `json:"estimatedDurationInMillis,omitempty" description:"estimated duration time, unit is millis"` + FullDisplayName string `json:"fullDisplayName,omitempty" description:"full display name"` + FullName string `json:"fullName,omitempty" description:"full name"` LatestRun struct { - Class string `json:"_class,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."` Links struct { PrevRun struct { Class string `json:"_class,omitempty"` @@ -524,69 +524,69 @@ type PipeBranch struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` } `json:"artifacts,omitempty"` - } `json:"_links,omitempty"` - Actions []interface{} `json:"actions,omitempty"` - ArtifactsZipFile string `json:"artifactsZipFile,omitempty"` - CauseOfBlockage interface{} `json:"causeOfBlockage,omitempty"` + } `json:"_links,omitempty" description:"references the reachable path to this resource"` + Actions []interface{} `json:"actions,omitempty" description:"the list of actions"` + ArtifactsZipFile string `json:"artifactsZipFile,omitempty" description:"the artifacts zip file"` + CauseOfBlockage interface{} `json:"causeOfBlockage,omitempty" description:"cause of blockage"` Causes []struct { - Class string `json:"_class,omitempty"` - ShortDescription string `json:"shortDescription,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."` + ShortDescription string `json:"shortDescription,omitempty" description:"short description"` } `json:"causes,omitempty"` - ChangeSet []interface{} `json:"changeSet,omitempty"` - Description interface{} `json:"description,omitempty"` - DurationInMillis int `json:"durationInMillis,omitempty"` - EnQueueTime string `json:"enQueueTime,omitempty"` - EndTime string `json:"endTime,omitempty"` - EstimatedDurationInMillis int `json:"estimatedDurationInMillis,omitempty"` - ID string `json:"id,omitempty"` - Name interface{} `json:"name,omitempty"` - Organization string `json:"organization,omitempty"` - Pipeline string `json:"pipeline,omitempty"` - Replayable bool `json:"replayable,omitempty"` - Result string `json:"result,omitempty"` - RunSummary string `json:"runSummary,omitempty"` - StartTime string `json:"startTime,omitempty"` - State string `json:"state,omitempty"` - Type string `json:"type,omitempty"` + ChangeSet []interface{} `json:"changeSet,omitempty" description:"change set"` + Description interface{} `json:"description,omitempty" description:"description"` + DurationInMillis int `json:"durationInMillis,omitempty" description:"duration time in millis"` + EnQueueTime string `json:"enQueueTime,omitempty" description:"enqueue time"` + EndTime string `json:"endTime,omitempty" description:"end time"` + EstimatedDurationInMillis int `json:"estimatedDurationInMillis,omitempty" description:"estimated duration time in millis"` + ID string `json:"id,omitempty" description:"id"` + Name interface{} `json:"name,omitempty" description:"name"` + Organization string `json:"organization,omitempty" description:"organization"` + Pipeline string `json:"pipeline,omitempty" description:"pipeline"` + Replayable bool `json:"replayable,omitempty" description:"replayable or not"` + Result string `json:"result,omitempty" description:"result"` + RunSummary string `json:"runSummary,omitempty" description:"pipeline run summary"` + StartTime string `json:"startTime,omitempty" description:"start run"` + State string `json:"state,omitempty" description:"state"` + Type string `json:"type,omitempty" description:"type"` } `json:"latestRun,omitempty"` - Name string `json:"name,omitempty"` - Organization string `json:"organization,omitempty"` + Name string `json:"name,omitempty" description:"name"` + Organization string `json:"organization,omitempty" description:"organization"` Parameters []struct { - Class string `json:"_class,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."` DefaultParameterValue struct { - Class string `json:"_class,omitempty"` - Name string `json:"name,omitempty"` - Value string `json:"value,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."` + Name string `json:"name,omitempty" description:"name"` + Value string `json:"value,omitempty" description:"value"` } `json:"defaultParameterValue,omitempty"` - Description string `json:"description,omitempty"` - Name string `json:"name,omitempty"` - Type string `json:"type,omitempty"` + Description string `json:"description,omitempty" description:"description"` + Name string `json:"name,omitempty" description:"name"` + Type string `json:"type,omitempty" description:"type"` } `json:"parameters,omitempty"` Permissions struct { - Create bool `json:"create,omitempty"` - Configure bool `json:"configure,omitempty"` - Read bool `json:"read,omitempty"` - Start bool `json:"start,omitempty"` - Stop bool `json:"stop,omitempty"` + Create bool `json:"create,omitempty" description:"create action"` + Configure bool `json:"configure,omitempty" description:"configure action"` + Read bool `json:"read,omitempty" description:"read action"` + Start bool `json:"start,omitempty" description:"start action"` + Stop bool `json:"stop,omitempty" description:"stop action"` } `json:"permissions,omitempty"` - WeatherScore int `json:"weatherScore,omitempty"` + WeatherScore int `json:"weatherScore,omitempty" description:"the score to description the result of pipeline"` Branch struct { - IsPrimary bool `json:"isPrimary,omitempty"` - Issues []interface{} `json:"issues,omitempty"` - URL string `json:"url,omitempty"` + IsPrimary bool `json:"isPrimary,omitempty" description:"primary or not"` + Issues []interface{} `json:"issues,omitempty" description:"issues"` + URL string `json:"url,omitempty" description:"url"` } `json:"branch,omitempty"` } // RunPipeline type RunPayload struct { Parameters []struct { - Name string `json:"name,omitempty"` - Value string `json:"value,omitempty"` + Name string `json:"name,omitempty" description:"name"` + Value string `json:"value,omitempty" description:"value"` } `json:"parameters,omitempty"` } type QueuedBlueRun struct { - Class string `json:"_class,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."` Links struct { Parent struct { Class string `json:"_class,omitempty"` @@ -616,38 +616,38 @@ type QueuedBlueRun struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` } `json:"artifacts,omitempty"` - } `json:"_links,omitempty"` - Actions []interface{} `json:"actions,omitempty"` - ArtifactsZipFile interface{} `json:"artifactsZipFile,omitempty"` - CauseOfBlockage string `json:"causeOfBlockage,omitempty"` + } `json:"_links,omitempty" description:"references the reachable path to this resource"` + Actions []interface{} `json:"actions,omitempty" description:"the list of actions"` + ArtifactsZipFile interface{} `json:"artifactsZipFile,omitempty" description:"the artifacts zip file"` + CauseOfBlockage string `json:"causeOfBlockage,omitempty" description:"cause of blockage"` Causes []struct { - Class string `json:"_class,omitempty"` - ShortDescription string `json:"shortDescription,omitempty"` - UserID string `json:"userId,omitempty"` - UserName string `json:"userName,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."` + ShortDescription string `json:"shortDescription,omitempty" description:"short description"` + UserID string `json:"userId,omitempty" description:"user id"` + UserName string `json:"userName,omitempty" description:"user name"` } `json:"causes,omitempty"` - ChangeSet []interface{} `json:"changeSet,omitempty"` - Description interface{} `json:"description,omitempty"` - DurationInMillis interface{} `json:"durationInMillis,omitempty"` - EnQueueTime interface{} `json:"enQueueTime,omitempty"` - EndTime interface{} `json:"endTime,omitempty"` - EstimatedDurationInMillis interface{} `json:"estimatedDurationInMillis,omitempty"` - ID string `json:"id,omitempty"` - Name interface{} `json:"name,omitempty"` - Organization string `json:"organization,omitempty"` - Pipeline string `json:"pipeline,omitempty"` - Replayable bool `json:"replayable,omitempty"` - Result string `json:"result,omitempty"` - RunSummary interface{} `json:"runSummary,omitempty"` - StartTime interface{} `json:"startTime,omitempty"` - State string `json:"state,omitempty"` - Type string `json:"type,omitempty"` - QueueID string `json:"queueId,omitempty"` + ChangeSet []interface{} `json:"changeSet,omitempty" description:"change set"` + Description interface{} `json:"description,omitempty" description:"description"` + DurationInMillis interface{} `json:"durationInMillis,omitempty" description:"duration time in millis"` + EnQueueTime interface{} `json:"enQueueTime,omitempty" description:"enqueue time"` + EndTime interface{} `json:"endTime,omitempty" description:"end time"` + EstimatedDurationInMillis interface{} `json:"estimatedDurationInMillis,omitempty" description:"estimated duration time in millis"` + ID string `json:"id,omitempty" description:"id"` + Name interface{} `json:"name,omitempty" description:"name"` + Organization string `json:"organization,omitempty" description:"organization"` + Pipeline string `json:"pipeline,omitempty" description:"pipeline"` + Replayable bool `json:"replayable,omitempty" description:"replayable or not"` + Result string `json:"result,omitempty" description:"result"` + RunSummary interface{} `json:"runSummary,omitempty" description:"pipeline run summary"` + StartTime interface{} `json:"startTime,omitempty" description:"start time"` + State string `json:"state,omitempty" description:"state"` + Type string `json:"type,omitempty" description:"type"` + QueueID string `json:"queueId,omitempty" description:"queue id"` } // GetNodeStatus type NodeStatus struct { - Class string `json:"_class,omitempty"` + Class string `json:"_class,omitempty" description:""` Links struct { Self struct { Class string `json:"_class,omitempty"` @@ -661,27 +661,27 @@ type NodeStatus struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` } `json:"steps,omitempty"` - } `json:"_links,omitempty"` - Actions []interface{} `json:"actions,omitempty"` - DisplayDescription interface{} `json:"displayDescription,omitempty"` - DisplayName string `json:"displayName,omitempty"` - DurationInMillis int `json:"durationInMillis,omitempty"` - ID string `json:"id,omitempty"` - Input interface{} `json:"input,omitempty"` - Result string `json:"result,omitempty"` - StartTime string `json:"startTime,omitempty"` - State string `json:"state,omitempty"` - Type string `json:"type,omitempty"` - CauseOfBlockage interface{} `json:"causeOfBlockage,omitempty"` + } `json:"_links,omitempty" description:"references the reachable path to this resource"` + Actions []interface{} `json:"actions,omitempty" description:"the list of actions"` + DisplayDescription interface{} `json:"displayDescription,omitempty" description:"display description"` + DisplayName string `json:"displayName,omitempty" description:"display name"` + DurationInMillis int `json:"durationInMillis,omitempty" description:"duration time in millis"` + ID string `json:"id,omitempty" description:"id"` + Input interface{} `json:"input,omitempty" description:"input"` + Result string `json:"result,omitempty" description:"result"` + StartTime string `json:"startTime,omitempty" description:"start time"` + State string `json:"state,omitempty" description:"state"` + Type string `json:"type,omitempty" description:"type"` + CauseOfBlockage interface{} `json:"causeOfBlockage,omitempty" description:"cause of blockage"` Edges []struct { - Class string `json:"_class,omitempty"` - ID string `json:"id,omitempty"` - Type string `json:"type,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."` + ID string `json:"id,omitempty" description:"id"` + Type string `json:"type,omitempty" description:"type"` } `json:"edges,omitempty"` - FirstParent interface{} `json:"firstParent,omitempty"` - Restartable bool `json:"restartable,omitempty"` + FirstParent interface{} `json:"firstParent,omitempty" description:"first parent"` + Restartable bool `json:"restartable,omitempty" description:"restartable or not"` Steps []struct { - Class string `json:"_class,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."` Links struct { Self struct { Class string `json:"_class,omitempty"` @@ -691,63 +691,63 @@ type NodeStatus struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` } `json:"actions,omitempty"` - } `json:"_links,omitempty"` + } `json:"_links,omitempty" description:"references the reachable path to this resource"` Actions []struct { - Class string `json:"_class,omitempty"` + Class string `json:"_class,omitempty" description:"references the reachable path to this resource"` Links struct { Self struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` - } `json:"self,omitempty"` - } `json:"_links,omitempty"` - URLName string `json:"urlName,omitempty"` + } `json:"self,omitempty" description:""` + } `json:"_links,omitempty" description:"references the reachable path to this resource"` + URLName string `json:"urlName,omitempty" description:"url name"` } `json:"actions,omitempty"` - DisplayDescription interface{} `json:"displayDescription,omitempty"` - DisplayName string `json:"displayName,omitempty"` - DurationInMillis int `json:"durationInMillis,omitempty"` - ID string `json:"id,omitempty"` - Input interface{} `json:"input,omitempty"` - Result string `json:"result,omitempty"` - StartTime string `json:"startTime,omitempty"` - State string `json:"state,omitempty"` - Type string `json:"type,omitempty"` + DisplayDescription interface{} `json:"displayDescription,omitempty" description:"display description"` + DisplayName string `json:"displayName,omitempty" description:"display name"` + DurationInMillis int `json:"durationInMillis,omitempty" description:"duration time in millis"` + ID string `json:"id,omitempty" description:"id"` + Input interface{} `json:"input,omitempty" description:"input"` + Result string `json:"result,omitempty" description:"result"` + StartTime string `json:"startTime,omitempty" description:"start time"` + State string `json:"state,omitempty" description:"state"` + Type string `json:"type,omitempty" description:"type"` } `json:"steps,omitempty"` } // CheckPipeline type CheckPlayload struct { - ID string `json:"id,omitempty"` + ID string `json:"id,omitempty" description:"id"` Parameters []struct { - Name string `json:"name,omitempty"` - Value string `json:"value,omitempty"` + Name string `json:"name,omitempty" description:"name"` + Value string `json:"value,omitempty" description:"value"` } `json:"parameters,omitempty"` - Abort bool `json:"abort,omitempty"` + Abort bool `json:"abort,omitempty" description:"abort or not"` } // Getcrumb type Crumb struct { - Class string `json:"_class,omitempty"` - Crumb string `json:"crumb,omitempty"` - CrumbRequestField string `json:"crumbRequestField,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."` + Crumb string `json:"crumb,omitempty" description:"crumb data"` + CrumbRequestField string `json:"crumbRequestField,omitempty" description:"crumb request field"` } // CheckScriptCompile type CheckScript struct { - Column int `json:"column,omitempty"` - Line int `json:"line,omitempty"` - Message string `json:"message,omitempty"` - Status string `json:"status,omitempty"` + 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"` } // CheckCron type CheckCronRes struct { - Result string `json:"result,omitempty"` - Message string `json:"message,omitempty"` + Result string `json:"result,omitempty" description:"result"` + Message string `json:"message,omitempty" description:"message"` } // GetPipelineRun type PipelineRun struct { - Class string `json:"_class,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."` Links struct { PrevRun struct { Class string `json:"_class,omitempty"` @@ -789,41 +789,41 @@ type PipelineRun struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` } `json:"artifacts,omitempty"` - } `json:"_links,omitempty"` - Actions []interface{} `json:"actions,omitempty"` - ArtifactsZipFile interface{} `json:"artifactsZipFile,omitempty"` - CauseOfBlockage interface{} `json:"causeOfBlockage,omitempty"` + } `json:"_links,omitempty" description:"references the reachable path to this resource"` + Actions []interface{} `json:"actions,omitempty" description:"the list of actions"` + ArtifactsZipFile interface{} `json:"artifactsZipFile,omitempty" description:"the artifacts zip file"` + CauseOfBlockage interface{} `json:"causeOfBlockage,omitempty" description:"cause of blockage"` Causes []struct { - Class string `json:"_class,omitempty"` - ShortDescription string `json:"shortDescription,omitempty"` - UserID string `json:"userId,omitempty"` - UserName string `json:"userName,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."` + ShortDescription string `json:"shortDescription,omitempty" description:"short description"` + UserID string `json:"userId,omitempty" description:"user id"` + UserName string `json:"userName,omitempty" description:"user name"` } `json:"causes,omitempty"` - ChangeSet []interface{} `json:"changeSet,omitempty"` - Description interface{} `json:"description,omitempty"` - DurationInMillis int `json:"durationInMillis,omitempty"` - EnQueueTime string `json:"enQueueTime,omitempty"` - EndTime string `json:"endTime,omitempty"` - EstimatedDurationInMillis int `json:"estimatedDurationInMillis,omitempty"` - ID string `json:"id,omitempty"` - Name interface{} `json:"name,omitempty"` - Organization string `json:"organization,omitempty"` - Pipeline string `json:"pipeline,omitempty"` - Replayable bool `json:"replayable,omitempty"` - Result string `json:"result,omitempty"` - RunSummary string `json:"runSummary,omitempty"` - StartTime string `json:"startTime,omitempty"` - State string `json:"state,omitempty"` - Type string `json:"type,omitempty"` - Branch interface{} `json:"branch,omitempty"` - CommitID interface{} `json:"commitId,omitempty"` - CommitURL interface{} `json:"commitUrl,omitempty"` - PullRequest interface{} `json:"pullRequest,omitempty"` + ChangeSet []interface{} `json:"changeSet,omitempty" description:"change set"` + Description interface{} `json:"description,omitempty" description:"description"` + DurationInMillis int `json:"durationInMillis,omitempty" description:"duration time in millis"` + EnQueueTime string `json:"enQueueTime,omitempty" description:"enqueue time"` + EndTime string `json:"endTime,omitempty" description:"end time"` + EstimatedDurationInMillis int `json:"estimatedDurationInMillis,omitempty" description:"estimated duration time in millis"` + ID string `json:"id,omitempty" description:"id"` + Name interface{} `json:"name,omitempty" description:"name"` + Organization string `json:"organization,omitempty" description:"organization"` + Pipeline string `json:"pipeline,omitempty" description:"pipeline"` + Replayable bool `json:"replayable,omitempty" description:"replayable or not"` + Result string `json:"result,omitempty" description:"result"` + RunSummary string `json:"runSummary,omitempty" description:"pipeline run summary"` + StartTime string `json:"startTime,omitempty" description:"start time"` + State string `json:"state,omitempty" description:"state"` + Type string `json:"type,omitempty" description:"type"` + Branch interface{} `json:"branch,omitempty" description:"branch"` + CommitID interface{} `json:"commitId,omitempty" description:"commit id"` + CommitURL interface{} `json:"commitUrl,omitempty" description:"commit url"` + PullRequest interface{} `json:"pullRequest,omitempty" description:"pull request"` } // GetBranchPipeRun type BranchPipeline struct { - Class string `json:"_class,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."` Links struct { Self struct { Class string `json:"_class,omitempty"` @@ -849,15 +849,15 @@ type BranchPipeline struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` } `json:"queue,omitempty"` - } `json:"_links,omitempty"` - Actions []interface{} `json:"actions,omitempty"` - Disabled bool `json:"disabled,omitempty"` - DisplayName string `json:"displayName,omitempty"` - EstimatedDurationInMillis int `json:"estimatedDurationInMillis,omitempty"` - FullDisplayName string `json:"fullDisplayName,omitempty"` - FullName string `json:"fullName,omitempty"` + } `json:"_links,omitempty" description:"references the reachable path to this resource"` + Actions []interface{} `json:"actions,omitempty" description:"the list of actions"` + Disabled bool `json:"disabled,omitempty" description:"disable or not"` + DisplayName string `json:"displayName,omitempty" description:"display name"` + EstimatedDurationInMillis int `json:"estimatedDurationInMillis,omitempty" description:"estimated duration time in millis"` + FullDisplayName string `json:"fullDisplayName,omitempty" description:"full display name"` + FullName string `json:"fullName,omitempty" description:"full name"` LatestRun struct { - Class string `json:"_class,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."` Links struct { PrevRun struct { Class string `json:"_class,omitempty"` @@ -891,64 +891,64 @@ type BranchPipeline struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` } `json:"artifacts,omitempty"` - } `json:"_links,omitempty"` - Actions []interface{} `json:"actions,omitempty"` - ArtifactsZipFile string `json:"artifactsZipFile,omitempty"` - CauseOfBlockage interface{} `json:"causeOfBlockage,omitempty"` + } `json:"_links,omitempty" description:"references the reachable path to this resource"` + Actions []interface{} `json:"actions,omitempty" description:"the list of actions"` + ArtifactsZipFile string `json:"artifactsZipFile,omitempty" description:"the artifacts zip file"` + CauseOfBlockage interface{} `json:"causeOfBlockage,omitempty" description:"cause of blockage"` Causes []struct { - Class string `json:"_class,omitempty"` - ShortDescription string `json:"shortDescription,omitempty"` - UserID string `json:"userId,omitempty"` - UserName string `json:"userName,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."` + ShortDescription string `json:"shortDescription,omitempty" description:"short description"` + UserID string `json:"userId,omitempty" description:"user id"` + UserName string `json:"userName,omitempty" description:"user name"` } `json:"causes,omitempty"` - ChangeSet []interface{} `json:"changeSet,omitempty"` - Description interface{} `json:"description,omitempty"` - DurationInMillis int `json:"durationInMillis,omitempty"` - EnQueueTime string `json:"enQueueTime,omitempty"` - EndTime string `json:"endTime,omitempty"` - EstimatedDurationInMillis int `json:"estimatedDurationInMillis,omitempty"` - ID string `json:"id,omitempty"` - Name interface{} `json:"name,omitempty"` - Organization string `json:"organization,omitempty"` - Pipeline string `json:"pipeline,omitempty"` - Replayable bool `json:"replayable,omitempty"` - Result string `json:"result,omitempty"` - RunSummary string `json:"runSummary,omitempty"` - StartTime string `json:"startTime,omitempty"` - State string `json:"state,omitempty"` - Type string `json:"type,omitempty"` + ChangeSet []interface{} `json:"changeSet,omitempty" description:"change set"` + Description interface{} `json:"description,omitempty" description:"description"` + DurationInMillis int `json:"durationInMillis,omitempty" description:"duration time in millis"` + EnQueueTime string `json:"enQueueTime,omitempty" description:"enqueue time"` + EndTime string `json:"endTime,omitempty" description:"end time"` + EstimatedDurationInMillis int `json:"estimatedDurationInMillis,omitempty" description:"estimated duration time in millis"` + ID string `json:"id,omitempty" description:"id"` + Name interface{} `json:"name,omitempty" description:"name"` + Organization string `json:"organization,omitempty" description:"organization"` + Pipeline string `json:"pipeline,omitempty" description:"pipeline"` + Replayable bool `json:"replayable,omitempty" description:"Replayable or not"` + Result string `json:"result,omitempty" description:"result"` + RunSummary string `json:"runSummary,omitempty" description:"pipeline run summary"` + StartTime string `json:"startTime,omitempty" description:"start time"` + State string `json:"state,omitempty" description:"state"` + Type string `json:"type,omitempty" description:"type"` } `json:"latestRun,omitempty"` - Name string `json:"name,omitempty"` - Organization string `json:"organization,omitempty"` + Name string `json:"name,omitempty" description:"name"` + Organization string `json:"organization,omitempty" description:"organization"` Parameters []struct { - Class string `json:"_class,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."` DefaultParameterValue struct { - Class string `json:"_class,omitempty"` - Name string `json:"name,omitempty"` - Value string `json:"value,omitempty"` - } `json:"defaultParameterValue,omitempty"` - Description string `json:"description,omitempty"` - Name string `json:"name,omitempty"` - Type string `json:"type,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."` + Name string `json:"name,omitempty" description:"name"` + Value string `json:"value,omitempty" description:"value"` + } `json:"defaultParameterValue,omitempty" description:""` + Description string `json:"description,omitempty" description:"description"` + Name string `json:"name,omitempty" description:"name"` + Type string `json:"type,omitempty" description:"type"` } `json:"parameters,omitempty"` Permissions struct { - Create bool `json:"create,omitempty"` - Configure bool `json:"configure,omitempty"` - Read bool `json:"read,omitempty"` - Start bool `json:"start,omitempty"` - Stop bool `json:"stop,omitempty"` + Create bool `json:"create,omitempty" description:"create action"` + Configure bool `json:"configure,omitempty" description:"configure action"` + Read bool `json:"read,omitempty" description:"read action"` + Start bool `json:"start,omitempty" description:"start action"` + Stop bool `json:"stop,omitempty" description:"stop action"` } `json:"permissions,omitempty"` - WeatherScore int `json:"weatherScore,omitempty"` + WeatherScore int `json:"weatherScore,omitempty" description:"the score to description the result of pipeline"` Branch struct { - IsPrimary bool `json:"isPrimary,omitempty"` - Issues []interface{} `json:"issues,omitempty"` - URL string `json:"url,omitempty"` + IsPrimary bool `json:"isPrimary,omitempty" description:"primary or not"` + Issues []interface{} `json:"issues,omitempty" description:"issues"` + URL string `json:"url,omitempty" description:"url"` } `json:"branch,omitempty"` } // GetPipelineRunNodes type PipelineRunNodes struct { - Class string `json:"_class,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."` Links struct { Self struct { Class string `json:"_class,omitempty"` @@ -962,26 +962,26 @@ type PipelineRunNodes struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` } `json:"steps,omitempty"` - } `json:"_links,omitempty"` - Actions []interface{} `json:"actions,omitempty"` - DisplayDescription interface{} `json:"displayDescription,omitempty"` - DisplayName string `json:"displayName,omitempty"` - DurationInMillis int `json:"durationInMillis,omitempty"` - ID string `json:"id,omitempty"` - Input interface{} `json:"input,omitempty"` - Result string `json:"result,omitempty"` - StartTime string `json:"startTime,omitempty"` - State string `json:"state,omitempty"` - Type string `json:"type,omitempty"` - CauseOfBlockage interface{} `json:"causeOfBlockage,omitempty"` - Edges []interface{} `json:"edges,omitempty"` - FirstParent interface{} `json:"firstParent,omitempty"` - Restartable bool `json:"restartable,omitempty"` + } `json:"_links,omitempty" description:"references the reachable path to this resource"` + Actions []interface{} `json:"actions,omitempty" description:"the list of actions"` + DisplayDescription interface{} `json:"displayDescription,omitempty" description:"display description"` + DisplayName string `json:"displayName,omitempty" description:"display name"` + DurationInMillis int `json:"durationInMillis,omitempty" description:"duration time in mullis"` + ID string `json:"id,omitempty" description:"id"` + Input interface{} `json:"input,omitempty" description:"input"` + Result string `json:"result,omitempty" description:"result"` + StartTime string `json:"startTime,omitempty" description:"start time"` + State string `json:"state,omitempty" description:"state"` + Type string `json:"type,omitempty" description:"type"` + CauseOfBlockage interface{} `json:"causeOfBlockage,omitempty" description:"cause 0f blockage"` + Edges []interface{} `json:"edges,omitempty" description:"edges"` + FirstParent interface{} `json:"firstParent,omitempty" description:"first parent"` + Restartable bool `json:"restartable,omitempty" description:"restartable or not"` } // GetNodeSteps type NodeSteps struct { - Class string `json:"_class,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."` Links struct { Self struct { Class string `json:"_class,omitempty"` @@ -991,69 +991,69 @@ type NodeSteps struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` } `json:"actions,omitempty"` - } `json:"_links,omitempty"` + } `json:"_links,omitempty" description:"references the reachable path to this resource"` Actions []struct { - Class string `json:"_class,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."` Links struct { Self struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` } `json:"self,omitempty"` - } `json:"_links,omitempty"` - URLName string `json:"urlName,omitempty"` + } `json:"_links,omitempty" description:"references the reachable path to this resource"` + URLName string `json:"urlName,omitempty" description:"url name"` } `json:"actions,omitempty"` - DisplayDescription string `json:"displayDescription,omitempty"` - DisplayName string `json:"displayName,omitempty"` - DurationInMillis int `json:"durationInMillis,omitempty"` - ID string `json:"id,omitempty"` - Input interface{} `json:"input,omitempty"` - Result string `json:"result,omitempty"` - StartTime string `json:"startTime,omitempty"` - State string `json:"state,omitempty"` - Type string `json:"type,omitempty"` + DisplayDescription string `json:"displayDescription,omitempty" description:"display description"` + DisplayName string `json:"displayName,omitempty" description:"display name"` + DurationInMillis int `json:"durationInMillis,omitempty" description:"duration time in mullis"` + ID string `json:"id,omitempty" description:"id"` + Input interface{} `json:"input,omitempty" description:"input"` + Result string `json:"result,omitempty" description:"result"` + StartTime string `json:"startTime,omitempty" description:"start times"` + State string `json:"state,omitempty" description:"state"` + Type string `json:"type,omitempty" description:"type"` } // CheckScriptCompile type ReqScript struct { - Value string `json:"value,omitempty"` + Value string `json:"value,omitempty" description:"check value"` } // ToJenkinsfile requests type ReqJson struct { - Json string `json:"json,omitempty"` + Json string `json:"json,omitempty" description:"json data"` } // ToJenkinsfile response type ResJenkinsfile struct { - Status string `json:"status,omitempty"` + Status string `json:"status,omitempty" description:"status"` Data struct { - Result string `json:"result,omitempty"` - Jenkinsfile string `json:"jenkinsfile,omitempty"` + Result string `json:"result,omitempty" description:"result"` + Jenkinsfile string `json:"jenkinsfile,omitempty" description:"jenkinsfile"` Errors []struct { - Location []string `json:"location,omitempty"` - Error string `json:"error,omitempty"` + Location []string `json:"location,omitempty" description:"err location"` + Error string `json:"error,omitempty" description:"error message"` } `json:"errors,omitempty"` } `json:"data,omitempty"` } type ReqJenkinsfile struct { - Jenkinsfile string `json:"jenkinsfile,omitempty"` + Jenkinsfile string `json:"jenkinsfile,omitempty" description:"jenkinsfile"` } type ResJson struct { - Status string `json:"status,omitempty"` + Status string `json:"status,omitempty" description:"status"` Data struct { - Result string `json:"result,omitempty"` + Result string `json:"result,omitempty" description:"result"` JSON struct { Pipeline struct { - Stages []interface{} `json:"stages,omitempty"` + Stages []interface{} `json:"stages,omitempty" description:"stages"` Agent struct { - Type string `json:"type,omitempty"` + Type string `json:"type,omitempty" description:"type"` Arguments []struct { - Key string `json:"key,omitempty"` + Key string `json:"key,omitempty" description:"key"` Value struct { - IsLiteral bool `json:"isLiteral,omitempty"` - Value string `json:"value,omitempty"` + IsLiteral bool `json:"isLiteral,omitempty" description:"is literal or not"` + Value string `json:"value,omitempty" description:"value"` } `json:"value,omitempty"` } `json:"arguments,omitempty"` } `json:"agent,omitempty"` @@ -1063,7 +1063,7 @@ type ResJson struct { } type NodesDetail struct { - Class string `json:"_class,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."` Links struct { Self struct { Class string `json:"_class,omitempty"` @@ -1077,29 +1077,29 @@ type NodesDetail struct { Class string `json:"_class,omitempty"` Href string `json:"href,omitempty"` } `json:"steps,omitempty"` - } `json:"_links,omitempty"` - Actions []interface{} `json:"actions,omitempty"` - DisplayDescription interface{} `json:"displayDescription,omitempty"` - DisplayName string `json:"displayName,omitempty"` - DurationInMillis int `json:"durationInMillis,omitempty"` - ID string `json:"id,omitempty"` - Input interface{} `json:"input,omitempty"` - Result string `json:"result,omitempty"` - StartTime string `json:"startTime,omitempty"` - State string `json:"state,omitempty"` - Type string `json:"type,omitempty"` - CauseOfBlockage interface{} `json:"causeOfBlockage,omitempty"` + } `json:"_links,omitempty" description:"references the reachable path to this resource"` + Actions []interface{} `json:"actions,omitempty" description:"the list of actions"` + DisplayDescription interface{} `json:"displayDescription,omitempty" description:"display description"` + DisplayName string `json:"displayName,omitempty" description:"display name"` + DurationInMillis int `json:"durationInMillis,omitempty" description:"duration time in millis"` + ID string `json:"id,omitempty" description:"id"` + Input interface{} `json:"input,omitempty" description:"input"` + Result string `json:"result,omitempty" description:"result"` + StartTime string `json:"startTime,omitempty" description:"start time"` + State string `json:"state,omitempty" description:"statue"` + Type string `json:"type,omitempty" description:"type"` + CauseOfBlockage interface{} `json:"causeOfBlockage,omitempty" description:"cause of blockage"` Edges []struct { - Class string `json:"_class,omitempty"` - ID string `json:"id,omitempty"` - Type string `json:"type,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."` + ID string `json:"id,omitempty" description:"id"` + Type string `json:"type,omitempty" description:"type"` } `json:"edges,omitempty"` - FirstParent interface{} `json:"firstParent,omitempty"` - Restartable bool `json:"restartable,omitempty"` - Steps []NodeSteps `json:"steps,omitempty"` + FirstParent interface{} `json:"firstParent,omitempty" description:"first parent"` + Restartable bool `json:"restartable,omitempty" description:"restartable or not"` + Steps []NodeSteps `json:"steps,omitempty" description:"steps"` } type NodesStepsIndex struct { - Id int `json:"id,omitempty"` - Steps []NodeSteps `json:"steps,omitempty"` + Id int `json:"id,omitempty" description:"id"` + Steps []NodeSteps `json:"steps,omitempty" description:"steps"` }