设置项目推送规则¶

PUT /api/v5/repos/{owner}/{repo}/push_config

用户调用此接口,进行设置项目推送规则操作。

访问令牌支持说明¶

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

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

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

Request Body:

请求体为 JSON（Content-Type: application/json），也支持表单提交（application/x-www-form-urlencoded / multipart/form-data）。仅需提交需要修改的规则字段，其余字段留空即可。

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "reject_not_signed_by_gpg": {
      "description": "只允许带有验证的签名提交",
      "type": "boolean"
    },
    "commit_message_regex": {
      "description": "提交信息校验（正则表达式）",
      "type": "string"
    },
    "max_file_size": {
      "description": "提交文件限制 （单位 MB）",
      "type": "integer",
      "format": "int64"
    },
    "skip_rule_for_owner": {
      "description": "项目管理员的提交不受上述规则限制",
      "type": "boolean"
    },
    "deny_force_push": {
      "description": "禁止强推（包括管理员）",
      "type": "boolean"
    }
  }
}

响应参数¶

字段	类型	必返	可为空	说明
`reject_not_signed_by_gpg`	boolean	否	是	只允许带有验证的签名提交
`commit_message_regex`	string	否	是	提交信息校验
`max_file_size`	integer	否	是	提交文件限制（单位 MB）
`skip_rule_for_owner`	boolean	否	是	项目管理员的提交不受上述规则限制
`deny_force_push`	boolean	否	是	禁止强推（包括管理员）

失败响应¶

400 参数错误

{
  "error": "invalid_request",
  "message": "请求体解析失败或不支持的请求类型 content-type"
}

401 未认证

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

403 无权限

{
  "error": "forbidden",
  "message": "当前用户无权设置该项目推送规则"
}

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`400`	请求参数错误或请求体解析失败
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden），当前用户无操作权限
`404`	请求路径不存在
`405`	请求方法不支持
`429`	请求过于频繁，触发限流
`500`	系统内部错误

请求示例¶

参数说明¶

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

cURL¶

curl -X PUT 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/push_config?access_token=<token>' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "reject_not_signed_by_gpg": false,
    "commit_message_regex": "",
    "max_file_size": 10,
    "skip_rule_for_owner": false,
    "deny_force_push": true
  }'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch("https://api.atomgit.com/api/v5/repos/<owner>/<repo>/push_config?access_token=<token>", {
  method: "PUT",
  headers: {
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    reject_not_signed_by_gpg: false,
    commit_message_regex: "",
    max_file_size: 10,
    skip_rule_for_owner: false,
    deny_force_push: true,
  }),
});

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

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

Python¶

import requests

resp = requests.put(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/push_config",
    params={"access_token": "<token>"},
    json={
        "reject_not_signed_by_gpg": False,
        "commit_message_regex": "",
        "max_file_size": 10,
        "skip_rule_for_owner": False,
        "deny_force_push": True,
    },
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{
  "reject_not_signed_by_gpg": false,
  "deny_force_push": true,
  "max_file_size": 10,
  "skip_rule_for_owner": false
}

错误码¶

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

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