Validate Workflow YAML

POST 
/api/v8/repos/:owner/:repo/actions/workflows/validate

Request

Path Parameters

owner stringrequired

Repository space address (organization or individual's address path)

repo stringrequired

Repository path (path)

Query Parameters

access_token stringrequired

User authorization code

application/json

Bodyrequired

base64_contentstringrequired

SGVsbG8gd29ybGQ=

Responses

200

Response Headers

application/json

Schema

Schema

validbooleanrequired
Verification Result
diagnostics object[]required
Failure Cause
Array [
range object
start objectrequired
lineintegerrequired
columnintegerrequired
end objectrequired
lineintegerrequired
columnintegerrequired
severitystring
messagestring
]

Example (auto)

{
  "valid": true,
  "diagnostics": [
    {
      "range": {
        "start": {
          "line": 0,
          "column": 0
        },
        "end": {
          "line": 0,
          "column": 0
        }
      },
      "severity": "string",
      "message": "string"
    }
  ]
}