{"info":{"title":"Screwdriver API Documentation","version":"3"},"security":[{"jwt":[]}],"openapi":"3.0.0","servers":[{"url":"https://api.screwdriver.cd/"}],"components":{"securitySchemes":{"jwt":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"type":{"type":"string","description":"Type/Severity of the banner message","example":"info","enum":["info","warn"],"maxLength":32},"scope":{"type":"string","description":"Scope of the banner","example":"GLOBAL","default":"GLOBAL","enum":["GLOBAL","PIPELINE","BUILD"],"maxLength":16},"Model1":{"type":"object","properties":{"id":{"type":"integer","x-constraint":{"sign":"positive"}},"message":{"type":"string","description":"Body of banner to display","example":"Due to planned upgrade of Kubernetes, Screwdriver will be down","maxLength":512},"isActive":{"type":"boolean","description":"Flag if the banner is active","example":true},"createTime":{"type":"string","description":"When this banner was created","example":"2017-01-06T01:49:50.384359267Z","maxLength":32,"x-format":{"isoDate":true}},"createdBy":{"type":"string","description":"Username of user creating the banner","example":"batman123","maxLength":128},"type":{"$ref":"#/components/schemas/type"},"scope":{"$ref":"#/components/schemas/scope"},"scopeId":{"type":"integer","description":"Identifier to pipelineId for PIPELINE, buildId for BUILD, or null for GLOBAL","example":1234,"x-constraint":{"sign":"positive"}}},"required":["id","message","isActive","createTime","createdBy","type","scope","scopeId"]},"List Banners":{"type":"array","items":{"$ref":"#/components/schemas/Model1"}},"scmOrganizations":{"type":"array","items":{"type":"string","description":"SCM organization name","example":"screwdriver-cd","maxLength":100}},"Get BuildCluster":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this Job","example":123345,"x-constraint":{"sign":"positive"}},"name":{"type":"string","description":"Name of the build cluster","example":"iOS","maxLength":50,"pattern":"^[\\w.-]+$"},"description":{"type":"string","description":"Description of the build cluster","example":"Build cluster for iOS team","maxLength":100},"scmContext":{"type":"string","description":"The SCM in which the repository exists","example":"github:github.com","maxLength":128,"pattern":"^([^:]+):([^:]+)$"},"scmOrganizations":{"$ref":"#/components/schemas/scmOrganizations"},"isActive":{"type":"boolean","description":"Flag if the the build cluster is active","example":true},"managedByScrewdriver":{"type":"boolean","description":"Flag if the cluster is managed by screwdriver team","example":true},"maintainer":{"type":"string","description":"Maintainer of the Command","example":"foo@bar.com","maxLength":64,"x-format":{"email":true}},"weightage":{"type":"number","description":"Weight percentage for build cluster","example":20,"minimum":0,"maximum":100},"group":{"type":"string","description":"Group of the build cluster","example":"default","default":"default"}},"required":["id","name","scmContext","scmOrganizations","isActive","managedByScrewdriver","maintainer","weightage"]},"List of build clusters":{"type":"array","items":{"$ref":"#/components/schemas/Get%20BuildCluster"}},"pipelineIds":{"type":"array","items":{"type":"integer","x-constraint":{"sign":"positive"}}},"Model2":{"type":"string","description":"Collection type","example":"default","enum":["default","normal"],"maxLength":32},"Model3":{"type":"object","properties":{"id":{"type":"integer","x-constraint":{"sign":"positive"}},"userId":{"type":"integer","description":"User ID","x-constraint":{"sign":"positive"}},"name":{"type":"string","description":"Collection name","example":"Favorites","maxLength":128},"description":{"type":"string","description":"Collection description","example":"List of my favorite pipelines","maxLength":256},"pipelineIds":{"$ref":"#/components/schemas/pipelineIds"},"type":{"$ref":"#/components/schemas/Model2"}},"required":["id","userId","name","pipelineIds"]},"List collections for requesting user":{"type":"array","items":{"$ref":"#/components/schemas/Model3"}},"SCM Repository":{"type":"object","properties":{"name":{"type":"string","example":"screwdriver-cd/screwdriver"},"branch":{"type":"string","example":"master"},"url":{"type":"string","example":"https://github.com/screwdriver-cd/screwdriver/tree/master","x-format":{"uri":true}},"private":{"type":"boolean"},"rootDir":{"type":"string","description":"Root directory (relative to checkoutUrl)","example":"src/app/component","maxLength":100}},"required":["name","branch","url"]},"admins":{"type":"object","description":"Admins of this Pipeline","example":{"myself":true}},"adminUserIds":{"type":"array","description":"IDs of the users who have admin privileges for this pipeline","example":"[12345, 6789]","items":{"type":"integer","description":"Identifier of the user","example":12345,"x-constraint":{"sign":"positive"}}},"Model4":{"type":"object","properties":{"name":{"anyOf":[{"type":"string","pattern":"^~([\\w-]+)$"},{"type":"string","maxLength":100,"pattern":"^(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"},{"type":"string"},{"type":"string","pattern":"^~?stage@([\\w-]+)(?::([\\w-]+))?$"},{"type":"string","pattern":"^~?sd@\\d+:(?:([\\w-]+)|(stage@([\\w-]+):(setup|teardown)))$"}]},"virtual":{"type":"boolean","description":"Flag to indicate if the node is a virtual job","example":true}}},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/Model4"}},"Model5":{"type":"object","properties":{"src":{"anyOf":[{"type":"string","pattern":"^~([\\w-]+)$"},{"type":"string","maxLength":100,"pattern":"^(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"},{"type":"string"},{"type":"string","pattern":"^~?stage@([\\w-]+)(?::([\\w-]+))?$"},{"type":"string","pattern":"^~?sd@\\d+:(?:([\\w-]+)|(stage@([\\w-]+):(setup|teardown)))$"}]},"dest":{"anyOf":[{"type":"string","example":"~sd@1234:component","pattern":"^~?sd@(\\d+):(([\\w-]+)|(stage@([\\w-]+):setup))$"},{"type":"string","maxLength":100,"pattern":"^(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"}]}}},"edges":{"type":"array","items":{"$ref":"#/components/schemas/Model5"}},"workflowGraph":{"type":"object","description":"Graph representation of the workflow","properties":{"nodes":{"$ref":"#/components/schemas/nodes"},"edges":{"$ref":"#/components/schemas/edges"}}},"annotations":{"type":"object","description":"Pipeline-level annotations"},"scmUrls":{"type":"array","minItems":1,"items":{"type":"string","pattern":"^(?:(?:https:\\/\\/(?:[^@/:\\s]+@)?)|git@|org-\\d+@)+([^/:\\s]+)(?:\\/|:)([^/:\\s]+)\\/([^\\s]+?)(?:\\.git)(#[^:　\\s]*　[^:　\\s]*|#[^:　\\s]+)?(:[^:　\\s]*　[^:　\\s]*|:[^:　\\s]+)?$"}},"childPipelines":{"type":"object","description":"Configuration of child pipelines","properties":{"scmUrls":{"$ref":"#/components/schemas/scmUrls"},"startAll":{"type":"boolean"}},"required":["scmUrls"]},"metricsDowntimeJobs":{"type":"array","description":"Job IDs to watch for downtime","items":{"type":"integer","description":"Identifier for this job","example":123345,"nullable":true,"x-constraint":{"sign":"positive"}}},"metricsDowntimeStatuses":{"type":"array","description":"Build statuses to watch for downtime","items":{"type":"string"}},"settings":{"type":"object","default":{},"properties":{"metricsDowntimeJobs":{"$ref":"#/components/schemas/metricsDowntimeJobs"},"metricsDowntimeStatuses":{"$ref":"#/components/schemas/metricsDowntimeStatuses"},"public":{"type":"boolean"},"groupedEvents":{"type":"boolean"},"showEventTriggers":{"type":"boolean"},"filterEventsForNoBuilds":{"type":"boolean"},"filterSchedulerEvents":{"type":"boolean"},"aliasName":{"type":"string","description":"A customizable alias for pipeline name","example":"scwdvr-cd","maxLength":32}}},"state":{"type":"string","description":"Current state of the pipeline","example":"ACTIVE","default":"ACTIVE","enum":["ACTIVE","INACTIVE","DELETING"],"maxLength":10},"actions":{"type":"array","items":{"type":"string"}},"Model6":{"type":"object","properties":{"scmUri":{"type":"string","pattern":"^([^:]+):([^:]+):([^:]+)(?::(.*))?$"},"actions":{"$ref":"#/components/schemas/actions"}}},"subscribedScmUrlsWithActions":{"type":"array","description":"List of subscribed scm urls paired with actions","items":{"$ref":"#/components/schemas/Model6"}},"sonar":{"type":"object","properties":{"defaultName":{"type":"string","description":"Auto populated dashboard name for a badge","example":"screwdriver/ui","maxLength":128},"defaultUri":{"type":"string","description":"Auto populated url for the badge application dashboard","example":"https://sonar.screwdriver.cd/dashboard?id=112233","maxLength":500},"name":{"type":"string","description":"The dashboard name for a badge","example":"my-screwdriver/ui","maxLength":128},"uri":{"type":"string","description":"The url the badge application dashboard","example":"https://my-sonar.screwdriver.cd/dashboard?id=112233","maxLength":500}}},"badges":{"type":"object","description":"A list of badges that pipline has","example":"{ sonar: { name: 'dashboard', uri: 'http://sonar.com/sample1' } }","properties":{"sonar":{"$ref":"#/components/schemas/sonar"}}},"Get Pipeline":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"name":{"type":"string","example":"screwdriver-cd/screwdriver"},"scmUri":{"type":"string","description":"Unique identifier for the application","example":"github.com:123456:master","maxLength":500,"pattern":"^([^:]+):([^:]+):([^:]+)(?::(.*))?$"},"scmContext":{"type":"string","description":"The SCM in which the repository exists","example":"github:github.com","maxLength":128,"pattern":"^([^:]+):([^:]+)$"},"scmRepo":{"$ref":"#/components/schemas/SCM%20Repository"},"createTime":{"type":"string","description":"When this pipeline was created","x-format":{"isoDate":true}},"admins":{"$ref":"#/components/schemas/admins"},"adminUserIds":{"$ref":"#/components/schemas/adminUserIds"},"workflowGraph":{"$ref":"#/components/schemas/workflowGraph"},"annotations":{"$ref":"#/components/schemas/annotations"},"lastEventId":{"type":"integer","description":"Identifier of last event","example":123345,"x-constraint":{"sign":"positive"}},"configPipelineId":{"type":"integer","description":"Identifier of pipeline containing external configuration","example":123,"x-constraint":{"sign":"positive"}},"childPipelines":{"$ref":"#/components/schemas/childPipelines"},"prChain":{"type":"boolean","description":"Configuration of chainPR","default":false},"parameters":{"type":"object","default":{},"properties":{"any":{"anyOf":[{"type":"string"},{"$ref":"#/x-alt-definitions/any"},{"$ref":"#/x-alt-definitions/Model3"}]}}},"settings":{"$ref":"#/components/schemas/settings"},"state":{"$ref":"#/components/schemas/state"},"subscribedScmUrlsWithActions":{"$ref":"#/components/schemas/subscribedScmUrlsWithActions"},"badges":{"$ref":"#/components/schemas/badges"},"templateVersionId":{"type":"integer","description":"Identifier for this pipeline's template","example":123345,"nullable":true,"x-constraint":{"sign":"positive"}}},"required":["id","scmUri","scmContext","createTime","admins","state"]},"List of Pipelines":{"type":"array","items":{"$ref":"#/components/schemas/Get%20Pipeline"}},"Requests Object":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of requests","example":100},"timeouts":{"type":"integer","description":"Number of timeouts","example":0},"success":{"type":"integer","description":"Number of successes","example":95},"failure":{"type":"integer","description":"Number of failures","example":"5"},"concurrent":{"type":"integer","description":"Number of concurrent requests","example":0},"averageTime":{"type":"number","example":5.3134}}},"Breaker Object":{"type":"object","properties":{"isClosed":{"type":"boolean"}}},"Executor Object":{"type":"object","properties":{"requests":{"$ref":"#/components/schemas/Requests%20Object"},"breaker":{"$ref":"#/components/schemas/Breaker%20Object"}}},"Stats Object":{"type":"object","properties":{"executor":{"$ref":"#/components/schemas/Executor%20Object"},"scm":{"type":"object","properties":{"string":{"$ref":"#/components/schemas/Executor%20Object"}}}}},"Get tokens":{"type":"object","properties":{"id":{"type":"integer","x-constraint":{"sign":"positive"}},"name":{"type":"string","description":"Token name","example":"Mobile token","maxLength":128},"description":{"type":"string","description":"Token description","example":"Used to authenticate the mobile app","maxLength":256},"lastUsed":{"type":"string","description":"Last used","x-format":{"isoDate":true}}},"required":["id","name","lastUsed"]},"Model7":{"type":"array","items":{"$ref":"#/components/schemas/Get%20tokens"}},"List of package versions":{"type":"array","items":{"type":"string","description":"Package and its version"}},"License Object":{"type":"object","properties":{"name":{"type":"string"},"repository":{"type":"string"},"licenses":{"type":"string"}}},"List of Licenses":{"type":"array","items":{"$ref":"#/components/schemas/License%20Object"}},"Versions Object":{"type":"object","properties":{"versions":{"$ref":"#/components/schemas/List%20of%20package%20versions"},"licenses":{"$ref":"#/components/schemas/List%20of%20Licenses"}}},"Context Object":{"type":"object","properties":{"context":{"type":"string"},"displayName":{"type":"string"},"autoDeployKeyGeneration":{"type":"boolean"},"readOnly":{"type":"boolean"}}},"Array of Contexts":{"type":"array","items":{"$ref":"#/components/schemas/Context%20Object"}},"Crumb to prevent CSRF Object":{"type":"object","properties":{"crumb":{"type":"string"}}},"Public Key for Verifying JWTs Object":{"type":"object","properties":{"key":{"type":"string"}}},"Get Banner":{"type":"object","properties":{"id":{"type":"integer","x-constraint":{"sign":"positive"}},"message":{"type":"string","description":"Body of banner to display","example":"Due to planned upgrade of Kubernetes, Screwdriver will be down","maxLength":512},"isActive":{"type":"boolean","description":"Flag if the banner is active","example":true},"createTime":{"type":"string","description":"When this banner was created","example":"2017-01-06T01:49:50.384359267Z","maxLength":32,"x-format":{"isoDate":true}},"createdBy":{"type":"string","description":"Username of user creating the banner","example":"batman123","maxLength":128},"type":{"$ref":"#/components/schemas/type"},"scope":{"$ref":"#/components/schemas/scope"},"scopeId":{"type":"integer","description":"Identifier to pipelineId for PIPELINE, buildId for BUILD, or null for GLOBAL","example":1234,"x-constraint":{"sign":"positive"}}},"required":["id","message","isActive","createTime","createdBy","type","scope","scopeId"]},"Model8":{"type":"array","items":{"type":"string"}},"string":{"type":"object","properties":{"eventId":{"anyOf":[{"type":"integer","x-constraint":{"sign":"positive"}},{"type":"string","nullable":true}]},"jobs":{"type":"object","properties":{"string":{"anyOf":[{"type":"integer","x-constraint":{"sign":"positive"}},{"type":"string","nullable":true}]}}}}},"parameters":{"type":"object","description":"Input parameters that defined this build"},"meta":{"type":"object","description":"Key=>Value information from the build itself","default":{}},"status":{"type":"string","description":"Current status of the build","example":"SUCCESS","enum":["ABORTED","CREATED","FAILURE","QUEUED","RUNNING","SUCCESS","BLOCKED","UNSTABLE","COLLAPSED","FROZEN"]},"statusMessageType":{"type":"string","description":"Severity of the status message","example":"WARN","enum":["ERROR","WARN","INFO"],"maxLength":10},"stats":{"type":"object","description":"Stats for this build","properties":{"queueEnterTime":{"type":"string","description":"When this build enters queue","x-format":{"isoDate":true}},"blockedStartTime":{"type":"string","description":"When this build is blocked","x-format":{"isoDate":true}},"imagePullStartTime":{"type":"string","description":"When this build starts pulling image","x-format":{"isoDate":true}},"hostname":{"type":"string","description":"Where this build is run"}}},"Get Step metadata":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this Step","example":123345,"x-constraint":{"sign":"positive"}},"buildId":{"type":"integer","description":"Identifier of the parent Build","example":123345,"x-constraint":{"sign":"positive"}},"name":{"type":"string","description":"Name of the Step","example":"install","maxLength":64},"command":{"type":"string","description":"Command of the Step to execute","example":"npm install"},"code":{"type":"integer","description":"Exit code","example":1},"startTime":{"type":"string","description":"When this Step started","example":"2017-01-06T01:49:50.384359267Z","x-format":{"isoDate":true}},"endTime":{"type":"string","description":"When this Step stopped running","example":"2017-01-06T01:49:51.676057192Z","x-format":{"isoDate":true}},"lines":{"type":"integer","description":"Number of Step log lines","example":100}},"required":["name"]},"steps":{"type":"array","description":"List of steps","items":{"$ref":"#/components/schemas/Get%20Step%20metadata"}},"Get Build":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this build","example":123345,"x-constraint":{"sign":"positive"}},"environment":{"anyOf":[{"$ref":"#/x-alt-definitions/environment"},{"type":"object","properties":{"string":{"type":"string"}}}]},"eventId":{"type":"integer","description":"Identifier of the parent event","example":123345,"x-constraint":{"sign":"positive"}},"jobId":{"type":"integer","description":"Identifier of the parent job","example":123345,"x-constraint":{"sign":"positive"}},"parentBuildId":{"description":"Identifier(s) of this parent build","anyOf":[{"$ref":"#/x-alt-definitions/parentBuildId"},{"type":"integer","x-constraint":{"sign":"positive"}}]},"parentBuilds":{"type":"object","example":{"111":{"eventId":2,"jobs":{"jobA":333,"jobB":null}},"222":{"eventId":3,"jobs":{"jobC":555}}},"properties":{"string":{"$ref":"#/components/schemas/string"}}},"number":{"type":"number","description":"Timestamp of create time","example":1473900790309,"x-constraint":{"sign":"positive"}},"container":{"type":"string","description":"Container this build is running in","example":"node:4"},"cause":{"type":"string","description":"Reason why this build started","example":"pull request opened"},"sha":{"type":"string","description":"SHA this project was built on","example":"ccc49349d3cffbd12ea9e3d41521480b4aa5de5f","x-format":{"hex":{"byteAligned":false,"prefix":false}}},"subscribedConfigSha":{"type":"string","description":"SHA this project was built on","example":"ccc49349d3cffbd12ea9e3d41521480b4aa5de5f","x-format":{"hex":{"byteAligned":false,"prefix":false}}},"createTime":{"type":"string","description":"When this build was created","maxLength":32,"x-format":{"isoDate":true}},"startTime":{"type":"string","description":"When this build started on a build machine","x-format":{"isoDate":true}},"endTime":{"type":"string","description":"When this build stopped running","x-format":{"isoDate":true}},"parameters":{"$ref":"#/components/schemas/parameters"},"meta":{"$ref":"#/components/schemas/meta"},"status":{"$ref":"#/components/schemas/status"},"statusMessage":{"type":"string","description":"Status message to describe status of the build","example":"Build failed due to infrastructure error"},"statusMessageType":{"$ref":"#/components/schemas/statusMessageType"},"stats":{"$ref":"#/components/schemas/stats"},"templateId":{"type":"integer","description":"Identifier for this job's template","example":123345,"x-constraint":{"sign":"positive"}},"buildClusterName":{"type":"string","description":"Name of the build cluster","example":"iOS","maxLength":50,"pattern":"^[\\w.-]+$"},"steps":{"$ref":"#/components/schemas/steps"}},"required":["id","jobId","number","cause","createTime","status"]},"Model9":{"type":"string","description":"Collection type","example":"default","enum":["default","normal","shared"],"maxLength":32},"pipelines":{"type":"array","items":{"$ref":"#/components/schemas/Get%20Pipeline"}},"Get collection":{"type":"object","properties":{"id":{"type":"integer","x-constraint":{"sign":"positive"}},"userId":{"type":"integer","description":"User ID","x-constraint":{"sign":"positive"}},"name":{"type":"string","description":"Collection name","example":"Favorites","maxLength":128},"description":{"type":"string","description":"Collection description","example":"List of my favorite pipelines","maxLength":256},"pipelineIds":{"$ref":"#/components/schemas/pipelineIds"},"type":{"$ref":"#/components/schemas/Model9"},"pipelines":{"$ref":"#/components/schemas/pipelines"}},"required":["id","name","pipelineIds","pipelines"]},"Author of the commit":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string","example":"https://github.com/stjohnjohnson","x-format":{"uri":true}},"name":{"type":"string","example":"Dao Lam"},"username":{"type":"string","example":"d2lam"},"avatar":{"type":"string","example":"https://avatars.githubusercontent.com/u/622065?v=3","x-format":{"uri":true}}},"required":["name","username"]},"Committer of the commit":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string","example":"https://github.com/stjohnjohnson","x-format":{"uri":true}},"name":{"type":"string","example":"Dao Lam"},"username":{"type":"string","example":"d2lam"},"avatar":{"type":"string","example":"https://avatars.githubusercontent.com/u/622065?v=3","x-format":{"uri":true}}},"required":["name","username"]},"SCM Commit":{"type":"object","description":"Commit related to the event","properties":{"message":{"type":"string","example":"Fixing a bug with signing"},"author":{"$ref":"#/components/schemas/Author%20of%20the%20commit"},"committer":{"$ref":"#/components/schemas/Committer%20of%20the%20commit"},"url":{"type":"string","example":"https://github.com/screwdriver-cd/screwdriver/commit/8843d7f92416211de","x-format":{"uri":true}}},"required":["message","author","url"]},"SCM User":{"type":"object","description":"Creator of the event","properties":{"id":{"type":"string"},"url":{"type":"string","example":"https://github.com/stjohnjohnson","x-format":{"uri":true}},"name":{"type":"string","example":"Dao Lam"},"username":{"type":"string","example":"d2lam"},"avatar":{"type":"string","example":"https://avatars.githubusercontent.com/u/622065?v=3","x-format":{"uri":true}}},"required":["name","username"]},"Model10":{"type":"object","description":"Key=>Value information from the event itself","example":{"parameters":{"nameA":"value1","jobA":{"nameB":"value2"}}},"default":{}},"Model11":{"type":"string","description":"Type of the event","example":"pr","enum":["pr","pipeline"],"maxLength":10},"Model12":{"type":"object","description":"Graph representation of the workflow","example":{"nodes":[{"name":"~commit"},{"name":"main","id":12345678},{"name":"publish","id":23456789}],"edges":[{"src":"~commit","dest":"main"},{"src":"main","dest":"publish"}]},"properties":{"nodes":{"$ref":"#/components/schemas/nodes"},"edges":{"$ref":"#/components/schemas/edges"}}},"SCM Pull Request":{"type":"object","description":"Pull request object that holds information about the pull request","properties":{"url":{"type":"string","example":"https://github.com/screwdriver-cd/screwdriver/pull/1","x-format":{"uri":true}},"title":{"type":"string","maxLength":512},"ref":{"type":"string"},"prSource":{"type":"string"},"prBranchName":{"type":"string"},"createTime":{"type":"string","format":"date-time","example":"2018-10-10T21:35:31Z"},"username":{"type":"string","example":"d2lam"},"userProfile":{"type":"string","example":"https://github.com/anonymous","x-format":{"uri":true}},"baseBranch":{"type":"string","example":"master"}}},"Model13":{"type":"string","description":"Current status of the event","example":"SUCCESS","default":"UNKNOWN","enum":["UNKNOWN","ABORTED","CREATED","FAILURE","IN_PROGRESS","SUCCESS"],"maxLength":15},"Get Event":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this event","example":123345,"x-constraint":{"sign":"positive"}},"parentEventId":{"type":"integer","description":"Identifier of the direct parent event","example":123344,"x-constraint":{"sign":"positive"}},"groupEventId":{"type":"integer","description":"Identifier of the group parent event","example":123344,"x-constraint":{"sign":"positive"}},"causeMessage":{"type":"string","description":"Message that describes why the event was created","example":"Merge pull request #26 from screwdriver-cd/data-schema","maxLength":512},"commit":{"$ref":"#/components/schemas/SCM%20Commit"},"createTime":{"type":"string","description":"When this event was created","example":"2038-01-19T03:14:08.131Z","maxLength":32,"x-format":{"isoDate":true}},"creator":{"$ref":"#/components/schemas/SCM%20User"},"meta":{"$ref":"#/components/schemas/Model10"},"pipelineId":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"sha":{"type":"string","description":"SHA this project was built on","example":"ccc49349d3cffbd12ea9e3d41521480b4aa5de5f","x-constraint":{"length":40},"x-format":{"hex":{"byteAligned":false,"prefix":false}}},"configPipelineSha":{"type":"string","description":"SHA of the configuration pipeline this project depends on","example":"ccc49349d3cffbd12ea9e3d41521480b4aa5de5f","x-constraint":{"length":40},"x-format":{"hex":{"byteAligned":false,"prefix":false}}},"startFrom":{"description":"Event start point - a job name or trigger name (~commit/~pr)","example":"~commit","anyOf":[{"type":"string"},{"type":"string","description":"Name of the Job","example":"main","maxLength":110,"pattern":"^(PR-[0-9]+:)?(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"},{"type":"string","pattern":"^(?:PR-\\d+:)?stage@([\\w-]+)$"}]},"type":{"$ref":"#/components/schemas/Model11"},"workflowGraph":{"$ref":"#/components/schemas/Model12"},"pr":{"$ref":"#/components/schemas/SCM%20Pull%20Request"},"prNum":{"type":"integer","description":"Pull request number if it is a PR event","x-constraint":{"sign":"positive"}},"baseBranch":{"type":"string","description":"build base branch","example":"develop"},"status":{"$ref":"#/components/schemas/Model13"}},"required":["id","commit","createTime","creator","pipelineId","sha","type","status"]},"Model14":{"type":"object"},"event":{"type":"array","items":{"type":"string","x-format":{"uri":{"relativeOnly":true}}}},"pipeline":{"type":"array","items":{"type":"string","x-format":{"uri":{"relativeOnly":true}}}},"job":{"type":"array","items":{"type":"string","x-format":{"uri":{"relativeOnly":true}}}},"cache":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/event"},"pipeline":{"$ref":"#/components/schemas/pipeline"},"job":{"$ref":"#/components/schemas/job"}}},"Named command to execute":{"type":"object","properties":{"name":{"type":"string"},"command":{"type":"string"},"locked":{"type":"boolean"}}},"List of named commands to execute":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Named%20command%20to%20execute"}},"order":{"type":"array","minItems":0,"items":{"type":"string","pattern":"^[\\w-]+$"}},"secrets":{"type":"array","minItems":0,"items":{"type":"string","maxLength":64,"pattern":"^[A-Z_][A-Z0-9_]*$"}},"Model15":{"type":"object"},"stage":{"type":"object","properties":{"name":{"type":"string","pattern":"^[\\w-]+$"}},"required":["name"]},"Model16":{"type":"array","items":{"type":"string","pattern":"^~([\\w-]+)$"}},"Model17":{"type":"array","items":{"type":"object","properties":{"string":{"$ref":"#/components/schemas/Model16"}}}},"subscribe":{"type":"object","properties":{"scmUrls":{"$ref":"#/components/schemas/Model17"}}},"Job permutation":{"type":"object","properties":{"annotations":{"$ref":"#/components/schemas/Model14"},"blockedBy":{"anyOf":[{"$ref":"#/x-alt-definitions/blockedBy"},{"anyOf":[{"type":"string","pattern":"^~([\\w-]+)$"},{"type":"string","pattern":"^~sd@(\\d+):(?:([\\w-]+)|(stage@([\\w-]+):setup))$"}]}]},"cache":{"$ref":"#/components/schemas/cache"},"commands":{"$ref":"#/components/schemas/List%20of%20named%20commands%20to%20execute"},"description":{"type":"string","maxLength":100},"environment":{"type":"object","properties":{"string":{"type":"string"}}},"freezeWindows":{"anyOf":[{"$ref":"#/x-alt-definitions/freezeWindows"},{"type":"string"}]},"image":{"type":"string","pattern":"^[^;&|><*?`$()!#'\" ]+$"},"order":{"$ref":"#/components/schemas/order"},"parameters":{"type":"object","properties":{"any":{"anyOf":[{"type":"string"},{"$ref":"#/x-alt-definitions/any"},{"$ref":"#/x-alt-definitions/Model3"}]}}},"provider":{"anyOf":[{"$ref":"#/x-alt-definitions/provider"},{"type":"string","pattern":"^(?:(?:https:\\/\\/(?:[^@/:\\s]+@)?)|git@|org-\\d+@)+([^/:\\s]+)(?:\\/|:)([^/:\\s]+)\\/([^\\s]+?)(?:\\.git)(#[^:　\\s]*　[^:　\\s]*|#[^:　\\s]+)?(:[^:　\\s]*　[^:　\\s]*|:[^:　\\s]+)?$"}]},"requires":{"anyOf":[{"$ref":"#/x-alt-definitions/requires"},{"anyOf":[{"type":"string","pattern":"^~([\\w-]+)$"},{"type":"string","maxLength":100,"pattern":"^(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"},{"type":"string"},{"type":"string","pattern":"^~?stage@([\\w-]+)(?::([\\w-]+))?$"},{"type":"string","pattern":"^~?sd@\\d+:(?:([\\w-]+)|(stage@([\\w-]+):(setup|teardown)))$"}]}]},"secrets":{"$ref":"#/components/schemas/secrets"},"settings":{"$ref":"#/components/schemas/Model15"},"sourcePaths":{"anyOf":[{"$ref":"#/x-alt-definitions/sourcePaths"},{"type":"string","maxLength":1024}]},"stage":{"$ref":"#/components/schemas/stage"},"subscribe":{"$ref":"#/components/schemas/subscribe"},"templateId":{"type":"integer","description":"Identifier for this job's template","example":123345,"nullable":true,"x-constraint":{"sign":"positive"}}}},"List of job permutations":{"type":"array","items":{"$ref":"#/components/schemas/Job%20permutation"}},"Model18":{"type":"string","description":"Current state of the Job","example":"ENABLED","default":"ENABLED","enum":["ENABLED","DISABLED"],"maxLength":10},"Get Job":{"type":"object","properties":{"title":{"type":"string","maxLength":512},"createTime":{"type":"string","format":"date-time","example":"2018-10-10T21:35:31Z"},"username":{"type":"string","example":"d2lam"},"userProfile":{"type":"string","example":"https://github.com/anonymous","x-format":{"uri":true}},"url":{"type":"string","example":"https://github.com/screwdriver-cd/screwdriver/pull/1","x-format":{"uri":true}},"id":{"type":"integer","description":"Identifier of this Job","example":123345,"x-constraint":{"sign":"positive"}},"name":{"type":"string","description":"Name of the Job","example":"main","maxLength":110,"pattern":"^(PR-[0-9]+:)?(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"},"prParentJobId":{"type":"integer","description":"Identifier of the parent job for this pr job","example":98765,"x-constraint":{"sign":"positive"}},"permutations":{"$ref":"#/components/schemas/List%20of%20job%20permutations"},"description":{"type":"string","description":"Description of the Job","example":"builds and tests the code","maxLength":100},"pipelineId":{"type":"integer","description":"Identifier of this Pipeline","example":123345,"x-constraint":{"sign":"positive"}},"state":{"$ref":"#/components/schemas/Model18"},"stateChanger":{"type":"string","description":"Username for who changed the state","maxLength":128},"stateChangeTime":{"type":"string","description":"When the state of the job was changed","x-format":{"isoDate":true}},"stateChangeMessage":{"type":"string","description":"Reason why disabling or enabling job","example":"Testing out new feature change in beta only","maxLength":512},"archived":{"type":"boolean","description":"Flag if the job is archived","example":true,"default":false},"templateId":{"type":"integer","description":"Identifier for this job's template","example":123345,"x-constraint":{"sign":"positive"}},"sha":{"type":"string","description":"SHA this job was built on","example":"ccc49349d3cffbd12ea9e3d41521480b4aa5de5f","x-constraint":{"length":40},"x-format":{"hex":{"byteAligned":false,"prefix":false}}}},"required":["id","name","pipelineId","state"]},"Get Secret":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this secret","example":123345,"x-constraint":{"sign":"positive"}},"pipelineId":{"type":"integer","description":"pipeline associated with the secret","example":123345,"x-constraint":{"sign":"positive"}},"name":{"type":"string","description":"Name of the secret","example":"NPM_TOKEN","maxLength":64,"pattern":"^[A-Z_][A-Z0-9_]*$"},"value":{"type":"string","description":"value of the secret","example":"2d991790bab1ac8576097ca87f170df73410b55c"},"allowInPR":{"type":"boolean","description":"flag to denote if the secret can be shown in PR builds"}},"required":["id","pipelineId","name","allowInPR"]},"jobIds":{"type":"array","description":"Job IDs in this Stage","minItems":1,"items":{"type":"integer","description":"Identifier for this job","example":123345,"x-constraint":{"sign":"positive"}}},"Get Stage metadata":{"type":"object","properties":{"id":{"type":"integer","example":12345,"x-constraint":{"sign":"positive"}},"pipelineId":{"type":"integer","description":"Pipeline associated with the Stage","example":123345,"x-constraint":{"sign":"positive"}},"name":{"type":"string","description":"Name of the Stage","example":"deploy","maxLength":110,"pattern":"^[\\w-]+$"},"setup":{"type":"integer","description":"Job ID for Stage setup","example":123345,"x-constraint":{"sign":"positive"}},"teardown":{"type":"integer","description":"Job ID for Stage teardown","example":123345,"x-constraint":{"sign":"positive"}},"jobIds":{"$ref":"#/components/schemas/jobIds"},"description":{"type":"string","description":"Description of the Stage","example":"Deploys canary jobs","maxLength":256},"archived":{"type":"boolean","description":"Flag if the stage is archived","example":true,"default":false}},"required":["id","pipelineId","name","jobIds"]},"labels":{"type":"array","description":"Labels for template","example":["stable","latest","beta"],"items":{"type":"string"}},"Model19":{"type":"array","items":{"type":"string"}},"Model20":{"type":"array","minItems":1,"items":{"anyOf":[{"type":"string"},{"type":"object","properties":{"string":{"anyOf":[{"type":"string"},{"$ref":"#/x-alt-definitions/Model6"}]}}}]}},"config":{"type":"object","default":{},"properties":{"annotations":{"$ref":"#/components/schemas/Model14"},"blockedBy":{"anyOf":[{"$ref":"#/x-alt-definitions/blockedBy"},{"anyOf":[{"type":"string","pattern":"^~([\\w-]+)$"},{"type":"string","pattern":"^~sd@(\\d+):(?:([\\w-]+)|(stage@([\\w-]+):setup))$"}]}]},"cache":{"type":"boolean"},"description":{"type":"string","maxLength":100},"environment":{"type":"object","properties":{"string":{"type":"string"}}},"freezeWindows":{"anyOf":[{"$ref":"#/x-alt-definitions/freezeWindows"},{"type":"string"}]},"image":{"type":"string","pattern":"^[^;&|><*?`$()!#'\" ]+$"},"matrix":{"type":"object","properties":{"string":{"$ref":"#/components/schemas/Model19"}}},"order":{"$ref":"#/components/schemas/order"},"parameters":{"type":"object","properties":{"any":{"anyOf":[{"type":"string"},{"$ref":"#/x-alt-definitions/any"},{"$ref":"#/x-alt-definitions/Model3"}]}}},"provider":{"anyOf":[{"$ref":"#/x-alt-definitions/provider"},{"type":"string","pattern":"^(?:(?:https:\\/\\/(?:[^@/:\\s]+@)?)|git@|org-\\d+@)+([^/:\\s]+)(?:\\/|:)([^/:\\s]+)\\/([^\\s]+?)(?:\\.git)(#[^:　\\s]*　[^:　\\s]*|#[^:　\\s]+)?(:[^:　\\s]*　[^:　\\s]*|:[^:　\\s]+)?$"}]},"requires":{"anyOf":[{"$ref":"#/x-alt-definitions/requires"},{"anyOf":[{"type":"string","pattern":"^~([\\w-]+)$"},{"type":"string","maxLength":100,"pattern":"^(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"},{"type":"string"},{"type":"string","pattern":"^~?stage@([\\w-]+)(?::([\\w-]+))?$"},{"type":"string","pattern":"^~?sd@\\d+:(?:([\\w-]+)|(stage@([\\w-]+):(setup|teardown)))$"}]}]},"secrets":{"$ref":"#/components/schemas/secrets"},"settings":{"$ref":"#/components/schemas/Model15"},"sourcePaths":{"anyOf":[{"$ref":"#/x-alt-definitions/sourcePaths"},{"type":"string","maxLength":1024}]},"template":{"type":"string","pattern":"^([\\w/-]+)(?:@((?:(?:\\d+)(?:\\.\\d+)?(?:\\.\\d+)?)|(?:[a-zA-Z][\\w-.]+)))?$"},"templateId":{"type":"integer","description":"Identifier for this job's template","example":123345,"nullable":true,"x-constraint":{"sign":"positive"}},"steps":{"$ref":"#/components/schemas/Model20"}}},"clouds":{"type":"array","description":"A list of cloud that template supports","example":["aws","gcp","azure"],"items":{"type":"string"}},"architectures":{"type":"array","description":"A list of architectures that template supports","example":["x86","x86_64","arm64"],"items":{"type":"string"}},"compatibilities":{"type":"object","properties":{"clouds":{"$ref":"#/components/schemas/clouds"},"architectures":{"$ref":"#/components/schemas/architectures"}}},"Get Template":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this template","example":123345,"x-constraint":{"sign":"positive"}},"labels":{"$ref":"#/components/schemas/labels"},"config":{"$ref":"#/components/schemas/config"},"name":{"type":"string","description":"Template name","example":"nodejs/lib","maxLength":64},"version":{"type":"string","description":"Version of the Template","example":"1.2","maxLength":16,"pattern":"^(\\d+)(\\.\\d+)?(\\.\\d+)?$"},"description":{"type":"string","description":"Description of the Template","example":"Installs npm modules","maxLength":256},"maintainer":{"type":"string","description":"Maintainer of the Template","example":"foo@bar.com","maxLength":64,"x-format":{"email":true}},"pipelineId":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"namespace":{"type":"string","description":"Namespace of the Template","example":"node","maxLength":64,"pattern":"^[\\w-]+$"},"images":{"type":"object","properties":{"string":{"type":"string","pattern":"^[^;&|><*?`$()!#'\" ]+$"}}},"createTime":{"type":"string","description":"When this template was created","example":"2038-01-19T03:14:08.131Z","maxLength":32,"x-format":{"isoDate":true}},"trusted":{"type":"boolean","description":"Mark whether template is trusted"},"latest":{"type":"boolean","description":"Whether this is latest version"},"compatibilities":{"$ref":"#/components/schemas/compatibilities"}},"required":["id","labels","name","version","description","maintainer","pipelineId"]},"List of templates":{"type":"array","items":{"$ref":"#/components/schemas/Get%20Template"}},"Model21":{"type":"object","properties":{"showPRJobs":{"type":"boolean"}}},"JSON Web Token Object":{"type":"object","properties":{"token":{"type":"string"}}},"List of secrets":{"type":"array","items":{"$ref":"#/components/schemas/Get%20Secret"}},"List of steps":{"type":"array","items":{"$ref":"#/components/schemas/Get%20Step%20metadata"}},"Model22":{"type":"object"},"Model23":{"type":"array","items":{"$ref":"#/components/schemas/Model22"}},"format":{"type":"string","description":"Format of the Command","example":"habitat","enum":["habitat","docker","binary"],"maxLength":16},"mode":{"type":"string","description":"Mode of the Habitat command","example":"remote","enum":["remote","local"]},"habitat":{"type":"object","properties":{"mode":{"$ref":"#/components/schemas/mode"},"file":{"type":"string","description":"File path of the Habitat artifact","example":"./foobar.hart"},"package":{"type":"string","description":"Package of the Habitat command","example":"core/git/2.14.1"},"command":{"type":"string","description":"Executable of the Habitat command","example":"git"}},"required":["mode","file","package","command"]},"docker":{"type":"object","properties":{"image":{"type":"string","description":"Image of the Docker command","example":"chefdk:1.2.3"},"command":{"type":"string","description":"Executable of the Docker command","example":"knife","default":""}},"required":["image"]},"binary":{"type":"object","properties":{"file":{"type":"string","description":"File of the Binary command","example":"./foobar.sh"}},"required":["file"]},"Get Command":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this command","example":123345,"x-constraint":{"sign":"positive"}},"namespace":{"type":"string","description":"Namespace of the Command","example":"chefdk","maxLength":64,"pattern":"^[\\w-]+$"},"version":{"type":"string","description":"Version of the Command","example":"1.2","maxLength":16,"pattern":"^(\\d+)(\\.\\d+)?(\\.\\d+)?$"},"description":{"type":"string","description":"Description of the Command","example":"Installs npm modules","maxLength":256},"maintainer":{"type":"string","description":"Maintainer of the Command","example":"foo@bar.com","maxLength":64,"x-format":{"email":true}},"format":{"$ref":"#/components/schemas/format"},"habitat":{"$ref":"#/components/schemas/habitat"},"docker":{"$ref":"#/components/schemas/docker"},"binary":{"$ref":"#/components/schemas/binary"},"name":{"type":"string","description":"Name of the Command","example":"knife","maxLength":64,"pattern":"^[\\w-]+$"},"pipelineId":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"createTime":{"type":"string","description":"When this command was created","example":"2038-01-19T03:14:08.131Z","maxLength":32,"x-format":{"isoDate":true}},"usage":{"type":"string","description":"Usage and arguments of the command","example":"sd_cmd exec foo/bar@1 -h <host> -d <domain>","maxLength":4096},"trusted":{"type":"boolean","description":"Mark whether command is trusted"},"latest":{"type":"boolean","description":"Whether this is latest version"},"compatibilities":{"$ref":"#/components/schemas/compatibilities"}},"required":["id","namespace","version","description","maintainer","format","name","pipelineId"]},"List of commands":{"type":"array","items":{"$ref":"#/components/schemas/Get%20Command"}},"Get Stage Build metadata":{"type":"object","properties":{"id":{"type":"integer","example":12345,"x-constraint":{"sign":"positive"}},"stageId":{"type":"integer","description":"Stage associated with the Stage build","example":123345,"x-constraint":{"sign":"positive"}},"eventId":{"type":"integer","description":"Identifier of the event","example":123345,"x-constraint":{"sign":"positive"}},"status":{"$ref":"#/components/schemas/status"}},"required":["id","stageId","eventId"]},"List of stage builds":{"type":"array","items":{"$ref":"#/components/schemas/Get%20Stage%20Build%20metadata"}},"List of builds":{"type":"array","items":{"$ref":"#/components/schemas/Get%20Build"}},"Model24":{"type":"array","items":{"$ref":"#/components/schemas/Model22"}},"Model25":{"type":"array","items":{"$ref":"#/components/schemas/Model22"}},"templateType":{"type":"string","description":"Template Type","example":"PIPELINE","default":"JOB","enum":["JOB","PIPELINE"],"maxLength":16},"Model26":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this template","example":123345,"x-constraint":{"sign":"positive"}},"pipelineId":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"namespace":{"type":"string","description":"Namespace of the Template","example":"node","maxLength":64,"pattern":"^[\\w-]+$"},"name":{"type":"string","description":"Name of the template","example":"nodePipeline","maxLength":64,"pattern":"^[\\w-]+$"},"maintainer":{"type":"string","description":"Maintainer of the Template","example":"foo@bar.com","maxLength":64,"x-format":{"email":true}},"trustedSinceVersion":{"type":"string","description":"The version since the template is marked as trusted","example":"1.2.3","maxLength":16,"pattern":"^(\\d+)\\.(\\d+)\\.(\\d+)$"},"latestVersion":{"type":"string","description":"Latest version of the template","example":"1.2.3","maxLength":16,"pattern":"^(\\d+)\\.(\\d+)\\.(\\d+)$"},"createTime":{"type":"string","description":"When this template was created","example":"2038-01-19T03:14:08.131Z","maxLength":32,"x-format":{"isoDate":true}},"updateTime":{"type":"string","description":"When this template was updated","example":"2038-01-19T03:14:08.131Z","maxLength":32,"x-format":{"isoDate":true}},"templateType":{"$ref":"#/components/schemas/templateType"}},"required":["id","pipelineId","namespace","name","maintainer","templateType"]},"Model27":{"type":"array","items":{"$ref":"#/components/schemas/Model22"}},"Model28":{"type":"array","items":{"type":"string"}},"List of jobs":{"type":"array","items":{"$ref":"#/components/schemas/Get%20Job"}},"triggers":{"type":"array","items":{"example":"~sd@5678:test","anyOf":[{"type":"string","maxLength":128,"pattern":"^~sd@(\\d+):(?:([\\w-]+)|(stage@([\\w-]+):setup))$"},{"type":"string","maxLength":128,"pattern":"^sd@(\\d+):(?:([\\w-]+)|(stage@([\\w-]+):setup))$"}]}},"Model29":{"type":"object","properties":{"jobName":{"type":"string","pattern":"^(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"},"triggers":{"$ref":"#/components/schemas/triggers"}}},"List of triggers":{"type":"array","items":{"$ref":"#/components/schemas/Model29"}},"List of events":{"type":"array","items":{"$ref":"#/components/schemas/Get%20Event"}},"Model30":{"type":"array","items":{"$ref":"#/components/schemas/Get%20tokens"}},"Get User":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this user","example":123345,"x-constraint":{"sign":"positive"}},"username":{"type":"string","description":"Username","example":"batman123","maxLength":128},"scmContext":{"type":"string","description":"The SCM in which the repository exists","example":"github:github.com","maxLength":128,"pattern":"^([^:]+):([^:]+)$"},"settings":{"type":"object","default":{},"properties":{"string":{"$ref":"#/components/schemas/Model21"}}}}},"List of users":{"type":"array","items":{"$ref":"#/components/schemas/Get%20User"}},"List of stage builds for a stage":{"type":"array","items":{"$ref":"#/components/schemas/Get%20Stage%20Build%20metadata"}},"Model31":{"type":"array","items":{"type":"string"}},"TemplateTag":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this template tag","example":123345,"x-constraint":{"sign":"positive"}},"createTime":{"type":"string","description":"When this template tag was created","example":"2038-01-19T03:14:08.131Z","maxLength":32,"x-format":{"isoDate":true}},"namespace":{"type":"string","description":"Namespace of the Template","example":"node","maxLength":64,"pattern":"^[\\w-]+$"},"name":{"type":"string","description":"Template name","example":"nodejs/lib","maxLength":64},"tag":{"type":"string","description":"Name of the Template Tag","example":"latest","maxLength":30,"pattern":"^[a-zA-Z][\\w-.]+$"},"version":{"type":"string","description":"Exact version of the Template","example":"1.2.3","maxLength":16,"pattern":"^(\\d+)\\.(\\d+)\\.(\\d+)$"},"templateType":{"$ref":"#/components/schemas/templateType"}},"required":["templateType"]},"Model32":{"type":"array","items":{"$ref":"#/components/schemas/TemplateTag"}},"CommandTag":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this command tag","example":123345,"x-constraint":{"sign":"positive"}},"createTime":{"type":"string","description":"When this command tag was created","example":"2038-01-19T03:14:08.131Z","maxLength":32,"x-format":{"isoDate":true}},"namespace":{"type":"string","description":"Namespace of the Command","example":"chefdk","maxLength":64,"pattern":"^[\\w-]+$"},"name":{"type":"string","description":"Name of the Command","example":"knife","maxLength":64,"pattern":"^[\\w-]+$"},"tag":{"type":"string","description":"Name of the Command Tag","example":"latest","maxLength":30,"pattern":"^[a-zA-Z][\\w-.]+$"},"version":{"type":"string","description":"Exact version of the Command","example":"1.2.3","maxLength":16,"pattern":"^(\\d+)\\.(\\d+)\\.(\\d+)$"}}},"List of command tags":{"type":"array","items":{"$ref":"#/components/schemas/CommandTag"}},"Model33":{"type":"array","items":{"$ref":"#/components/schemas/TemplateTag"}},"Model34":{"type":"array","items":{"type":"string"}},"Model35":{"type":"array","minItems":1,"items":{"anyOf":[{"type":"string"},{"type":"object","properties":{"string":{"anyOf":[{"type":"string"},{"$ref":"#/x-alt-definitions/Model10"}]}}}]}},"Model36":{"type":"object","default":{},"properties":{"annotations":{"$ref":"#/components/schemas/Model14"},"blockedBy":{"anyOf":[{"$ref":"#/x-alt-definitions/blockedBy"},{"anyOf":[{"type":"string","pattern":"^~([\\w-]+)$"},{"type":"string","pattern":"^~sd@(\\d+):(?:([\\w-]+)|(stage@([\\w-]+):setup))$"}]}]},"cache":{"type":"boolean"},"description":{"type":"string","maxLength":100},"environment":{"type":"object","properties":{"string":{"type":"string"}}},"freezeWindows":{"anyOf":[{"$ref":"#/x-alt-definitions/freezeWindows"},{"type":"string"}]},"image":{"type":"string","pattern":"^[^;&|><*?`$()!#'\" ]+$"},"matrix":{"type":"object","properties":{"string":{"$ref":"#/components/schemas/Model34"}}},"order":{"$ref":"#/components/schemas/order"},"parameters":{"type":"object","properties":{"any":{"anyOf":[{"type":"string"},{"$ref":"#/x-alt-definitions/any"},{"$ref":"#/x-alt-definitions/Model3"}]}}},"provider":{"anyOf":[{"$ref":"#/x-alt-definitions/provider"},{"type":"string","pattern":"^(?:(?:https:\\/\\/(?:[^@/:\\s]+@)?)|git@|org-\\d+@)+([^/:\\s]+)(?:\\/|:)([^/:\\s]+)\\/([^\\s]+?)(?:\\.git)(#[^:　\\s]*　[^:　\\s]*|#[^:　\\s]+)?(:[^:　\\s]*　[^:　\\s]*|:[^:　\\s]+)?$"}]},"requires":{"anyOf":[{"$ref":"#/x-alt-definitions/requires"},{"anyOf":[{"type":"string","pattern":"^~([\\w-]+)$"},{"type":"string","maxLength":100,"pattern":"^(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"},{"type":"string"},{"type":"string","pattern":"^~?stage@([\\w-]+)(?::([\\w-]+))?$"},{"type":"string","pattern":"^~?sd@\\d+:(?:([\\w-]+)|(stage@([\\w-]+):(setup|teardown)))$"}]}]},"secrets":{"$ref":"#/components/schemas/secrets"},"settings":{"$ref":"#/components/schemas/Model15"},"sourcePaths":{"anyOf":[{"$ref":"#/x-alt-definitions/sourcePaths"},{"type":"string","maxLength":1024}]},"steps":{"$ref":"#/components/schemas/Model35"},"template":{"type":"string","pattern":"^([\\w/-]+)(?:@((?:(?:\\d+)(?:\\.\\d+)?(?:\\.\\d+)?)|(?:[a-zA-Z][\\w-.]+)))?$"},"templateId":{"type":"integer","description":"Identifier for this job's template","example":123345,"nullable":true,"x-constraint":{"sign":"positive"}}}},"Model37":{"type":"array","items":{"type":"string","x-format":{"uri":{"relativeOnly":true}}}},"Model38":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/event"},"pipeline":{"$ref":"#/components/schemas/pipeline"},"job":{"type":"object","properties":{"string":{"$ref":"#/components/schemas/Model37"}}}}},"jobs":{"type":"array","minItems":0,"items":{"type":"string","maxLength":100,"pattern":"^(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"}},"Model39":{"type":"array","items":{"type":"string"}},"Model40":{"type":"array","minItems":1,"items":{"anyOf":[{"type":"string"},{"type":"object","properties":{"string":{"anyOf":[{"type":"string"},{"$ref":"#/x-alt-definitions/Model10"}]}}}]}},"setup":{"type":"object","default":{},"properties":{"annotations":{"$ref":"#/components/schemas/Model14"},"blockedBy":{"anyOf":[{"$ref":"#/x-alt-definitions/blockedBy"},{"anyOf":[{"type":"string","pattern":"^~([\\w-]+)$"},{"type":"string","pattern":"^~sd@(\\d+):(?:([\\w-]+)|(stage@([\\w-]+):setup))$"}]}]},"cache":{"type":"boolean"},"description":{"type":"string","maxLength":100},"environment":{"type":"object","properties":{"string":{"type":"string"}}},"freezeWindows":{"anyOf":[{"$ref":"#/x-alt-definitions/freezeWindows"},{"type":"string"}]},"image":{"type":"string","pattern":"^[^;&|><*?`$()!#'\" ]+$"},"matrix":{"type":"object","properties":{"string":{"$ref":"#/components/schemas/Model39"}}},"order":{"$ref":"#/components/schemas/order"},"parameters":{"type":"object","properties":{"any":{"anyOf":[{"type":"string"},{"$ref":"#/x-alt-definitions/any"},{"$ref":"#/x-alt-definitions/Model3"}]}}},"provider":{"anyOf":[{"$ref":"#/x-alt-definitions/provider"},{"type":"string","pattern":"^(?:(?:https:\\/\\/(?:[^@/:\\s]+@)?)|git@|org-\\d+@)+([^/:\\s]+)(?:\\/|:)([^/:\\s]+)\\/([^\\s]+?)(?:\\.git)(#[^:　\\s]*　[^:　\\s]*|#[^:　\\s]+)?(:[^:　\\s]*　[^:　\\s]*|:[^:　\\s]+)?$"}]},"secrets":{"$ref":"#/components/schemas/secrets"},"settings":{"$ref":"#/components/schemas/Model15"},"sourcePaths":{"anyOf":[{"$ref":"#/x-alt-definitions/sourcePaths"},{"type":"string","maxLength":1024}]},"steps":{"$ref":"#/components/schemas/Model40"},"template":{"type":"string","pattern":"^([\\w/-]+)(?:@((?:(?:\\d+)(?:\\.\\d+)?(?:\\.\\d+)?)|(?:[a-zA-Z][\\w-.]+)))?$"},"templateId":{"type":"integer","description":"Identifier for this job's template","example":123345,"nullable":true,"x-constraint":{"sign":"positive"}}}},"Model41":{"type":"array","items":{"type":"string"}},"Model42":{"type":"array","minItems":1,"items":{"anyOf":[{"type":"string"},{"type":"object","properties":{"string":{"anyOf":[{"type":"string"},{"$ref":"#/x-alt-definitions/Model10"}]}}}]}},"teardown":{"type":"object","default":{},"properties":{"annotations":{"$ref":"#/components/schemas/Model14"},"blockedBy":{"anyOf":[{"$ref":"#/x-alt-definitions/blockedBy"},{"anyOf":[{"type":"string","pattern":"^~([\\w-]+)$"},{"type":"string","pattern":"^~sd@(\\d+):(?:([\\w-]+)|(stage@([\\w-]+):setup))$"}]}]},"cache":{"type":"boolean"},"description":{"type":"string","maxLength":100},"environment":{"type":"object","properties":{"string":{"type":"string"}}},"freezeWindows":{"anyOf":[{"$ref":"#/x-alt-definitions/freezeWindows"},{"type":"string"}]},"image":{"type":"string","pattern":"^[^;&|><*?`$()!#'\" ]+$"},"matrix":{"type":"object","properties":{"string":{"$ref":"#/components/schemas/Model41"}}},"order":{"$ref":"#/components/schemas/order"},"parameters":{"type":"object","properties":{"any":{"anyOf":[{"type":"string"},{"$ref":"#/x-alt-definitions/any"},{"$ref":"#/x-alt-definitions/Model3"}]}}},"provider":{"anyOf":[{"$ref":"#/x-alt-definitions/provider"},{"type":"string","pattern":"^(?:(?:https:\\/\\/(?:[^@/:\\s]+@)?)|git@|org-\\d+@)+([^/:\\s]+)(?:\\/|:)([^/:\\s]+)\\/([^\\s]+?)(?:\\.git)(#[^:　\\s]*　[^:　\\s]*|#[^:　\\s]+)?(:[^:　\\s]*　[^:　\\s]*|:[^:　\\s]+)?$"}]},"secrets":{"$ref":"#/components/schemas/secrets"},"settings":{"$ref":"#/components/schemas/Model15"},"steps":{"$ref":"#/components/schemas/Model42"},"template":{"type":"string","pattern":"^([\\w/-]+)(?:@((?:(?:\\d+)(?:\\.\\d+)?(?:\\.\\d+)?)|(?:[a-zA-Z][\\w-.]+)))?$"},"templateId":{"type":"integer","description":"Identifier for this job's template","example":123345,"nullable":true,"x-constraint":{"sign":"positive"}}}},"Model43":{"type":"object","properties":{"description":{"type":"string"},"jobs":{"$ref":"#/components/schemas/jobs"},"setup":{"$ref":"#/components/schemas/setup"},"teardown":{"$ref":"#/components/schemas/teardown"},"requires":{"anyOf":[{"$ref":"#/x-alt-definitions/requires"},{"anyOf":[{"type":"string","pattern":"^~([\\w-]+)$"},{"type":"string","maxLength":100,"pattern":"^(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"},{"type":"string"},{"type":"string","pattern":"^~?stage@([\\w-]+)(?::([\\w-]+))?$"},{"type":"string","pattern":"^~?sd@\\d+:(?:([\\w-]+)|(stage@([\\w-]+):(setup|teardown)))$"}]}]},"sourcePaths":{"anyOf":[{"$ref":"#/x-alt-definitions/sourcePaths"},{"type":"string","maxLength":1024}]}}},"Model44":{"type":"object","properties":{"jobs":{"type":"object","properties":{"string":{"$ref":"#/components/schemas/Model36"}}},"shared":{"$ref":"#/components/schemas/Model36"},"parameters":{"type":"object","default":{},"properties":{"any":{"anyOf":[{"type":"string"},{"$ref":"#/x-alt-definitions/any"},{"$ref":"#/x-alt-definitions/Model3"}]}}},"annotations":{"$ref":"#/components/schemas/Model14"},"cache":{"$ref":"#/components/schemas/Model38"},"subscribe":{"$ref":"#/components/schemas/subscribe"},"stages":{"type":"object","properties":{"string":{"$ref":"#/components/schemas/Model43"}}}},"required":["jobs"]},"Model45":{"type":"object","description":"Graph representation of the workflow","default":"{\"nodes\": [],\"edges\":[]}","properties":{"nodes":{"$ref":"#/components/schemas/nodes"},"edges":{"$ref":"#/components/schemas/edges"}}},"Model46":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this template","example":123345,"x-constraint":{"sign":"positive"}},"templateId":{"type":"integer","description":"Identifier of this template","example":123345,"x-constraint":{"sign":"positive"}},"description":{"type":"string","description":"Description of the Template","example":"Installs npm modules","maxLength":256},"version":{"type":"string","description":"Exact version of the template","example":"1.2.3","maxLength":16,"pattern":"^(\\d+)\\.(\\d+)\\.(\\d+)$"},"config":{"$ref":"#/components/schemas/Model44"},"createTime":{"type":"string","description":"When this template was created","example":"2038-01-19T03:14:08.131Z","maxLength":32,"x-format":{"isoDate":true}},"workflowGraph":{"$ref":"#/components/schemas/Model45"}},"required":["id","templateId","version"]},"List of versions of a template":{"type":"array","items":{"$ref":"#/components/schemas/Model46"}},"Model47":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"name":{"type":"string","example":"screwdriver-cd/screwdriver"},"scmRepo":{"$ref":"#/components/schemas/SCM Repository"},"lastRun":{"anyOf":[{"type":"string","description":"When this event was created","example":"2038-01-19T03:14:08.131Z","maxLength":32,"x-format":{"isoDate":true}},{"type":"string","nullable":true}]},"admins":{"$ref":"#/components/schemas/admins"}},"required":["id","name","scmRepo","admins"]},"Model48":{"type":"array","items":{"$ref":"#/components/schemas/Model47"}},"Create Banner":{"type":"object","properties":{"message":{"type":"string","description":"Body of banner to display","example":"Due to planned upgrade of Kubernetes, Screwdriver will be down","maxLength":512},"isActive":{"type":"boolean","description":"Flag if the banner is active","example":true},"type":{"$ref":"#/components/schemas/type"},"scope":{"$ref":"#/components/schemas/scope"},"scopeId":{"type":"integer","description":"Identifier to pipelineId for PIPELINE, buildId for BUILD, or null for GLOBAL","example":1234,"x-constraint":{"sign":"positive"}}},"required":["message"]},"Create Build":{"type":"object","properties":{"name":{"type":"string","description":"Name of the build cluster","example":"iOS","maxLength":50,"pattern":"^[\\w.-]+$"},"description":{"type":"string","description":"Description of the build cluster","example":"Build cluster for iOS team","maxLength":100},"scmContext":{"type":"string","description":"The SCM in which the repository exists","example":"github:github.com","maxLength":128,"pattern":"^([^:]+):([^:]+)$"},"scmOrganizations":{"$ref":"#/components/schemas/scmOrganizations"},"isActive":{"type":"boolean","description":"Flag if the the build cluster is active","example":true},"managedByScrewdriver":{"type":"boolean","description":"Flag if the cluster is managed by screwdriver team","example":true},"maintainer":{"type":"string","description":"Maintainer of the Command","example":"foo@bar.com","maxLength":64,"x-format":{"email":true}},"weightage":{"type":"number","description":"Weight percentage for build cluster","example":20,"minimum":0,"maximum":100},"group":{"type":"string","description":"Group of the build cluster","example":"default","default":"default"}},"required":["name","scmOrganizations","managedByScrewdriver","maintainer"]},"Model49":{"type":"object","properties":{"jobId":{"type":"integer","description":"Identifier of the parent job","example":123345,"x-constraint":{"sign":"positive"}},"meta":{"$ref":"#/components/schemas/meta"},"stats":{"$ref":"#/components/schemas/stats"}},"required":["jobId"]},"Model50":{"type":"string","description":"Collection type","example":"default","enum":["default","normal"],"maxLength":32},"Create collection":{"type":"object","properties":{"name":{"type":"string","description":"Collection name","example":"Favorites","maxLength":128},"description":{"type":"string","description":"Collection description","example":"List of my favorite pipelines","maxLength":256},"pipelineIds":{"$ref":"#/components/schemas/pipelineIds"},"type":{"$ref":"#/components/schemas/Model50"}},"required":["name"]},"Model51":{"type":"object","description":"Key=>Value information from the event itself","example":{"parameters":{"nameA":"value1","jobA":{"nameB":"value2"}}},"default":{}},"Create Event":{"type":"object","properties":{"parentEventId":{"type":"integer","description":"Identifier of the direct parent event","example":123344,"x-constraint":{"sign":"positive"}},"groupEventId":{"type":"integer","description":"Identifier of the group parent event","example":123344,"x-constraint":{"sign":"positive"}},"causeMessage":{"type":"string","description":"Message that describes why the event was created","example":"Merge pull request #26 from screwdriver-cd/data-schema","maxLength":512},"creator":{"$ref":"#/components/schemas/SCM User"},"meta":{"$ref":"#/components/schemas/Model51"},"pipelineId":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"sha":{"type":"string","description":"SHA this project was built on","example":"ccc49349d3cffbd12ea9e3d41521480b4aa5de5f","x-constraint":{"length":40},"x-format":{"hex":{"byteAligned":false,"prefix":false}}},"configPipelineSha":{"type":"string","description":"SHA of the configuration pipeline this project depends on","example":"ccc49349d3cffbd12ea9e3d41521480b4aa5de5f","x-constraint":{"length":40},"x-format":{"hex":{"byteAligned":false,"prefix":false}}},"startFrom":{"description":"Event start point - a job name or trigger name (~commit/~pr)","example":"~commit","anyOf":[{"type":"string"},{"type":"string","description":"Name of the Job","example":"main","maxLength":110,"pattern":"^(PR-[0-9]+:)?(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"},{"type":"string","pattern":"^(?:PR-\\d+:)?stage@([\\w-]+)$"}]},"prNum":{"type":"integer","x-constraint":{"sign":"positive"}},"baseBranch":{"type":"string","description":"build base branch","example":"develop"},"buildId":{"type":"integer","description":"Identifier of this build","example":123345,"x-constraint":{"sign":"positive"}},"parentBuildId":{"description":"Identifier(s) of this parent build","anyOf":[{"$ref":"#/x-alt-definitions/parentBuildId"},{"type":"integer","x-constraint":{"sign":"positive"}}]},"parentBuilds":{"type":"object","example":{"111":{"eventId":2,"jobs":{"jobA":333,"jobB":null}},"222":{"eventId":3,"jobs":{"jobC":555}}},"properties":{"string":{"$ref":"#/components/schemas/string"}}}}},"Create Pipeline":{"type":"object","properties":{"checkoutUrl":{"type":"string","description":"Checkout url for the application","example":"git@github.com:screwdriver-cd/data-schema.git#master","pattern":"^(?:(?:https:\\/\\/(?:[^@/:\\s]+@)?)|git@|org-\\d+@)+([^/:\\s]+)(?:\\/|:)([^/:\\s]+)\\/([^\\s]+?)(?:\\.git)(#[^:　\\s]*　[^:　\\s]*|#[^:　\\s]+)?(:[^:　\\s]*　[^:　\\s]*|:[^:　\\s]+)?$"},"rootDir":{"type":"string","description":"Root directory (relative to checkoutUrl)","example":"src/app/component","maxLength":100},"autoKeysGeneration":{"type":"boolean","description":"Flag to generate and add the public deploy key for a specific scm"}},"required":["checkoutUrl"]},"Create Secret":{"type":"object","properties":{"pipelineId":{"type":"integer","description":"pipeline associated with the secret","example":123345,"x-constraint":{"sign":"positive"}},"name":{"type":"string","description":"Name of the secret","example":"NPM_TOKEN","maxLength":64,"pattern":"^[A-Z_][A-Z0-9_]*$"},"value":{"type":"string","description":"value of the secret","example":"2d991790bab1ac8576097ca87f170df73410b55c"},"allowInPR":{"type":"boolean","description":"flag to denote if the secret can be shown in PR builds"}},"required":["pipelineId","name","value","allowInPR"]},"Certify input to template validator":{"type":"object","properties":{"yaml":{"type":"string"}},"required":["yaml"]},"Create token":{"type":"object","properties":{"name":{"type":"string","description":"Token name","example":"Mobile token","maxLength":128},"description":{"type":"string","description":"Token description","example":"Used to authenticate the mobile app","maxLength":256}},"required":["name"]},"Validation Input":{"type":"object","properties":{"yaml":{"type":"string"}}},"errors":{"type":"array","items":{"type":"string"}},"Model52":{"type":"array","items":{"$ref":"#/components/schemas/Job%20permutation"}},"Model53":{"type":"object","properties":{"scmUrls":{"$ref":"#/components/schemas/scmUrls"},"startAll":{"type":"boolean"}},"required":["scmUrls"]},"Model54":{"type":"object","properties":{"nodes":{"$ref":"#/components/schemas/nodes"},"edges":{"$ref":"#/components/schemas/edges"}}},"warnMessages":{"type":"array","items":{"type":"string"}},"Execution information":{"type":"object","properties":{"annotations":{"$ref":"#/components/schemas/Model14"},"errors":{"$ref":"#/components/schemas/errors"},"jobs":{"type":"object","properties":{"string":{"$ref":"#/components/schemas/Model52"}}},"childPipelines":{"$ref":"#/components/schemas/Model53"},"workflowGraph":{"$ref":"#/components/schemas/Model54"},"parameters":{"type":"object","default":{},"properties":{"any":{"anyOf":[{"type":"string"},{"$ref":"#/x-alt-definitions/any"},{"$ref":"#/x-alt-definitions/Model3"}]}}},"warnMessages":{"$ref":"#/components/schemas/warnMessages"},"stages":{"type":"object","properties":{"string":{"$ref":"#/components/schemas/Model43"}}},"subscribe":{"$ref":"#/components/schemas/subscribe"},"templateVersionId":{"type":"integer","description":"Identifier for this pipeline's template","example":123345,"nullable":true,"x-constraint":{"sign":"positive"}}}},"Certify input to command validator":{"type":"object","properties":{"yaml":{"type":"string"}},"required":["yaml"]},"Functional context regarding the error":{"type":"object"},"Dot-notation path to the field that caused the validation error":{"type":"array","items":{"type":"string"}},"Model55":{"type":"object","properties":{"context":{"$ref":"#/components/schemas/Functional%20context%20regarding%20the%20error"},"message":{"type":"string"},"path":{"$ref":"#/components/schemas/Dot-notation%20path%20to%20the%20field%20that%20caused%20the%20validation%20error"},"type":{"type":"string"}},"required":["message","path","type"]},"Array of errors encountered while validating the given command":{"type":"array","items":{"$ref":"#/components/schemas/Model55"}},"The end-result of parsing the given command":{"type":"object"},"Command validation output":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/Array%20of%20errors%20encountered%20while%20validating%20the%20given%20command"},"command":{"$ref":"#/components/schemas/The%20end-result%20of%20parsing%20the%20given%20command"}},"required":["errors","command"]},"Array of path to the field that caused the validation error":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"}]}},"Model56":{"type":"object","properties":{"context":{"$ref":"#/components/schemas/Functional context regarding the error"},"message":{"type":"string"},"path":{"$ref":"#/components/schemas/Array%20of%20path%20to%20the%20field%20that%20caused%20the%20validation%20error"},"type":{"type":"string"}},"required":["message","path","type"]},"Array of errors encountered while validating the given template":{"type":"array","items":{"$ref":"#/components/schemas/Model56"}},"The end-result of parsing the given template":{"type":"object"},"Template validation output":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/Array%20of%20errors%20encountered%20while%20validating%20the%20given%20template"},"template":{"$ref":"#/components/schemas/The%20end-result%20of%20parsing%20the%20given%20template"},"warnMessages":{"$ref":"#/components/schemas/warnMessages"}},"required":["errors","template"]},"Model57":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/status"},"message":{"type":"string"}}},"Model58":{"type":"object","properties":{"name":{"type":"string"},"content":{"type":"string"}},"required":["name","content"]},"files":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Model58"}},"Model59":{"type":"object","properties":{"checkoutUrl":{"type":"string","description":"Checkout url for the application","example":"git@github.com:screwdriver-cd/data-schema.git#master","pattern":"^(?:(?:https:\\/\\/(?:[^@/:\\s]+@)?)|git@|org-\\d+@)+([^/:\\s]+)(?:\\/|:)([^/:\\s]+)\\/([^\\s]+?)(?:\\.git)(#[^:　\\s]*　[^:　\\s]*|#[^:　\\s]+)?(:[^:　\\s]*　[^:　\\s]*|:[^:　\\s]+)?$"},"rootDir":{"type":"string","description":"Root directory (relative to checkoutUrl)","example":"src/app/component","maxLength":100},"files":{"$ref":"#/components/schemas/files"},"title":{"type":"string"},"message":{"type":"string"}},"required":["checkoutUrl","files","title","message"]},"Update Banner":{"type":"object","properties":{"message":{"type":"string","description":"Body of banner to display","example":"Due to planned upgrade of Kubernetes, Screwdriver will be down","maxLength":512},"isActive":{"type":"boolean","description":"Flag if the banner is active","example":true},"type":{"$ref":"#/components/schemas/type"}}},"Update BuildCluster":{"type":"object","properties":{"description":{"type":"string","description":"Description of the build cluster","example":"Build cluster for iOS team","maxLength":100},"scmContext":{"type":"string","description":"The SCM in which the repository exists","example":"github:github.com","maxLength":128,"pattern":"^([^:]+):([^:]+)$"},"scmOrganizations":{"$ref":"#/components/schemas/scmOrganizations"},"isActive":{"type":"boolean","description":"Flag if the the build cluster is active","example":true},"managedByScrewdriver":{"type":"boolean","description":"Flag if the cluster is managed by screwdriver team","example":true},"maintainer":{"type":"string","description":"Maintainer of the Command","example":"foo@bar.com","maxLength":64,"x-format":{"email":true}},"weightage":{"type":"number","description":"Weight percentage for build cluster","example":20,"minimum":0,"maximum":100},"group":{"type":"string","description":"Group of the build cluster","example":"default","default":"default"}}},"Update Build":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/meta"},"status":{"$ref":"#/components/schemas/status"},"statusMessage":{"type":"string","description":"Status message to describe status of the build","example":"Build failed due to infrastructure error"},"statusMessageType":{"$ref":"#/components/schemas/statusMessageType"},"stats":{"$ref":"#/components/schemas/stats"}}},"Model60":{"type":"string","description":"Collection type","example":"default","enum":["default","normal"],"maxLength":32},"Update collection":{"type":"object","properties":{"name":{"type":"string","description":"Collection name","example":"Favorites","maxLength":128},"description":{"type":"string","description":"Collection description","example":"List of my favorite pipelines","maxLength":256},"pipelineIds":{"$ref":"#/components/schemas/pipelineIds"},"type":{"$ref":"#/components/schemas/Model60"}}},"Model61":{"type":"string","description":"Current state of the Job","example":"ENABLED","default":"ENABLED","enum":["ENABLED","DISABLED"],"maxLength":10},"Update Job":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/Model61"},"stateChangeMessage":{"type":"string","description":"Reason why disabling or enabling job","example":"Testing out new feature change in beta only","maxLength":512}}},"usernames":{"type":"array","minItems":1,"maxItems":200,"items":{"type":"string","description":"Username","example":"batman123","maxLength":128}},"Model62":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"scmContext":{"type":"string","description":"The SCM in which the repository exists","example":"github:github.com","maxLength":128,"pattern":"^([^:]+):([^:]+)$"},"usernames":{"$ref":"#/components/schemas/usernames"}},"required":["id","scmContext","usernames"]},"Model63":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Model62"}},"Update Pipeline":{"type":"object","properties":{"checkoutUrl":{"type":"string","description":"Checkout url for the application","example":"git@github.com:screwdriver-cd/data-schema.git#master","pattern":"^(?:(?:https:\\/\\/(?:[^@/:\\s]+@)?)|git@|org-\\d+@)+([^/:\\s]+)(?:\\/|:)([^/:\\s]+)\\/([^\\s]+?)(?:\\.git)(#[^:　\\s]*　[^:　\\s]*|#[^:　\\s]+)?(:[^:　\\s]*　[^:　\\s]*|:[^:　\\s]+)?$"},"rootDir":{"type":"string","description":"Root directory (relative to checkoutUrl)","example":"src/app/component","maxLength":100},"autoKeysGeneration":{"type":"boolean","description":"Flag to generate and add the public deploy key for a specific scm"},"settings":{"$ref":"#/components/schemas/settings"},"badges":{"$ref":"#/components/schemas/badges"}}},"Update Secret":{"type":"object","properties":{"value":{"type":"string","description":"value of the secret","example":"2d991790bab1ac8576097ca87f170df73410b55c"},"allowInPR":{"type":"boolean","description":"flag to denote if the secret can be shown in PR builds"}}},"Update token metadata":{"type":"object","properties":{"name":{"type":"string","description":"Token name","example":"Mobile token","maxLength":128},"description":{"type":"string","description":"Token description","example":"Used to authenticate the mobile app","maxLength":256}}},"Update User":{"type":"object","properties":{"settings":{"type":"object","default":{},"properties":{"string":{"$ref":"#/components/schemas/Model21"}}}}},"Model64":{"type":"object","properties":{"trusted":{"type":"boolean","description":"Mark whether template is trusted"}}},"Update Step metadata":{"type":"object","properties":{"code":{"type":"integer","description":"Exit code","example":1},"startTime":{"type":"string","description":"When this Step started","example":"2017-01-06T01:49:50.384359267Z","x-format":{"isoDate":true}},"endTime":{"type":"string","description":"When this Step stopped running","example":"2017-01-06T01:49:51.676057192Z","x-format":{"isoDate":true}},"lines":{"type":"integer","description":"Number of Step log lines","example":100}}},"Model65":{"type":"object","properties":{"trusted":{"type":"boolean","description":"Mark whether command is trusted"}}},"Model66":{"type":"object","properties":{"version":{"type":"string","description":"Exact version of the Template","example":"1.2.3","maxLength":16,"pattern":"^(\\d+)\\.(\\d+)\\.(\\d+)$"}}},"Model67":{"type":"object","properties":{"version":{"anyOf":[{"type":"string","description":"Exact version of the Command","example":"1.2.3","maxLength":16,"pattern":"^(\\d+)\\.(\\d+)\\.(\\d+)$"},{"type":"string","description":"Name of the Command Tag","example":"latest","maxLength":30,"pattern":"^[a-zA-Z][\\w-.]+$"}]}}},"Model68":{"type":"object","properties":{"trusted":{"type":"boolean","description":"Whether pipeline template is trusted"}}},"Model69":{"type":"object","properties":{"version":{"type":"string","description":"Exact version of the Template","example":"1.2.3","maxLength":16,"pattern":"^(\\d+)\\.(\\d+)\\.(\\d+)$"}}}}},"tags":[],"paths":{"/v4/banners":{"get":{"summary":"Get banners","operationId":"getV4Banners","description":"Returns all banner records","tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List%20Banners"}}}}}},"post":{"summary":"Create a new banner","operationId":"postV4Banners","description":"Create a specific banner","tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Create%20Banner"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/buildclusters":{"get":{"summary":"Get build clusters","operationId":"getV4Buildclusters","description":"Returns all build clusters","tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List%20of%20build%20clusters"}}}}}},"post":{"summary":"Create a build cluster","operationId":"postV4Buildclusters","description":"Create a specific build cluster","tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Create%20Build"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/collections":{"get":{"summary":"Get collections for requesting user","operationId":"getV4Collections","description":"Returns all collection records belonging to the requesting user","tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List%20collections%20for%20requesting%20user"}}}}}},"post":{"summary":"Create a new collection","operationId":"postV4Collections","description":"Creates a collection","tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Create%20collection"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/commands":{"get":{"summary":"Get commands with pagination","operationId":"getV4Commands","description":"Returns all command records","parameters":[{"name":"page","in":"query","schema":{"type":"integer","description":"Page to paginate","minimum":1},"description":"Page to paginate"},{"name":"count","in":"query","schema":{"type":"integer","description":"Count to paginate","minimum":1,"maximum":50},"description":"Count to paginate"},{"name":"search","in":"query","schema":{"type":"string","description":"Keyword to search by","maxLength":200},"description":"Keyword to search by"},{"name":"sort","in":"query","schema":{"type":"string","description":"Sorting option","default":"descending","enum":["ascending","descending"],"x-convert":{"case":"lower"}},"description":"Sorting option"},{"name":"sortBy","in":"query","schema":{"type":"string","description":"Field to sort by","maxLength":100},"description":"Field to sort by"},{"name":"getCount","in":"query","schema":{"type":"boolean","description":"Return total count"},"description":"Return total count"},{"name":"namespace","in":"query","schema":{"type":"string","description":"Namespace of the Command","example":"chefdk","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Namespace of the Command"},{"name":"distinct","in":"query","schema":{"type":"string","enum":["id","namespace","version","description","maintainer","format","habitat","docker","binary","name","pipelineId","createTime","usage","trusted","latest","compatibilities"]}},{"name":"compact","in":"query","schema":{"type":"string","enum":["false","true"]}}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/x-alt-definitions/List%20of%20commands"},{"$ref":"#/x-alt-definitions/Model2"},{"$ref":"#/x-alt-definitions/Command%20Count%20and%20List%20of%20commands"}]}}}}}},"post":{"summary":"Create a new command","operationId":"postV4Commands","description":"Create a specific command","tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/isAdmin":{"get":{"summary":"Check if a user is admin of a pipeline, event, or job","operationId":"getV4Isadmin","description":"Returns true or false","parameters":[{"name":"pipelineId","in":"query","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline"},{"name":"eventId","in":"query","schema":{"type":"integer","description":"Identifier of this event","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this event"},{"name":"jobId","in":"query","schema":{"type":"integer","description":"Identifier of this Job","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this Job"}],"tags":["v4"],"security":[{"token":[]}],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/metrics":{"get":{"summary":"application metrics","operationId":"getV4Metrics","description":"Expose application metrics","tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipelines":{"get":{"summary":"Get pipelines with pagination","operationId":"getV4Pipelines","description":"Returns all pipeline records","parameters":[{"name":"page","in":"query","schema":{"type":"integer","description":"Page to paginate","minimum":1},"description":"Page to paginate"},{"name":"count","in":"query","schema":{"type":"integer","description":"Count to paginate","minimum":1,"maximum":50},"description":"Count to paginate"},{"name":"search","in":"query","schema":{"type":"string","description":"Keyword to search by","maxLength":200},"description":"Keyword to search by"},{"name":"sort","in":"query","schema":{"type":"string","description":"Sorting option","default":"descending","enum":["ascending","descending"],"x-convert":{"case":"lower"}},"description":"Sorting option"},{"name":"sortBy","in":"query","schema":{"type":"string","description":"Field to sort by","maxLength":100},"description":"Field to sort by"},{"name":"getCount","in":"query","schema":{"type":"boolean","description":"Return total count"},"description":"Return total count"},{"name":"configPipelineId","in":"query","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline"},{"name":"ids[]","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"name":"ids[]"},{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}}]}},{"name":"scmUri","in":"query","schema":{"type":"string","description":"Unique identifier for the application","example":"github.com:123456:master","maxLength":500,"pattern":"^([^:]+):([^:]+):([^:]+)(?::(.*))?$"},"description":"Unique identifier for the application"},{"name":"scmContext","in":"query","schema":{"type":"string","description":"The SCM in which the repository exists","example":"github:github.com","maxLength":128,"pattern":"^([^:]+):([^:]+)$"},"description":"The SCM in which the repository exists"}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List%20of%20Pipelines"}}}}}},"post":{"summary":"Create a new pipeline","operationId":"postV4Pipelines","description":"Create a specific pipeline","tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Create%20Pipeline"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/release":{"get":{"summary":"API Release information","operationId":"getV4Release","description":"Should respond with 200","tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/stats":{"get":{"summary":"API stats","operationId":"getV4Stats","description":"Should return statistics for the entire system","tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Stats%20Object"}}}}}}},"/v4/status":{"get":{"summary":"API status","operationId":"getV4Status","description":"Should respond with 200: ok","tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/x-alt-definitions/Model4"},{"$ref":"#/x-alt-definitions/Model5"}]}}}}}}},"/v4/templates":{"get":{"summary":"Get templates with pagination","operationId":"getV4Templates","description":"Returns all template records","parameters":[{"name":"page","in":"query","schema":{"type":"integer","description":"Page to paginate","minimum":1},"description":"Page to paginate"},{"name":"count","in":"query","schema":{"type":"integer","description":"Count to paginate","minimum":1,"maximum":50},"description":"Count to paginate"},{"name":"search","in":"query","schema":{"type":"string","description":"Keyword to search by","maxLength":200},"description":"Keyword to search by"},{"name":"sort","in":"query","schema":{"type":"string","description":"Sorting option","default":"descending","enum":["ascending","descending"],"x-convert":{"case":"lower"}},"description":"Sorting option"},{"name":"sortBy","in":"query","schema":{"type":"string","description":"Field to sort by","maxLength":100},"description":"Field to sort by"},{"name":"getCount","in":"query","schema":{"type":"boolean","description":"Return total count"},"description":"Return total count"},{"name":"namespace","in":"query","schema":{"type":"string","description":"Namespace of the Template","example":"node","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Namespace of the Template"},{"name":"distinct","in":"query","schema":{"type":"string","enum":["id","labels","config","name","version","description","maintainer","pipelineId","namespace","images","createTime","trusted","latest","compatibilities"]}},{"name":"compact","in":"query","schema":{"type":"string","enum":["false","true"]}}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/x-alt-definitions/List%20of%20templates"},{"$ref":"#/x-alt-definitions/Model8"},{"$ref":"#/x-alt-definitions/Template%20Count%20and%20List%20of%20templates"}]}}}}}},"post":{"summary":"Create a new template","operationId":"postV4Templates","description":"Create a specific template","tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certify%20input%20to%20template%20validator"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/tokens":{"get":{"summary":"Get tokens with pagination","operationId":"getV4Tokens","description":"Returns all token records belonging to the current user","tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model7"}}}}}},"post":{"summary":"Create a new token","operationId":"postV4Tokens","description":"Create a specific token","tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Create%20token"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/versions":{"get":{"summary":"API Package Versions","operationId":"getV4Versions","description":"Returns list of Screwdriver package versions and third-party dependencies","tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Versions%20Object"}}}}}}},"/v4/auth/contexts":{"get":{"summary":"Get all auth contexts","operationId":"getV4AuthContexts","description":"Get all auth contexts","tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Array%20of%20Contexts"}}}}}}},"/v4/auth/crumb":{"get":{"summary":"Generate crumb","operationId":"getV4AuthCrumb","description":"Should return a crumb","tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Crumb%20to%20prevent%20CSRF%20Object"}}}}}}},"/v4/auth/key":{"get":{"summary":"Get jwt public key","operationId":"getV4AuthKey","description":"Public Key for verifying JSON Web Tokens","tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Public%20Key%20for%20Verifying%20JWTs%20Object"}}}}}}},"/v4/banners/{id}":{"get":{"summary":"Get a single banner","operationId":"getV4BannersId","description":"Return a banner record","parameters":[{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get%20Banner"}}}}}},"put":{"summary":"Update a banner","operationId":"putV4BannersId","description":"Update a banner","parameters":[{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Update%20Banner"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Delete a banner","operationId":"deleteV4BannersId","description":"Delete a specific banner and return null if success","parameters":[{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/buildclusters/{name}":{"get":{"summary":"Get a single build cluster","operationId":"getV4BuildclustersName","description":"Returns a build cluster record","parameters":[{"name":"name","in":"path","schema":{"type":"string","description":"Name of the build cluster","example":"iOS","maxLength":50,"pattern":"^[\\w.-]+$"},"description":"Name of the build cluster","required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get%20BuildCluster"}}}}}},"put":{"summary":"Update a build cluster","operationId":"putV4BuildclustersName","description":"Update a build cluster","parameters":[{"name":"name","in":"path","schema":{"type":"string","description":"Name of the build cluster","example":"iOS","maxLength":50,"pattern":"^[\\w.-]+$"},"description":"Name of the build cluster","required":true}],"tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Update%20BuildCluster"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Delete a single build cluster","operationId":"deleteV4BuildclustersName","description":"Returns null if successful","parameters":[{"name":"name","in":"path","schema":{"type":"string","description":"Name of the build cluster","example":"iOS","maxLength":50,"pattern":"^[\\w.-]+$"},"description":"Name of the build cluster","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/builds/statuses":{"get":{"summary":"Get build statuses for jobs","operationId":"getV4BuildsStatuses","description":"Returns id, jobId, and status for builds","parameters":[{"name":"jobIds","in":"query","schema":{"example":123345,"anyOf":[{"type":"array","items":{"type":"string","pattern":"^[0-9]+$"},"name":"jobIds"},{"type":"string","pattern":"^[0-9]+$"}]},"required":true},{"name":"numBuilds","in":"query","schema":{"type":"integer","default":1,"x-constraint":{"sign":"positive"}}},{"name":"offset","in":"query","schema":{"type":"integer","default":0,"minimum":0}}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model8"}}}}}}},"/v4/builds/{id}":{"get":{"summary":"Get a single build","operationId":"getV4BuildsId","description":"Returns a build record","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this build","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this build","required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get%20Build"}}}}}},"put":{"summary":"Update a build","operationId":"putV4BuildsId","description":"Update a specific build","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this build","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this build","required":true}],"tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Update%20Build"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/collections/{id}":{"get":{"summary":"Get a single collection","operationId":"getV4CollectionsId","description":"Returns a collection record","parameters":[{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get%20collection"}}}}}},"put":{"summary":"Update a collection","operationId":"putV4CollectionsId","description":"Update a specific collection","parameters":[{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Update%20collection"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Delete a single collection","operationId":"deleteV4CollectionsId","description":"Returns null if successful","parameters":[{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/coverage/info":{"get":{"summary":"Get coverage metadata","operationId":"getV4CoverageInfo","description":"Returns object with coverage info","tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/coverage/token":{"get":{"summary":"Get an access token to talk to coverage server","operationId":"getV4CoverageToken","description":"Returns a token string","tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/events/{id}":{"get":{"summary":"Get a single event","operationId":"getV4EventsId","description":"Returns a event record","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this event","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this event","required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get%20Event"}}}}}}},"/v4/jobs/{id}":{"get":{"summary":"Get a single job","operationId":"getV4JobsId","description":"Returns a job record","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this Job","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this Job","required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get%20Job"}}}}}},"put":{"summary":"Update a job","operationId":"putV4JobsId","description":"Update a specific job","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this Job","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this Job","required":true}],"tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Update%20Job"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipeline/templates":{"get":{"summary":"List all the pipeline templates","operationId":"getV4PipelineTemplates","description":"Returns an array template meta for all the pipeline templates","parameters":[{"name":"page","in":"query","schema":{"type":"integer","description":"Page to paginate","minimum":1},"description":"Page to paginate"},{"name":"count","in":"query","schema":{"type":"integer","description":"Count to paginate","minimum":1,"maximum":50},"description":"Count to paginate"},{"name":"search","in":"query","schema":{"type":"string","description":"Keyword to search by","maxLength":200},"description":"Keyword to search by"},{"name":"sort","in":"query","schema":{"type":"string","description":"Sorting option","default":"descending","enum":["ascending","descending"],"x-convert":{"case":"lower"}},"description":"Sorting option"},{"name":"sortBy","in":"query","schema":{"type":"string","description":"Field to sort by","maxLength":100},"description":"Field to sort by"},{"name":"getCount","in":"query","schema":{"type":"boolean","description":"Return total count"},"description":"Return total count"}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/x-alt-definitions/List%20of%20pipeline%20templates"},{"$ref":"#/x-alt-definitions/Pipeline%20Template%20Count%20and%20List%20of%20templates"}]}}}}}}},"/v4/pipelines/{id}":{"get":{"summary":"Get a single pipeline","operationId":"getV4PipelinesId","description":"Returns a pipeline record","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get%20Pipeline"}}}}}},"put":{"summary":"Update a pipeline","operationId":"putV4PipelinesId","description":"Update a specific pipeline","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true}],"tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Update%20Pipeline"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Delete a single pipeline","operationId":"deleteV4PipelinesId","description":"Returns null if successful","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/secrets/{id}":{"get":{"summary":"Get a single secret","operationId":"getV4SecretsId","description":"Returns a secret record","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this secret","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this secret","required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get%20Secret"}}}}}},"put":{"summary":"Update a secret","operationId":"putV4SecretsId","description":"Update a specific secret","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this secret","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this secret","required":true}],"tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Update%20Secret"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Remove a single secret","operationId":"deleteV4SecretsId","description":"Returns null if successful","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this secret","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this secret","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/stages/{id}":{"get":{"summary":"Get a single stage","operationId":"getV4StagesId","description":"Returns a stage record","parameters":[{"name":"id","in":"path","schema":{"type":"integer","example":12345,"x-constraint":{"sign":"positive"}},"required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get%20Stage%20metadata"}}}}}}},"/v4/template/{id}":{"get":{"summary":"Get a single template","operationId":"getV4TemplateId","description":"Returns a template record","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this template","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this template","required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get%20Template"}}}}}}},"/v4/templates/{name}":{"get":{"summary":"Get all template versions for a given template name with pagination","operationId":"getV4TemplatesName","description":"Returns all template records for a given template name","parameters":[{"name":"name","in":"path","schema":{"type":"string","description":"Template name","example":"nodejs/lib","maxLength":64},"description":"Template name","required":true},{"name":"page","in":"query","schema":{"type":"integer","description":"Page to paginate","minimum":1},"description":"Page to paginate"},{"name":"count","in":"query","schema":{"type":"integer","description":"Count to paginate","minimum":1,"maximum":50},"description":"Count to paginate"},{"name":"sort","in":"query","schema":{"type":"string","description":"Sorting option","default":"descending","enum":["ascending","descending"],"x-convert":{"case":"lower"}},"description":"Sorting option"},{"name":"sortBy","in":"query","schema":{"type":"string","description":"Field to sort by","maxLength":100},"description":"Field to sort by"},{"name":"getCount","in":"query","schema":{"type":"boolean","description":"Return total count"},"description":"Return total count"}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List%20of%20templates"}}}}}},"delete":{"summary":"Delete a template","operationId":"deleteV4TemplatesName","description":"Returns null if successful","parameters":[{"name":"name","in":"path","schema":{"type":"string","description":"Template name","example":"nodejs/lib","maxLength":64},"description":"Template name","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/users/settings":{"get":{"summary":"Get user settings","operationId":"getV4UsersSettings","description":"Returns user settings record","tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"object","default":{},"properties":{"string":{"$ref":"#/components/schemas/Model21"}}}}}}}},"put":{"summary":"Update user settings","operationId":"putV4UsersSettings","description":"Update user settings","tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Update%20User"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Reset user settings","operationId":"deleteV4UsersSettings","description":"Reset user settings","tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/users/{username}":{"get":{"summary":"Get an user by SCM username and SCM context","operationId":"getV4UsersUsername","description":"Returns an user by SCM username and SCM context","parameters":[{"name":"username","in":"path","schema":{"type":"string","description":"Username","example":"batman123","maxLength":128},"description":"Username","required":true},{"name":"scmContext","in":"query","schema":{"type":"string","description":"The SCM in which the repository exists","example":"github:github.com","maxLength":128,"pattern":"^([^:]+):([^:]+)$"},"description":"The SCM in which the repository exists","required":true},{"name":"includeUserToken","in":"query","schema":{"type":"boolean"}}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/auth/token/{buildId}":{"get":{"summary":"Generate jwt","operationId":"getV4AuthTokenBuildid","description":"Generate a JWT for use throughout Screwdriver","parameters":[{"name":"buildId","in":"path","schema":{"anyOf":[{"type":"integer","description":"Identifier of this build","example":123345,"x-constraint":{"sign":"positive"}},{"type":"string","description":"Username","example":"batman123","maxLength":128}]}}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSON%20Web%20Token%20Object"}}}}}}},"/v4/builds/{id}/secrets":{"get":{"summary":"Get all secrets for a given build","operationId":"getV4BuildsIdSecrets","description":"Returns all secrets for a given build","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this build","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this build","required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List%20of%20secrets"}}}}}}},"/v4/builds/{id}/steps":{"get":{"summary":"Get a step for a build","operationId":"getV4BuildsIdSteps","description":"Returns a step record","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this build","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this build","required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List%20of%20steps"}}}}}}},"/v4/builds/{id}/metrics":{"get":{"summary":"Get metrics for this build","operationId":"getV4BuildsIdMetrics","description":"Returns list of metrics for the given build","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this build","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this build","required":true},{"name":"startTime","in":"query","schema":{"type":"string","example":"1970-01-01T15:00:00Z","x-format":{"isoDate":true}}},{"name":"endTime","in":"query","schema":{"type":"string","example":"1970-01-03T18:00:00Z","x-format":{"isoDate":true}}}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model23"}}}}}}},"/v4/builds/{id}/artifacts":{"get":{"summary":"Get a zipped file including all build artifacts","operationId":"getV4BuildsIdArtifacts","description":"Redirects to store with proper token","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this build","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this build","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/commands/{namespace}/{name}":{"get":{"summary":"Get all command versions for a given command namespace/name with pagination","operationId":"getV4CommandsNamespaceName","description":"Returns all command records for a given command namespace/name","parameters":[{"name":"namespace","in":"path","schema":{"type":"string","description":"Namespace of the Command","example":"chefdk","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Namespace of the Command","required":true},{"name":"name","in":"path","schema":{"type":"string","description":"Name of the Command","example":"knife","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Name of the Command","required":true},{"name":"page","in":"query","schema":{"type":"integer","description":"Page to paginate","minimum":1},"description":"Page to paginate"},{"name":"count","in":"query","schema":{"type":"integer","description":"Count to paginate","minimum":1,"maximum":50},"description":"Count to paginate"},{"name":"sort","in":"query","schema":{"type":"string","description":"Sorting option","default":"descending","enum":["ascending","descending"],"x-convert":{"case":"lower"}},"description":"Sorting option"},{"name":"sortBy","in":"query","schema":{"type":"string","description":"Field to sort by","maxLength":100},"description":"Field to sort by"},{"name":"getCount","in":"query","schema":{"type":"boolean","description":"Return total count"},"description":"Return total count"}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List%20of%20commands"}}}}}},"delete":{"summary":"Delete a command","operationId":"deleteV4CommandsNamespaceName","description":"Returns null if successful","parameters":[{"name":"namespace","in":"path","schema":{"type":"string","description":"Namespace of the Command","example":"chefdk","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Namespace of the Command","required":true},{"name":"name","in":"path","schema":{"type":"string","description":"Name of the Command","example":"knife","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Name of the Command","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/events/{id}/stageBuilds":{"get":{"summary":"Get stage builds for a given event","operationId":"getV4EventsIdStagebuilds","description":"Returns stage builds for a given event","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this event","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this event","required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List%20of%20stage%20builds"}}}}}}},"/v4/events/{id}/builds":{"get":{"summary":"Get builds for a given event","operationId":"getV4EventsIdBuilds","description":"Returns builds for a given event","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this event","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this event","required":true},{"name":"page","in":"query","schema":{"type":"integer","description":"Page to paginate","minimum":1},"description":"Page to paginate"},{"name":"count","in":"query","schema":{"type":"integer","description":"Count to paginate","minimum":1,"maximum":50},"description":"Count to paginate"},{"name":"sort","in":"query","schema":{"type":"string","description":"Sorting option","default":"descending","enum":["ascending","descending"],"x-convert":{"case":"lower"}},"description":"Sorting option"},{"name":"sortBy","in":"query","schema":{"type":"string","description":"Field to sort by","maxLength":100},"description":"Field to sort by"},{"name":"readOnly","in":"query","schema":{"type":"boolean","default":false}},{"name":"fetchSteps","in":"query","schema":{"type":"boolean","default":true}}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List%20of%20builds"}}}}}}},"/v4/events/{id}/metrics":{"get":{"summary":"Get metrics for this event","operationId":"getV4EventsIdMetrics","description":"Returns list of metrics for the given event","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this event","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this event","required":true},{"name":"startTime","in":"query","schema":{"type":"string","example":"1970-01-01T15:00:00Z","x-format":{"isoDate":true}}},{"name":"endTime","in":"query","schema":{"type":"string","example":"1970-01-03T18:00:00Z","x-format":{"isoDate":true}}}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model24"}}}}}}},"/v4/jobs/{id}/latestBuild":{"get":{"summary":"Get latest build for a given job","operationId":"getV4JobsIdLatestbuild","description":"Return latest build of status specified","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this Job","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this Job","required":true},{"name":"status","in":"query","schema":{"type":"string","description":"Current status of the build","example":"SUCCESS","enum":["ABORTED","CREATED","FAILURE","QUEUED","RUNNING","SUCCESS","BLOCKED","UNSTABLE","COLLAPSED","FROZEN"]},"description":"Current status of the build"}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get%20Build"}}}}}}},"/v4/jobs/{id}/lastSuccessfulMeta":{"get":{"summary":"Get the last successful metadata for a given job","operationId":"getV4JobsIdLastsuccessfulmeta","description":"If no successful builds found in the past 50 builds, will return {}","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this Job","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this Job","required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model22"}}}}}}},"/v4/jobs/{id}/builds":{"get":{"summary":"Get builds for a given job","operationId":"getV4JobsIdBuilds","description":"Returns builds for a given job","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this Job","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this Job","required":true},{"name":"page","in":"query","schema":{"type":"integer","description":"Page to paginate","minimum":1},"description":"Page to paginate"},{"name":"count","in":"query","schema":{"type":"integer","description":"Count to paginate","minimum":1,"maximum":50},"description":"Count to paginate"},{"name":"sort","in":"query","schema":{"type":"string","description":"Sorting option","default":"descending","enum":["ascending","descending"],"x-convert":{"case":"lower"}},"description":"Sorting option"},{"name":"sortBy","in":"query","schema":{"type":"string","description":"Field to sort by","maxLength":100},"description":"Field to sort by"},{"name":"readOnly","in":"query","schema":{"type":"boolean","default":true}},{"name":"fetchSteps","in":"query","schema":{"type":"boolean","default":true}},{"name":"status","in":"query","schema":{"type":"string","description":"Current status of the build","example":"SUCCESS","enum":["ABORTED","CREATED","FAILURE","QUEUED","RUNNING","SUCCESS","BLOCKED","UNSTABLE","COLLAPSED","FROZEN"]},"description":"Current status of the build"}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List of builds"}}}}}}},"/v4/jobs/{id}/metrics":{"get":{"summary":"Get build metrics for this job","operationId":"getV4JobsIdMetrics","description":"Returns list of build metrics for the given job","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this Job","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this Job","required":true},{"name":"startTime","in":"query","schema":{"type":"string","example":"1970-01-01T15:00:00Z","x-format":{"isoDate":true}}},{"name":"endTime","in":"query","schema":{"type":"string","example":"1970-01-03T18:00:00Z","x-format":{"isoDate":true}}},{"name":"aggregateInterval","in":"query","schema":{"type":"string","enum":["none","day","week","month","year"]}}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model25"}}}}}}},"/v4/pipeline/template/{id}":{"get":{"summary":"Get a single template","operationId":"getV4PipelineTemplateId","description":"Returns a template record","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this template","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this template","required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model26"}}}}}}},"/v4/pipelines/{id}/admin":{"get":{"summary":"Get the pipeline admin","operationId":"getV4PipelinesIdAdmin","description":"Returns a pipeline admin record","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true},{"name":"scmContext","in":"query","schema":{"type":"string","description":"The SCM in which the repository exists","example":"github:github.com","maxLength":128,"pattern":"^([^:]+):([^:]+)$"},"description":"The SCM in which the repository exists"},{"name":"includeUserToken","in":"query","schema":{"type":"boolean"}}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipelines/{id}/lastSuccessfulEvent":{"get":{"summary":"Get last successful event for a given pipeline","operationId":"getV4PipelinesIdLastsuccessfulevent","description":"Return last successful event","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get%20Event"}}}}}}},"/v4/pipelines/{id}/metrics":{"get":{"summary":"Get metrics for this pipeline","operationId":"getV4PipelinesIdMetrics","description":"Returns list of metrics for the given pipeline","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true},{"name":"page","in":"query","schema":{"type":"integer","description":"Page to paginate","minimum":1},"description":"Page to paginate"},{"name":"count","in":"query","schema":{"type":"integer","description":"Count to paginate","minimum":1,"maximum":50},"description":"Count to paginate"},{"name":"sort","in":"query","schema":{"type":"string","description":"Sorting option","default":"descending","enum":["ascending","descending"],"x-convert":{"case":"lower"}},"description":"Sorting option"},{"name":"sortBy","in":"query","schema":{"type":"string","description":"Field to sort by","maxLength":100},"description":"Field to sort by"},{"name":"getCount","in":"query","schema":{"type":"boolean","description":"Return total count"},"description":"Return total count"},{"name":"startTime","in":"query","schema":{"type":"string","example":"1970-01-01T15:00:00Z","x-format":{"isoDate":true}}},{"name":"endTime","in":"query","schema":{"type":"string","example":"1970-01-03T18:00:00Z","x-format":{"isoDate":true}}},{"name":"aggregateInterval","in":"query","schema":{"type":"string","enum":["none","day","week","month","year"]}},{"name":"downtimeJobs[]","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","pattern":"^[0-9]+$"},"name":"downtimeJobs[]"},{"type":"string","pattern":"^[0-9]+$"}]}},{"name":"downtimeStatuses[]","in":"query","schema":{"anyOf":[{"type":"array","items":{"type":"string","description":"Current status of the build","example":"SUCCESS","enum":["ABORTED","CREATED","FAILURE","QUEUED","RUNNING","SUCCESS","BLOCKED","UNSTABLE","COLLAPSED","FROZEN"]},"name":"downtimeStatuses[]"},{"type":"string","description":"Current status of the build","example":"SUCCESS","enum":["ABORTED","CREATED","FAILURE","QUEUED","RUNNING","SUCCESS","BLOCKED","UNSTABLE","COLLAPSED","FROZEN"]}]}}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model27"}}}}}}},"/v4/pipelines/{id}/builds":{"get":{"summary":"Get builds for this pipeline","operationId":"getV4PipelinesIdBuilds","description":"Returns builds for the given pipeline","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true},{"name":"page","in":"query","schema":{"type":"integer","description":"Page to paginate","minimum":1},"description":"Page to paginate"},{"name":"count","in":"query","schema":{"type":"integer","description":"Count to paginate","minimum":1,"maximum":50},"description":"Count to paginate"},{"name":"sort","in":"query","schema":{"type":"string","description":"Sorting option","default":"descending","enum":["ascending","descending"],"x-convert":{"case":"lower"}},"description":"Sorting option"},{"name":"sortBy","in":"query","schema":{"type":"string","description":"Field to sort by","maxLength":100},"description":"Field to sort by"},{"name":"readOnly","in":"query","schema":{"type":"boolean","default":true}},{"name":"fetchSteps","in":"query","schema":{"type":"boolean","default":true}},{"name":"groupEventId","in":"query","schema":{"type":"integer","description":"Identifier of the group parent event","example":123344,"x-constraint":{"sign":"positive"}},"description":"Identifier of the group parent event"},{"name":"latest","in":"query","schema":{"type":"boolean","default":false}}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model28"}}}}}}},"/v4/pipelines/{id}/secrets":{"get":{"summary":"Get all secrets secrets for a given pipelines","operationId":"getV4PipelinesIdSecrets","description":"Returns all secrets for a given pipeline","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List of secrets"}}}}}}},"/v4/pipelines/{id}/stages":{"get":{"summary":"Get all stages for a given pipeline","operationId":"getV4PipelinesIdStages","description":"Returns all stages for a given pipeline","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true},{"name":"page","in":"query","schema":{"type":"integer","description":"Page to paginate","minimum":1},"description":"Page to paginate"},{"name":"count","in":"query","schema":{"type":"integer","description":"Count to paginate","minimum":1,"maximum":50},"description":"Count to paginate"},{"name":"sort","in":"query","schema":{"type":"string","description":"Sorting option","default":"descending","enum":["ascending","descending"],"x-convert":{"case":"lower"}},"description":"Sorting option"},{"name":"sortBy","in":"query","schema":{"type":"string","description":"Field to sort by","maxLength":100},"description":"Field to sort by"},{"name":"getCount","in":"query","schema":{"type":"boolean","description":"Return total count"},"description":"Return total count"},{"name":"name","in":"query","schema":{"type":"string","description":"Name of the Stage","example":"deploy","maxLength":110,"pattern":"^[\\w-]+$"},"description":"Name of the Stage"},{"name":"type","in":"query","schema":{"type":"string","enum":["pr"]}}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipelines/{id}/badge":{"get":{"summary":"Get a badge for the pipeline","operationId":"getV4PipelinesIdBadge","description":"Redirects to the badge service","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipelines/{id}/jobs":{"get":{"summary":"Get all jobs for a given pipeline","operationId":"getV4PipelinesIdJobs","description":"Returns all jobs for a given pipeline","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true},{"name":"page","in":"query","schema":{"type":"integer","description":"Page to paginate","minimum":1},"description":"Page to paginate"},{"name":"count","in":"query","schema":{"type":"integer","description":"Count to paginate","minimum":1,"maximum":50},"description":"Count to paginate"},{"name":"sort","in":"query","schema":{"type":"string","description":"Sorting option","default":"descending","enum":["ascending","descending"],"x-convert":{"case":"lower"}},"description":"Sorting option"},{"name":"type","in":"query","schema":{"type":"string","enum":["pr","pipeline"]}},{"name":"archived","in":"query","schema":{"type":"boolean","default":false}},{"name":"jobName","in":"query","schema":{"type":"string","description":"Name of the Job","example":"main","maxLength":110,"pattern":"^(PR-[0-9]+:)?(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"},"description":"Name of the Job"}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List%20of%20jobs"}}}}}}},"/v4/pipelines/{id}/triggers":{"get":{"summary":"Get all triggers for a given pipeline","operationId":"getV4PipelinesIdTriggers","description":"Returns all triggers for a given pipeline","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List%20of%20triggers"}}}}}}},"/v4/pipelines/{id}/events":{"get":{"summary":"Get pipeline type events for this pipeline","operationId":"getV4PipelinesIdEvents","description":"Returns pipeline events for the given pipeline","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true},{"name":"page","in":"query","schema":{"type":"integer","description":"Page to paginate","minimum":1},"description":"Page to paginate"},{"name":"count","in":"query","schema":{"type":"integer","description":"Count to paginate","minimum":1,"maximum":50},"description":"Count to paginate"},{"name":"sort","in":"query","schema":{"type":"string","description":"Sorting option","default":"descending","enum":["ascending","descending"],"x-convert":{"case":"lower"}},"description":"Sorting option"},{"name":"sortBy","in":"query","schema":{"type":"string","description":"Field to sort by","maxLength":100},"description":"Field to sort by"},{"name":"type","in":"query","schema":{"type":"string","description":"Type of the event","example":"pr","enum":["pr","pipeline"],"maxLength":10},"description":"Type of the event"},{"name":"prNum","in":"query","schema":{"type":"integer","description":"Pull request number if it is a PR event","x-constraint":{"sign":"positive"}},"description":"Pull request number if it is a PR event"},{"name":"sha","in":"query","schema":{"type":"string","description":"SHA or partial SHA","example":"ccc49349d3cffbd12ea9e3d41521480b4aa5de5f","maxLength":40,"x-format":{"hex":{"byteAligned":false,"prefix":false}}},"description":"SHA or partial SHA"},{"name":"message","in":"query","schema":{"type":"string","example":"fix: Typo"}},{"name":"author","in":"query","schema":{"type":"string","example":"Dao Lam"}},{"name":"creator","in":"query","schema":{"type":"string","description":"Creator Name; optionally use \"ne:\" prefix to exclude creator","example":"Dao Lam"},"description":"Creator Name; optionally use \"ne:\" prefix to exclude creator"},{"name":"id","in":"query","schema":{"description":"Event ID; alternatively can use greater than or less than prefix (gt:/lt:)","example":"gt:12345","anyOf":[{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},{"type":"string","pattern":"^(gt|lt):([\\d]+)$"}]},"description":"Event ID; alternatively can use greater than or less than prefix (gt:/lt:)"},{"name":"groupEventId","in":"query","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline"}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List%20of%20events"}}}}}}},"/v4/pipelines/{id}/tokens":{"get":{"summary":"List tokens for pipeline","operationId":"getV4PipelinesIdTokens","description":"List tokens for a specific pipeline","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model30"}}}}}},"post":{"summary":"Create a new token for pipeline","operationId":"postV4PipelinesIdTokens","description":"Create a specific token for pipeline","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true}],"tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Create%20token"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Remove all tokens for a specific pipeline","operationId":"deleteV4PipelinesIdTokens","description":"Returns null if successful","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipelines/{id}/latestCommitEvent":{"get":{"summary":"Get latest commit event for a given pipeline","operationId":"getV4PipelinesIdLatestcommitevent","description":"Return latest commit event","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get%20Event"}}}}}}},"/v4/pipelines/{id}/admins":{"get":{"summary":"Get all admin users for a given pipeline","operationId":"getV4PipelinesIdAdmins","description":"Returns all admin users for a given pipeline","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List%20of%20users"}}}}}}},"/v4/stages/{id}/stageBuilds":{"get":{"summary":"Get stage builds for a stage","operationId":"getV4StagesIdStagebuilds","description":"Returns all stage builds for a stage","parameters":[{"name":"id","in":"path","schema":{"type":"integer","example":12345,"x-constraint":{"sign":"positive"}},"required":true},{"name":"page","in":"query","schema":{"type":"integer","description":"Page to paginate","minimum":1},"description":"Page to paginate"},{"name":"count","in":"query","schema":{"type":"integer","description":"Count to paginate","minimum":1,"maximum":50},"description":"Count to paginate"},{"name":"sort","in":"query","schema":{"type":"string","description":"Sorting option","default":"descending","enum":["ascending","descending"],"x-convert":{"case":"lower"}},"description":"Sorting option"},{"name":"sortBy","in":"query","schema":{"type":"string","description":"Field to sort by","maxLength":100},"description":"Field to sort by"},{"name":"eventId","in":"query","schema":{"type":"integer","description":"Identifier of the event","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of the event"}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List%20of%20stage%20builds%20for%20a%20stage"}}}}}}},"/v4/templates/{name}/metrics":{"get":{"summary":"Get all template versions and metrics for a template name with pagination","operationId":"getV4TemplatesNameMetrics","description":"Returns all template records and associated metrics for a given template name","parameters":[{"name":"name","in":"path","schema":{"type":"string","description":"Template name","example":"nodejs/lib","maxLength":64},"description":"Template name","required":true},{"name":"page","in":"query","schema":{"type":"integer","description":"Page to paginate","minimum":1},"description":"Page to paginate"},{"name":"count","in":"query","schema":{"type":"integer","description":"Count to paginate","minimum":1,"maximum":50},"description":"Count to paginate"},{"name":"sort","in":"query","schema":{"type":"string","description":"Sorting option","default":"descending","enum":["ascending","descending"],"x-convert":{"case":"lower"}},"description":"Sorting option"},{"name":"startTime","in":"query","schema":{"type":"string","example":"1970-01-01T15:00:00Z","x-format":{"isoDate":true}}},{"name":"endTime","in":"query","schema":{"type":"string","example":"1970-01-03T18:00:00Z","x-format":{"isoDate":true}}}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model31"}}}}}}},"/v4/templates/{name}/tags":{"get":{"summary":"Get all template tags for a given template name","operationId":"getV4TemplatesNameTags","description":"Returns all template tags for a given template name","parameters":[{"name":"name","in":"path","schema":{"type":"string","description":"Template name","example":"nodejs/lib","maxLength":64},"description":"Template name","required":true},{"name":"page","in":"query","schema":{"type":"integer","description":"Page to paginate","minimum":1},"description":"Page to paginate"},{"name":"count","in":"query","schema":{"type":"integer","description":"Count to paginate","minimum":1,"maximum":50},"description":"Count to paginate"},{"name":"sort","in":"query","schema":{"type":"string","description":"Sorting option","default":"descending","enum":["ascending","descending"],"x-convert":{"case":"lower"}},"description":"Sorting option"},{"name":"sortBy","in":"query","schema":{"type":"string","description":"Field to sort by","maxLength":100},"description":"Field to sort by"}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model32"}}}}}}},"/v4/templates/{name}/{versionOrTag}":{"get":{"summary":"Get a single template given template name and version or tag","operationId":"getV4TemplatesNameVersionortag","description":"Returns a template record","parameters":[{"name":"name","in":"path","schema":{"type":"string","description":"Template name","example":"nodejs/lib","maxLength":64},"description":"Template name","required":true},{"name":"versionOrTag","in":"path","schema":{"anyOf":[{"type":"string","description":"Version of the Template","example":"1.2","maxLength":16,"pattern":"^(\\d+)(\\.\\d+)?(\\.\\d+)?$"},{"type":"string","description":"Name of the Template Tag","example":"latest","maxLength":30,"pattern":"^[a-zA-Z][\\w-.]+$"}]},"required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get%20Template"}}}}}}},"/v4/auth/login/github:github.com/{web}":{"get":{"summary":"Login using oauth","operationId":"getV4AuthLoginGithubgithubcomWeb","description":"Authenticate user with oauth provider","tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"post":{"summary":"Login using oauth","operationId":"postV4AuthLoginGithubgithubcomWeb","description":"Authenticate user with oauth provider","tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/auth/login/guest/{web}":{"get":{"summary":"Login as an guest user","operationId":"getV4AuthLoginGuestWeb","description":"Authenticate an guest user","tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/builds/{id}/artifacts/{name*}":{"get":{"summary":"Get a single build artifact","operationId":"getV4BuildsIdArtifactsName","description":"Redirects to store with proper token","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this build","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this build","required":true},{"name":"name","in":"path","schema":{"type":"string"}},{"name":"type","in":"query","schema":{"type":"string","default":"preview","enum":["download","preview"]}},{"name":"dir","in":"query","schema":{"type":"boolean","default":false}}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/builds/{id}/steps/{name}":{"get":{"summary":"Get a step for a build","operationId":"getV4BuildsIdStepsName","description":"Returns a step record","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this build","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this build","required":true},{"name":"name","in":"path","schema":{"type":"string","description":"Name of the Step","example":"install","maxLength":64},"description":"Name of the Step","required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get%20Step%20metadata"}}}}}},"put":{"summary":"Update a step for a build","operationId":"putV4BuildsIdStepsName","description":"Writes a step record","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this build","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this build","required":true},{"name":"name","in":"path","schema":{"type":"string","description":"Name of the Step","example":"install","maxLength":64},"description":"Name of the Step","required":true}],"tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Update%20Step%20metadata"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get%20Step%20metadata"}}}}}}},"/v4/commands/{namespace}/{name}/{versionOrTag}":{"get":{"summary":"Get a single command given command namespace, name and version or tag","operationId":"getV4CommandsNamespaceNameVersionortag","description":"Returns a command record","parameters":[{"name":"namespace","in":"path","schema":{"type":"string","description":"Namespace of the Command","example":"chefdk","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Namespace of the Command","required":true},{"name":"name","in":"path","schema":{"type":"string","description":"Name of the Command","example":"knife","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Name of the Command","required":true},{"name":"versionOrTag","in":"path","schema":{"anyOf":[{"type":"string","description":"Version of the Command","example":"1.2","maxLength":16,"pattern":"^(\\d+)(\\.\\d+)?(\\.\\d+)?$"},{"type":"string","description":"Name of the Command Tag","example":"latest","maxLength":30,"pattern":"^[a-zA-Z][\\w-.]+$"}]},"required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get%20Command"}}}}}}},"/v4/commands/{namespace}/{name}/tags":{"get":{"summary":"Get all command tags for a given command namespace and name","operationId":"getV4CommandsNamespaceNameTags","description":"Returns all command tags for a given command namespace and name","parameters":[{"name":"namespace","in":"path","schema":{"type":"string","description":"Namespace of the Command","example":"chefdk","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Namespace of the Command","required":true},{"name":"name","in":"path","schema":{"type":"string","description":"Name of the Command","example":"knife","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Name of the Command","required":true},{"name":"page","in":"query","schema":{"type":"integer","description":"Page to paginate","minimum":1},"description":"Page to paginate"},{"name":"count","in":"query","schema":{"type":"integer","description":"Count to paginate","minimum":1,"maximum":50},"description":"Count to paginate"},{"name":"sort","in":"query","schema":{"type":"string","description":"Sorting option","default":"descending","enum":["ascending","descending"],"x-convert":{"case":"lower"}},"description":"Sorting option"}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List%20of%20command%20tags"}}}}}}},"/v4/pipeline/template/{namespace}/{name}":{"get":{"summary":"Get a specific template by namespace and name","operationId":"getV4PipelineTemplateNamespaceName","description":"Returns template meta for the specified namespace and name","parameters":[{"name":"namespace","in":"path","schema":{"type":"string","description":"Namespace of the Template","example":"node","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Namespace of the Template","required":true},{"name":"name","in":"path","schema":{"type":"string","description":"Name of the template","example":"nodePipeline","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Name of the template","required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model26"}}}}}}},"/v4/pipelines/{id}/{jobName}/badge":{"get":{"summary":"Get a badge for a job","operationId":"getV4PipelinesIdJobnameBadge","description":"Redirects to the badge service","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true},{"name":"jobName","in":"path","schema":{"type":"string","description":"Name of the Job","example":"main","maxLength":110,"pattern":"^(PR-[0-9]+:)?(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"},"description":"Name of the Job","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/builds/{id}/steps/{name}/logs":{"get":{"summary":"Get the logs for a build step","operationId":"getV4BuildsIdStepsNameLogs","description":"Returns the logs for a step","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this build","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this build","required":true},{"name":"name","in":"path","schema":{"type":"string","description":"Name of the Step","example":"install","maxLength":64},"description":"Name of the Step","required":true},{"name":"from","in":"query","schema":{"type":"integer","description":"Starting line Number","default":0,"minimum":0},"description":"Starting line Number"},{"name":"pages","in":"query","schema":{"type":"integer","description":"Max pages sent per request","default":10,"minimum":1},"description":"Max pages sent per request"},{"name":"sort","in":"query","schema":{"type":"string","description":"Sorting option for lines","default":"ascending","enum":["ascending","descending"],"x-convert":{"case":"lower"}},"description":"Sorting option for lines"},{"name":"type","in":"query","schema":{"type":"string","default":"preview","enum":["download","preview"]}},{"name":"timestamp","in":"query","schema":{"type":"boolean","description":"Enable timestamp in logs","default":false},"description":"Enable timestamp in logs"},{"name":"timestampFormat","in":"query","schema":{"type":"string","description":"Timestamp format at the head of the log","default":"full-time","enum":["full-time","simple-time","elapsed-build","elapsed-step"]},"description":"Timestamp format at the head of the log"},{"name":"timezone","in":"query","schema":{"type":"string","description":"Timezone of timestamp in logs","default":"UTC"},"description":"Timezone of timestamp in logs"}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipeline/template/{namespace}/{name}/{versionOrTag}":{"get":{"summary":"Get a specific template version details by version number or tag","operationId":"getV4PipelineTemplateNamespaceNameVersionortag","description":"Returns template meta and version for namespace, name and version/tag","parameters":[{"name":"namespace","in":"path","schema":{"type":"string","description":"Namespace of the Template","example":"node","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Namespace of the Template","required":true},{"name":"name","in":"path","schema":{"type":"string","description":"Name of the template","example":"nodePipeline","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Name of the template","required":true},{"name":"versionOrTag","in":"path","schema":{"required":["versionOrTag"],"anyOf":[{"type":"string","description":"Exact version of the template","example":"1.2.3","maxLength":16,"pattern":"^(\\d+)\\.(\\d+)\\.(\\d+)$"},{"type":"string","description":"Name of the Template Tag","example":"latest","maxLength":30,"pattern":"^[a-zA-Z][\\w-.]+$"}]},"required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipeline/templates/{namespace}/{name}/tags":{"get":{"summary":"Get all pipeline template tags for a given template name and namespace","operationId":"getV4PipelineTemplatesNamespaceNameTags","description":"Returns all pipeline template tags for a given template name and namespace","parameters":[{"name":"namespace","in":"path","schema":{"type":"string","description":"Namespace of the Template","example":"node","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Namespace of the Template","required":true},{"name":"name","in":"path","schema":{"type":"string","description":"Name of the template","example":"nodePipeline","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Name of the template","required":true},{"name":"page","in":"query","schema":{"type":"integer","description":"Page to paginate","minimum":1},"description":"Page to paginate"},{"name":"count","in":"query","schema":{"type":"integer","description":"Count to paginate","minimum":1,"maximum":50},"description":"Count to paginate"},{"name":"sort","in":"query","schema":{"type":"string","description":"Sorting option","default":"descending","enum":["ascending","descending"],"x-convert":{"case":"lower"}},"description":"Sorting option"},{"name":"sortBy","in":"query","schema":{"type":"string","description":"Field to sort by","maxLength":100},"description":"Field to sort by"},{"name":"getCount","in":"query","schema":{"type":"boolean","description":"Return total count"},"description":"Return total count"}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model33"}}}}}}},"/v4/pipeline/templates/{namespace}/{name}/versions":{"get":{"summary":"Get all template versions for a given template name with pagination","operationId":"getV4PipelineTemplatesNamespaceNameVersions","description":"Returns all template records for a given template name","parameters":[{"name":"namespace","in":"path","schema":{"type":"string","description":"Namespace of the Template","example":"node","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Namespace of the Template","required":true},{"name":"name","in":"path","schema":{"type":"string","description":"Name of the template","example":"nodePipeline","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Name of the template","required":true},{"name":"page","in":"query","schema":{"type":"integer","description":"Page to paginate","minimum":1},"description":"Page to paginate"},{"name":"count","in":"query","schema":{"type":"integer","description":"Count to paginate","minimum":1,"maximum":50},"description":"Count to paginate"},{"name":"sort","in":"query","schema":{"type":"string","description":"Sorting option","default":"descending","enum":["ascending","descending"],"x-convert":{"case":"lower"}},"description":"Sorting option"},{"name":"sortBy","in":"query","schema":{"type":"string","description":"Field to sort by","maxLength":100},"description":"Field to sort by"},{"name":"getCount","in":"query","schema":{"type":"boolean","description":"Return total count"},"description":"Return total count"}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List%20of%20versions%20of%20a%20template"}}}}}}},"/v4/pipelines/{id}/jobs/{jobName}/latestBuild":{"get":{"summary":"Get latest build for a given job","operationId":"getV4PipelinesIdJobsJobnameLatestbuild","description":"Return latest build of status specified","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true},{"name":"jobName","in":"path","schema":{"type":"string","description":"Name of the Job","example":"main","maxLength":110,"pattern":"^(PR-[0-9]+:)?(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"},"description":"Name of the Job","required":true},{"name":"status","in":"query","schema":{"type":"string","description":"Current status of the build","example":"SUCCESS","enum":["ABORTED","CREATED","FAILURE","QUEUED","RUNNING","SUCCESS","BLOCKED","UNSTABLE","COLLAPSED","FROZEN"]},"description":"Current status of the build"}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model22"}}}}}}},"/v4/templates/{name}/{versionOrTag}/usage/pipelines":{"get":{"summary":"Get information for the pipelines that are being used by a specific template version.","operationId":"getV4TemplatesNameVersionortagUsagePipelines","description":"Returns information aboout the pipelines using the template version.","parameters":[{"name":"name","in":"path","schema":{"type":"string","description":"Template name","example":"nodejs/lib","maxLength":64},"description":"Template name","required":true},{"name":"versionOrTag","in":"path","schema":{"anyOf":[{"type":"string","description":"Version of the Template","example":"1.2","maxLength":16,"pattern":"^(\\d+)(\\.\\d+)?(\\.\\d+)?$"},{"type":"string","description":"Name of the Template Tag","example":"latest","maxLength":30,"pattern":"^[a-zA-Z][\\w-.]+$"}]},"required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model48"}}}}}}},"/v4/builds":{"post":{"summary":"Create and start a build","operationId":"postV4Builds","description":"This api is deprecated, use POST /events instead","tags":["v4"],"security":[{"token":[]}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model49"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}},"deprecated":true}},"/v4/events":{"post":{"summary":"Create and start a event","operationId":"postV4Events","description":"Create and start a specific event","tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Create%20Event"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/processHooks":{"post":{"summary":"Handle process hook events","operationId":"postV4Processhooks","description":"Acts on pull request, pushes, comments, etc.","tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/secrets":{"post":{"summary":"Create a new secret","operationId":"postV4Secrets","description":"Create a specific secret","tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Create%20Secret"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/validator":{"post":{"summary":"Validate a given screwdriver.yaml","operationId":"postV4Validator","description":"Returns the parsed config or validation errors","tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Validation%20Input"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Execution%20information"}}}}}}},"/v4/webhooks":{"post":{"summary":"Handle webhook events","operationId":"postV4Webhooks","description":"Acts on pull request, pushes, comments, etc.","tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/auth/logout":{"post":{"summary":"Logout of screwdriver","operationId":"postV4AuthLogout","description":"Clears the cookie used for authentication","tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipeline/template":{"post":{"summary":"Create a new pipeline template","operationId":"postV4PipelineTemplate","description":"Create a specific pipeline template","tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certify%20input%20to%20template%20validator"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/validator/command":{"post":{"summary":"Validate a given sd-command.yaml","operationId":"postV4ValidatorCommand","description":"returns the parsed config, validation errors, or both","tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certify%20input%20to%20command%20validator"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Command%20validation%20output"}}}}}}},"/v4/validator/template":{"post":{"summary":"Validate a given sd-template.yaml","operationId":"postV4ValidatorTemplate","description":"returns the parsed config, validation errors, or both","tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certify%20input%20to%20template%20validator"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template%20validation%20output"}}}}}}},"/v4/builds/{id}/token":{"post":{"summary":"Generate a JWT for use throughout a given build","operationId":"postV4BuildsIdToken","description":"Generate a JWT for build using temporal JWT which passed in","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this build","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this build","required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSON%20Web%20Token%20Object"}}}}}}},"/v4/jobs/{id}/notify":{"post":{"summary":"Notify user about job status","operationId":"postV4JobsIdNotify","description":"Does nothing if notifaction setting was not set","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this Job","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this Job","required":true}],"tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model57"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipeline/template/validate":{"post":{"summary":"Validate a given sd-template.yaml","operationId":"postV4PipelineTemplateValidate","description":"returns the parsed config, validation errors, or both","tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Certify%20input%20to%20template%20validator"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template%20validation%20output"}}}}}}},"/v4/pipelines/{id}/openPr":{"post":{"summary":"Open pull request for repository","operationId":"postV4PipelinesIdOpenpr","description":"Open pull request","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true}],"tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model59"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipelines/{id}/startall":{"post":{"summary":"Start all child pipelines given a specific pipeline","operationId":"postV4PipelinesIdStartall","description":"Start all child pipelines given a specific pipeline","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipelines/{id}/sync":{"post":{"summary":"Sync a pipeline","operationId":"postV4PipelinesIdSync","description":"Sync a specific pipeline","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/builds/{id}/artifacts/unzip":{"post":{"summary":"Extract a ZIP for build artifacts","operationId":"postV4BuildsIdArtifactsUnzip","description":"Extract a specific ZIP for build artifacts","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this build","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this build","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipelines/{id}/sync/webhooks":{"post":{"summary":"Add webhooks or update webhooks if already exists","operationId":"postV4PipelinesIdSyncWebhooks","description":"Add or update Screwdriver API webhooks","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipelines/{id}/sync/pullrequests":{"post":{"summary":"Add or update pull request of a pipeline","operationId":"postV4PipelinesIdSyncPullrequests","description":"Add or update pull request jobs","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipelines/updateAdmins":{"put":{"summary":"Update admins for a collection of pipelines","operationId":"putV4PipelinesUpdateadmins","description":"Update the admins for a collection of pipelines","tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model63"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/tokens/{id}":{"put":{"summary":"Update a token","operationId":"putV4TokensId","description":"Update a specific token","parameters":[{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Update%20token%20metadata"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Remove a single token","operationId":"deleteV4TokensId","description":"Returns null if successful","parameters":[{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/collections/{id}/pipelines":{"put":{"summary":"Add one or more pipelines to the collection","operationId":"putV4CollectionsIdPipelines","description":"Returns null if successful","parameters":[{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true},{"name":"ids[]","in":"path","schema":{"anyOf":[{"type":"array","items":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"name":"ids[]"},{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}}]}}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Delete one or more pipelines from a collection","operationId":"deleteV4CollectionsIdPipelines","description":"Returns null if successful","parameters":[{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true},{"name":"ids[]","in":"path","schema":{"anyOf":[{"type":"array","items":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"name":"ids[]"},{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}}]}}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/events/{id}/stop":{"put":{"summary":"Stop all builds in an event","operationId":"putV4EventsIdStop","description":"Stop all builds in a specific event","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this event","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this event","required":true}],"tags":["v4"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Get%20Event"}}}}}}},"/v4/jobs/{id}/buildCluster":{"put":{"summary":"Update the buildCluster of a job","operationId":"putV4JobsIdBuildcluster","description":"Update the buildCluster of a specific job","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this Job","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this Job","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Delete the buildCluster override of a job","operationId":"deleteV4JobsIdBuildcluster","description":"Returns null if successful","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this Job","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this Job","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipelines/{id}/buildCluster":{"put":{"summary":"Update the buildCluster of a pipeline","operationId":"putV4PipelinesIdBuildcluster","description":"Update the buildCluster of a specific pipeline","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipelines/{id}/updateAdmins":{"put":{"summary":"Update admins of a pipeline","operationId":"putV4PipelinesIdUpdateadmins","description":"Update the admins of a specific pipeline","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/templates/{name}/trusted":{"put":{"summary":"Update a template's trusted property","operationId":"putV4TemplatesNameTrusted","description":"Returns null if successful","parameters":[{"name":"name","in":"path","schema":{"type":"string","description":"Template name","example":"nodejs/lib","maxLength":64},"description":"Template name","required":true}],"tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model64"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/tokens/{id}/refresh":{"put":{"summary":"Refresh a token","operationId":"putV4TokensIdRefresh","description":"Update the value of a token while preserving its other metadata","parameters":[{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/commands/{namespace}/{name}/trusted":{"put":{"summary":"Update a command's trusted property","operationId":"putV4CommandsNamespaceNameTrusted","description":"Returns null if successful","parameters":[{"name":"namespace","in":"path","schema":{"type":"string","description":"Namespace of the Command","example":"chefdk","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Namespace of the Command","required":true},{"name":"name","in":"path","schema":{"type":"string","description":"Name of the Command","example":"knife","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Name of the Command","required":true}],"tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model65"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipelines/{pipelineId}/tokens/{tokenId}":{"put":{"summary":"Update a token for pipeline","operationId":"putV4PipelinesPipelineidTokensTokenid","description":"Update a specific token for pipeline","parameters":[{"name":"pipelineId","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true},{"name":"tokenId","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Update%20token%20metadata"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Remove a single token for a specific pipeline","operationId":"deleteV4PipelinesPipelineidTokensTokenid","description":"Returns null if successful","parameters":[{"name":"pipelineId","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true},{"name":"tokenId","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/templates/{templateName}/tags/{tagName}":{"put":{"summary":"Add or update a template tag","operationId":"putV4TemplatesTemplatenameTagsTagname","description":"Add or update a specific template","parameters":[{"name":"templateName","in":"path","schema":{"type":"string","description":"Template name","example":"nodejs/lib","maxLength":64},"description":"Template name","required":true},{"name":"tagName","in":"path","schema":{"type":"string","description":"Name of the Template Tag","example":"latest","maxLength":30,"pattern":"^[a-zA-Z][\\w-.]+$"},"description":"Name of the Template Tag","required":true}],"tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model66"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Delete a template tag","operationId":"deleteV4TemplatesTemplatenameTagsTagname","description":"Delete a specific template","parameters":[{"name":"templateName","in":"path","schema":{"type":"string","description":"Template name","example":"nodejs/lib","maxLength":64},"description":"Template name","required":true},{"name":"tagName","in":"path","schema":{"type":"string","description":"Name of the Template Tag","example":"latest","maxLength":30,"pattern":"^[a-zA-Z][\\w-.]+$"},"description":"Name of the Template Tag","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/commands/{namespace}/{name}/tags/{tagName}":{"put":{"summary":"Add or update a command tag","operationId":"putV4CommandsNamespaceNameTagsTagname","description":"Add or update a specific command","parameters":[{"name":"namespace","in":"path","schema":{"type":"string","description":"Namespace of the Command","example":"chefdk","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Namespace of the Command","required":true},{"name":"name","in":"path","schema":{"type":"string","description":"Name of the Command","example":"knife","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Name of the Command","required":true},{"name":"tagName","in":"path","schema":{"type":"string","description":"Name of the Command Tag","example":"latest","maxLength":30,"pattern":"^[a-zA-Z][\\w-.]+$"},"description":"Name of the Command Tag","required":true}],"tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model67"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}},"delete":{"summary":"Delete a command tag","operationId":"deleteV4CommandsNamespaceNameTagsTagname","description":"Delete a specific command tag","parameters":[{"name":"namespace","in":"path","schema":{"type":"string","description":"Namespace of the Command","example":"chefdk","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Namespace of the Command","required":true},{"name":"name","in":"path","schema":{"type":"string","description":"Name of the Command","example":"knife","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Name of the Command","required":true},{"name":"tagName","in":"path","schema":{"type":"string","description":"Name of the Command Tag","example":"latest","maxLength":30,"pattern":"^[a-zA-Z][\\w-.]+$"},"description":"Name of the Command Tag","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipeline/templates/{namespace}/{name}/trusted":{"put":{"summary":"Update a pipeline template's trusted property","operationId":"putV4PipelineTemplatesNamespaceNameTrusted","description":"Returns null if successful","parameters":[{"name":"namespace","in":"path","schema":{"type":"string","description":"Namespace of the Template","example":"node","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Namespace of the Template","required":true},{"name":"name","in":"path","schema":{"type":"string","description":"Name of the template","example":"nodePipeline","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Name of the template","required":true}],"tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model68"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipelines/{pipelineId}/tokens/{tokenId}/refresh":{"put":{"summary":"Refresh a pipeline token","operationId":"putV4PipelinesPipelineidTokensTokenidRefresh","description":"Update the value of a token while preserving its other metadata","parameters":[{"name":"pipelineId","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true},{"name":"tokenId","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipeline/template/{namespace}/{name}/tags/{tag}":{"put":{"summary":"Add or update a pipeline template tag","operationId":"putV4PipelineTemplateNamespaceNameTagsTag","description":"Add or update a specific template","parameters":[{"name":"namespace","in":"path","schema":{"type":"string","description":"Namespace of the Template","example":"node","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Namespace of the Template","required":true},{"name":"name","in":"path","schema":{"type":"string","description":"Name of the template","example":"nodePipeline","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Name of the template","required":true},{"name":"tag","in":"path","schema":{"type":"string","description":"Name of the Template Tag","example":"latest","maxLength":30,"pattern":"^[a-zA-Z][\\w-.]+$"},"description":"Name of the Template Tag","required":true}],"tags":["v4"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model69"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipelines/{id}/caches":{"delete":{"summary":"API to delete cache using scope and id","operationId":"deleteV4PipelinesIdCaches","description":"Deletes the entire cache folder for pipeline, job or event using its id","parameters":[{"name":"id","in":"path","schema":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"description":"Identifier of this pipeline","required":true},{"name":"scope","in":"query","schema":{"type":"string","enum":["events","jobs","pipelines"]}},{"name":"cacheId","in":"query","schema":{"type":"integer","x-constraint":{"sign":"positive"}}}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipeline/templates/{namespace}/{name}":{"delete":{"summary":"Delete a pipeline template and its related versions and tags","operationId":"deleteV4PipelineTemplatesNamespaceName","description":"Returns null if successful","parameters":[{"name":"namespace","in":"path","schema":{"type":"string","description":"Namespace of the Template","example":"node","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Namespace of the Template","required":true},{"name":"name","in":"path","schema":{"type":"string","description":"Name of the template","example":"nodePipeline","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Name of the template","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/templates/{name}/versions/{version}":{"delete":{"summary":"Delete the specified version of template and the tags associated with it","operationId":"deleteV4TemplatesNameVersionsVersion","description":"Returns null if successful","parameters":[{"name":"name","in":"path","schema":{"type":"string","description":"Template name","example":"nodejs/lib","maxLength":64},"description":"Template name","required":true},{"name":"version","in":"path","schema":{"type":"string","description":"Exact version of the Template","example":"1.2.3","maxLength":16,"pattern":"^(\\d+)\\.(\\d+)\\.(\\d+)$"},"description":"Exact version of the Template","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/commands/{namespace}/{name}/versions/{version}":{"delete":{"summary":"Delete the specified version of commands and the tags associated with it","operationId":"deleteV4CommandsNamespaceNameVersionsVersion","description":"Returns null if successful","parameters":[{"name":"name","in":"path","schema":{"type":"string","description":"Name of the Command","example":"knife","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Name of the Command","required":true},{"name":"namespace","in":"path","schema":{"type":"string","description":"Namespace of the Command","example":"chefdk","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Namespace of the Command","required":true},{"name":"version","in":"path","schema":{"type":"string","description":"Version of the Command","example":"1.2","maxLength":16,"pattern":"^(\\d+)(\\.\\d+)?(\\.\\d+)?$"},"description":"Version of the Command","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipeline/templates/{namespace}/{name}/versions/{version}":{"delete":{"summary":"Delete the specified version of a pipeline template and the tags associated with it","operationId":"deleteV4PipelineTemplatesNamespaceNameVersionsVersion","description":"Returns null if successful","parameters":[{"name":"namespace","in":"path","schema":{"type":"string","description":"Namespace of the Template","example":"node","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Namespace of the Template","required":true},{"name":"name","in":"path","schema":{"type":"string","description":"Name of the template","example":"nodePipeline","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Name of the template","required":true},{"name":"version","in":"path","schema":{"type":"string","description":"Exact version of the template","example":"1.2.3","maxLength":16,"pattern":"^(\\d+)\\.(\\d+)\\.(\\d+)$"},"description":"Exact version of the template","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v4/pipeline/templates/{namespace}/{name}/tags/{tag}":{"delete":{"summary":"Delete a pipeline template tag","operationId":"deleteV4PipelineTemplatesNamespaceNameTagsTag","description":"Delete a specific pipeline template","parameters":[{"name":"namespace","in":"path","schema":{"type":"string","description":"Namespace of the Template","example":"node","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Namespace of the Template","required":true},{"name":"name","in":"path","schema":{"type":"string","description":"Name of the template","example":"nodePipeline","maxLength":64,"pattern":"^[\\w-]+$"},"description":"Name of the template","required":true},{"name":"tag","in":"path","schema":{"type":"string","description":"Name of the Template Tag","example":"latest","maxLength":30,"pattern":"^[a-zA-Z][\\w-.]+$"},"description":"Name of the Template Tag","required":true}],"tags":["v4"],"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}}},"x-alt-definitions":{"format":{"type":"string","description":"Format of the Command","example":"habitat","enum":["habitat","docker","binary"],"maxLength":16},"mode":{"type":"string","description":"Mode of the Habitat command","example":"remote","enum":["remote","local"]},"habitat":{"type":"object","properties":{"mode":{"$ref":"#/x-alt-definitions/mode"},"file":{"type":"string","description":"File path of the Habitat artifact","example":"./foobar.hart"},"package":{"type":"string","description":"Package of the Habitat command","example":"core/git/2.14.1"},"command":{"type":"string","description":"Executable of the Habitat command","example":"git"}},"required":["mode","file","package","command"]},"docker":{"type":"object","properties":{"image":{"type":"string","description":"Image of the Docker command","example":"chefdk:1.2.3"},"command":{"type":"string","description":"Executable of the Docker command","example":"knife","default":""}},"required":["image"]},"binary":{"type":"object","properties":{"file":{"type":"string","description":"File of the Binary command","example":"./foobar.sh"}},"required":["file"]},"clouds":{"type":"array","description":"A list of cloud that template supports","example":["aws","gcp","azure"],"items":{"type":"string"}},"architectures":{"type":"array","description":"A list of architectures that template supports","example":["x86","x86_64","arm64"],"items":{"type":"string"}},"compatibilities":{"type":"object","properties":{"clouds":{"$ref":"#/x-alt-definitions/clouds"},"architectures":{"$ref":"#/x-alt-definitions/architectures"}}},"Get Command":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this command","example":123345,"x-constraint":{"sign":"positive"}},"namespace":{"type":"string","description":"Namespace of the Command","example":"chefdk","maxLength":64,"pattern":"^[\\w-]+$"},"version":{"type":"string","description":"Version of the Command","example":"1.2","maxLength":16,"pattern":"^(\\d+)(\\.\\d+)?(\\.\\d+)?$"},"description":{"type":"string","description":"Description of the Command","example":"Installs npm modules","maxLength":256},"maintainer":{"type":"string","description":"Maintainer of the Command","example":"foo@bar.com","maxLength":64,"x-format":{"email":true}},"format":{"$ref":"#/x-alt-definitions/format"},"habitat":{"$ref":"#/x-alt-definitions/habitat"},"docker":{"$ref":"#/x-alt-definitions/docker"},"binary":{"$ref":"#/x-alt-definitions/binary"},"name":{"type":"string","description":"Name of the Command","example":"knife","maxLength":64,"pattern":"^[\\w-]+$"},"pipelineId":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"createTime":{"type":"string","description":"When this command was created","example":"2038-01-19T03:14:08.131Z","maxLength":32,"x-format":{"isoDate":true}},"usage":{"type":"string","description":"Usage and arguments of the command","example":"sd_cmd exec foo/bar@1 -h <host> -d <domain>","maxLength":4096},"trusted":{"type":"boolean","description":"Mark whether command is trusted"},"latest":{"type":"boolean","description":"Whether this is latest version"},"compatibilities":{"$ref":"#/x-alt-definitions/compatibilities"}},"required":["id","namespace","version","description","maintainer","format","name","pipelineId"]},"List of commands":{"type":"array","items":{"$ref":"#/x-alt-definitions/Get%20Command"}},"Model1":{"type":"object","properties":{"namespace":{"type":"string","description":"Namespace of the Command","example":"chefdk","maxLength":64,"pattern":"^[\\w-]+$"}}},"Model2":{"type":"array","items":{"$ref":"#/x-alt-definitions/Model1"}},"Command Count and List of commands":{"type":"object","properties":{"count":{"type":"number"},"rows":{"$ref":"#/x-alt-definitions/List of commands"}}},"any":{"type":"array","items":{"type":"string"}},"value":{"type":"array","items":{"type":"string"}},"Model3":{"type":"object","properties":{"value":{"anyOf":[{"type":"string"},{"$ref":"#/x-alt-definitions/value"}]},"description":{"type":"string"}},"required":["value"]},"Model4":{"type":"string","enum":["OK"]},"Model5":{"type":"object","properties":{"queue":{"type":"string"},"store":{"type":"string"},"api":{"type":"string"}}},"labels":{"type":"array","description":"Labels for template","example":["stable","latest","beta"],"items":{"type":"string"}},"annotations":{"type":"object"},"blockedBy":{"type":"array","items":{"anyOf":[{"type":"string","pattern":"^~([\\w-]+)$"},{"type":"string","pattern":"^~sd@(\\d+):(?:([\\w-]+)|(stage@([\\w-]+):setup))$"}]}},"freezeWindows":{"type":"array","items":{"type":"string"}},"string":{"type":"array","items":{"type":"string"}},"order":{"type":"array","minItems":0,"items":{"type":"string","pattern":"^[\\w-]+$"}},"name":{"type":"string","description":"Provider name","example":"aws","enum":["aws"],"maxLength":64},"List of security group IDs":{"type":"array","minItems":1,"items":{"type":"string","description":"Security group ID","example":"sg-51530134","maxLength":128,"pattern":"^sg-[\\w]+$"}},"List of subnet IDs":{"type":"array","minItems":1,"items":{"type":"string","description":"Subnet ID","example":"subnet-01234567890abcdef","maxLength":128,"pattern":"^subnet-[\\w]+$"}},"vpc":{"type":"object","properties":{"vpcId":{"type":"string","description":"VPC ID","example":"vpc-1a2b3c4d","maxLength":128,"pattern":"^vpc-[\\w]+$"},"securityGroupIds":{"$ref":"#/x-alt-definitions/List%20of%20security%20group%20IDs"},"subnetIds":{"$ref":"#/x-alt-definitions/List%20of%20subnet%20IDs"}},"required":["vpcId","securityGroupIds","subnetIds"]},"executor":{"type":"string","description":"Executor name","example":"eks","enum":["sls","eks"],"maxLength":64},"computeType":{"type":"string","description":"CodeBuild compute type","default":"BUILD_GENERAL1_SMALL","enum":["BUILD_GENERAL1_SMALL","BUILD_GENERAL1_LARGE","BUILD_GENERAL1_MEDIUM","BUILD_GENERAL1_2XLARGE"]},"environmentType":{"type":"string","description":"CodeBuild environment type","default":"LINUX_CONTAINER","enum":["ARM_CONTAINER","LINUX_CONTAINER","LINUX_GPU_CONTAINER"]},"provider":{"type":"object","properties":{"name":{"$ref":"#/x-alt-definitions/name"},"region":{"type":"string","description":"Region where service and build will run, build region can be overridden","example":"us-west-2","default":"us-west-2","maxLength":64,"pattern":"^(us(-gov)?|ap|ca|cn|eu|sa|me)-(central|(north|south)?(east|west)?)-\\d$"},"buildRegion":{"type":"string","description":"Region where builds will run if different from service region","example":"us-east-2","default":"","maxLength":64,"pattern":"^(us(-gov)?|ap|ca|cn|eu|sa|me)-(central|(north|south)?(east|west)?)-\\d$"},"accountId":{"description":"Account ID","example":"123456789012","anyOf":[{"type":"string","maxLength":12,"pattern":"^[0-9]{12}$"},{"type":"integer","minimum":12}]},"vpc":{"$ref":"#/x-alt-definitions/vpc"},"role":{"type":"string","description":"Role ARN","example":"arn:aws:iam::123456789012:role/aws-service-role/amazonaws.com/AWSServiceRole","maxLength":512,"pattern":"^arn:aws:iam::\\d{12}:role\\/.+"},"executor":{"$ref":"#/x-alt-definitions/executor"},"clusterName":{"type":"string","description":"Cluster name required if executor is eks","example":"sd-build-eks","maxLength":128},"cpuLimit":{"type":"string","description":"CPU Limit for pod in EKS Cluster","example":"2Gi","maxLength":4},"memoryLimit":{"type":"string","description":"Memory Limit for pod in EKS Cluster","example":"4Gi","maxLength":4},"executorLogs":{"type":"boolean","description":"Enable debug logs for executor codebuild","default":false},"launcherImage":{"type":"string","description":"Screwdriver launcher image in user Registry","example":"123456789012.dkr.ecr.us-east-2.amazonaws.com/screwdriver-hub:launcherv6.4"},"launcherVersion":{"type":"string","description":"Screwdriver launcher version","example":"v6.4"},"privilegedMode":{"type":"boolean","description":"Enable privileged mode for container","default":false},"computeType":{"$ref":"#/x-alt-definitions/computeType"},"environmentType":{"$ref":"#/x-alt-definitions/environmentType"},"debugSession":{"type":"boolean","description":"Enable debug session inside build container","default":false}}},"requires":{"type":"array","items":{"anyOf":[{"type":"string","pattern":"^~([\\w-]+)$"},{"type":"string","maxLength":100,"pattern":"^(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"},{"type":"string"},{"type":"string","pattern":"^~?stage@([\\w-]+)(?::([\\w-]+))?$"},{"type":"string","pattern":"^~?sd@\\d+:(?:([\\w-]+)|(stage@([\\w-]+):(setup|teardown)))$"}]}},"secrets":{"type":"array","minItems":0,"items":{"type":"string","maxLength":64,"pattern":"^[A-Z_][A-Z0-9_]*$"}},"settings":{"type":"object"},"sourcePaths":{"type":"array","items":{"type":"string","maxLength":1024}},"Model6":{"type":"object","properties":{"command":{"type":"string"},"locked":{"type":"boolean"}},"required":["command"]},"steps":{"type":"array","minItems":1,"items":{"anyOf":[{"type":"string"},{"type":"object","properties":{"string":{"anyOf":[{"type":"string"},{"$ref":"#/x-alt-definitions/Model6"}]}}}]}},"config":{"type":"object","default":{},"properties":{"annotations":{"$ref":"#/x-alt-definitions/annotations"},"blockedBy":{"anyOf":[{"$ref":"#/x-alt-definitions/blockedBy"},{"anyOf":[{"type":"string","pattern":"^~([\\w-]+)$"},{"type":"string","pattern":"^~sd@(\\d+):(?:([\\w-]+)|(stage@([\\w-]+):setup))$"}]}]},"cache":{"type":"boolean"},"description":{"type":"string","maxLength":100},"environment":{"type":"object","properties":{"string":{"type":"string"}}},"freezeWindows":{"anyOf":[{"$ref":"#/x-alt-definitions/freezeWindows"},{"type":"string"}]},"image":{"type":"string","pattern":"^[^;&|><*?`$()!#'\" ]+$"},"matrix":{"type":"object","properties":{"string":{"$ref":"#/x-alt-definitions/string"}}},"order":{"$ref":"#/x-alt-definitions/order"},"parameters":{"type":"object","properties":{"any":{"anyOf":[{"type":"string"},{"$ref":"#/x-alt-definitions/any"},{"$ref":"#/x-alt-definitions/Model3"}]}}},"provider":{"anyOf":[{"$ref":"#/x-alt-definitions/provider"},{"type":"string","pattern":"^(?:(?:https:\\/\\/(?:[^@/:\\s]+@)?)|git@|org-\\d+@)+([^/:\\s]+)(?:\\/|:)([^/:\\s]+)\\/([^\\s]+?)(?:\\.git)(#[^:　\\s]*　[^:　\\s]*|#[^:　\\s]+)?(:[^:　\\s]*　[^:　\\s]*|:[^:　\\s]+)?$"}]},"requires":{"anyOf":[{"$ref":"#/x-alt-definitions/requires"},{"anyOf":[{"type":"string","pattern":"^~([\\w-]+)$"},{"type":"string","maxLength":100,"pattern":"^(([\\w-]+)|(?:stage@([\\w-]+):(setup|teardown)))$"},{"type":"string"},{"type":"string","pattern":"^~?stage@([\\w-]+)(?::([\\w-]+))?$"},{"type":"string","pattern":"^~?sd@\\d+:(?:([\\w-]+)|(stage@([\\w-]+):(setup|teardown)))$"}]}]},"secrets":{"$ref":"#/x-alt-definitions/secrets"},"settings":{"$ref":"#/x-alt-definitions/settings"},"sourcePaths":{"anyOf":[{"$ref":"#/x-alt-definitions/sourcePaths"},{"type":"string","maxLength":1024}]},"template":{"type":"string","pattern":"^([\\w/-]+)(?:@((?:(?:\\d+)(?:\\.\\d+)?(?:\\.\\d+)?)|(?:[a-zA-Z][\\w-.]+)))?$"},"templateId":{"type":"integer","description":"Identifier for this job's template","example":123345,"nullable":true,"x-constraint":{"sign":"positive"}},"steps":{"$ref":"#/x-alt-definitions/steps"}}},"Get Template":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this template","example":123345,"x-constraint":{"sign":"positive"}},"labels":{"$ref":"#/x-alt-definitions/labels"},"config":{"$ref":"#/x-alt-definitions/config"},"name":{"type":"string","description":"Template name","example":"nodejs/lib","maxLength":64},"version":{"type":"string","description":"Version of the Template","example":"1.2","maxLength":16,"pattern":"^(\\d+)(\\.\\d+)?(\\.\\d+)?$"},"description":{"type":"string","description":"Description of the Template","example":"Installs npm modules","maxLength":256},"maintainer":{"type":"string","description":"Maintainer of the Template","example":"foo@bar.com","maxLength":64,"x-format":{"email":true}},"pipelineId":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"namespace":{"type":"string","description":"Namespace of the Template","example":"node","maxLength":64,"pattern":"^[\\w-]+$"},"images":{"type":"object","properties":{"string":{"type":"string","pattern":"^[^;&|><*?`$()!#'\" ]+$"}}},"createTime":{"type":"string","description":"When this template was created","example":"2038-01-19T03:14:08.131Z","maxLength":32,"x-format":{"isoDate":true}},"trusted":{"type":"boolean","description":"Mark whether template is trusted"},"latest":{"type":"boolean","description":"Whether this is latest version"},"compatibilities":{"$ref":"#/x-alt-definitions/compatibilities"}},"required":["id","labels","name","version","description","maintainer","pipelineId"]},"List of templates":{"type":"array","items":{"$ref":"#/x-alt-definitions/Get%20Template"}},"Model7":{"type":"object","properties":{"namespace":{"type":"string","description":"Namespace of the Template","example":"node","maxLength":64,"pattern":"^[\\w-]+$"}}},"Model8":{"type":"array","items":{"$ref":"#/x-alt-definitions/Model7"}},"Template Count and List of templates":{"type":"object","properties":{"count":{"type":"number"},"rows":{"$ref":"#/x-alt-definitions/List of templates"}}},"environment":{"type":"array","items":{"type":"object","properties":{"string":{"type":"string"}}}},"parentBuildId":{"type":"array","description":"Identifier(s) of this parent build(s)","example":[111,222],"items":{"type":"integer","x-constraint":{"sign":"positive"}}},"templateType":{"type":"string","description":"Template Type","example":"PIPELINE","default":"JOB","enum":["JOB","PIPELINE"],"maxLength":16},"Model9":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier of this template","example":123345,"x-constraint":{"sign":"positive"}},"pipelineId":{"type":"integer","description":"Identifier of this pipeline","example":123345,"x-constraint":{"sign":"positive"}},"namespace":{"type":"string","description":"Namespace of the Template","example":"node","maxLength":64,"pattern":"^[\\w-]+$"},"name":{"type":"string","description":"Name of the template","example":"nodePipeline","maxLength":64,"pattern":"^[\\w-]+$"},"maintainer":{"type":"string","description":"Maintainer of the Template","example":"foo@bar.com","maxLength":64,"x-format":{"email":true}},"trustedSinceVersion":{"type":"string","description":"The version since the template is marked as trusted","example":"1.2.3","maxLength":16,"pattern":"^(\\d+)\\.(\\d+)\\.(\\d+)$"},"latestVersion":{"type":"string","description":"Latest version of the template","example":"1.2.3","maxLength":16,"pattern":"^(\\d+)\\.(\\d+)\\.(\\d+)$"},"createTime":{"type":"string","description":"When this template was created","example":"2038-01-19T03:14:08.131Z","maxLength":32,"x-format":{"isoDate":true}},"updateTime":{"type":"string","description":"When this template was updated","example":"2038-01-19T03:14:08.131Z","maxLength":32,"x-format":{"isoDate":true}},"templateType":{"$ref":"#/x-alt-definitions/templateType"}},"required":["id","pipelineId","namespace","name","maintainer","templateType"]},"List of pipeline templates":{"type":"array","items":{"$ref":"#/x-alt-definitions/Model9"}},"Pipeline Template Count and List of templates":{"type":"object","properties":{"count":{"type":"number"},"rows":{"$ref":"#/x-alt-definitions/List of pipeline templates"}}},"Model10":{"type":"object","properties":{"command":{"type":"string"}},"required":["command"]}}}