校验 Workflow YAML¶

POST /api/v8/repos/{owner}/{repo}/actions/workflows/validate

用户调用此接口，进行校验 Workflow YAML 操作。

访问令牌支持说明¶

AtomGit 用户访问令牌（AtomGit user access tokens）

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址(组织或个人的地址path)
`repo`	path	string	是	仓库路径(path)
`access_token`	query	string	是	用户授权码

Request Body:

请求体为 JSON 对象，包含一个必填字段 base64_content：

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "base64_content": {
      "description": "yaml文件内容，需要base64编码",
      "type": "string"
    }
  },
  "required": ["base64_content"]
}

响应参数¶

字段	类型	必返	可为空	说明
`valid`	boolean	是	否	校验结果
`diagnostics`	object[]	是	否	失败原因

diagnostics 对象

字段	类型	必返	可为空	说明
`diagnostics.range`	object	是	否	错误位置范围
`diagnostics.severity`	string	否	是	严重程度
`diagnostics.message`	string	否	是	错误信息

`diagnostics.range` 对象¶

字段	类型	必返	可为空	说明
`diagnostics.range.start`	object	是	否	错误起始位置
`diagnostics.range.end`	object	是	否	错误结束位置

`diagnostics.range.start` 对象¶

字段	类型	必返	可为空	说明
`diagnostics.range.start.line`	integer	是	否	起始行号
`diagnostics.range.start.column`	integer	是	否	起始列号

`diagnostics.range.end` 对象¶

字段	类型	必返	可为空	说明
`diagnostics.range.end.line`	integer	是	否	结束行号
`diagnostics.range.end.column`	integer	是	否	结束列号

失败响应¶

该接口无文档化的业务失败响应。以下仅为框架/网关层可能返回的通用失败形态，错误字段名以后端实际返回为准。

400 参数错误

{
  "error": "invalid_request",
  "message": "参数 base64_content 不能为空"
}

401 未认证

{
  "error": "unauthorized",
  "message": "缺少或无效的访问令牌"
}

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`400`	参数错误或请求无法解析
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	请求路径不存在
`500`	系统内部错误

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址（组织或个人的地址 path）； <repo> 替换为仓库路径（path）； <token> 替换为你的 AtomGit 用户访问令牌。

cURL¶

curl -X POST 'https://api.atomgit.com/api/v8/repos/<owner>/<repo>/actions/workflows/validate?access_token=<token>' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{"base64_content":"bmFtZTogdGVzdA=="}'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const token = "<YOUR-TOKEN>";
const base64Content = btoa("name: test");

const response = await fetch(
  `https://api.atomgit.com/api/v8/repos/<owner>/<repo>/actions/workflows/validate?access_token=${token}`,
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "Accept": "application/json",
    },
    body: JSON.stringify({ base64_content: base64Content }),
  }
);

if (!response.ok) {
  throw new Error(`请求失败: ${response.status}`);
}

const data = await response.json();
console.log(data);

Python¶

import requests

resp = requests.post(
    "https://api.atomgit.com/api/v8/repos/<owner>/<repo>/actions/workflows/validate",
    params={"access_token": "<YOUR-TOKEN>"},
    json={"base64_content": "bmFtZTogdGVzdA=="},
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "valid": true,
  "diagnostics": [
    {
      "range": {
        "start": {
          "line": 1,
          "column": 1
        },
        "end": {
          "line": 1,
          "column": 5
        }
      },
      "severity": "error",
      "message": "syntax error"
    }
  ]
}

错误码¶

错误码	说明
`400`	参数错误或请求无法解析
`401`	未认证或凭证无效（缺少/无效的访问凭证）
`403`	禁止访问
`404`	请求路径不存在
`429`	请求过于频繁，触发限流
`500`	系统内部错误

本页原文 Markdown：在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc