From 539b4a10a0256eafa0b8c9f1cccdadf6e95c1e1f Mon Sep 17 00:00:00 2001 From: Jasder <2053003901@@qq.com> Date: Fri, 4 Dec 2020 18:15:19 +0800 Subject: [PATCH] Upate README.md --- README.md | 13 +++++++++++++ api_document.md | 16 ++++++++-------- 2 files changed, 21 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6f8fc270a..d6b0abc93 100644 --- a/README.md +++ b/README.md @@ -110,3 +110,16 @@ http://localhost:3000/ - 里程碑 ![](docs/figs/milestone.png) + +### API +- [API](api_document.md) + +## 贡献代码 + +1. Fork 项目 +2. 创建本地分支(git checkout -b my-new-feature) +3. 提交更改 (git commit -am 'Add some feature') +4. 推送到分支 (git push origin my-new-feature) +5. 向源项目的 **develop** 分支发起 Pull Request + +## License diff --git a/api_document.md b/api_document.md index 59139cb73..50a45573c 100644 --- a/api_document.md +++ b/api_document.md @@ -7,7 +7,7 @@ ### 开发API服务地址： -**https://testgitea.trustie.net/** +**** 响应状态说明: @@ -2679,7 +2679,7 @@ http://localhost:3000/api/trustie/truesite/protected_branches.json | jq |enable_status_check |否|boolean |是否启用状态检查, true: 启用; false: 不启用, 默认为false | |required_approvals |否|int |所需的批准数， 默认为0 | |enable_approvals_whitelist |否|boolean |是否启用批准仅限列入白名单的用户或团队, true: 启用, false: 不启用, 默认为false | -|approvals_whitelist_username |否|array |审查者白名单(即具有写操作的项目成员名称的数组), 该参数与enable_approvals_whitelist配合使用 | +|approvals_whitelist_usernames |否|array |审查者白名单(即具有写操作的项目成员名称的数组), 该参数与enable_approvals_whitelist配合使用 | |block_on_rejected_reviews |否|boolean |是否启用拒绝审核阻止合并功能, true: 启用, false: 不启用, 默认为false | |dismiss_stale_approvals |否|boolean |是否启用取消过时的批准, true: 启用, false: 不启用, 默认为false | |require_signed_commits |否|boolean |是否需要签名提交, true: 是, false: 否, 默认为false | @@ -2698,7 +2698,7 @@ http://localhost:3000/api/trustie/truesite/protected_branches.json | jq |enable_status_check |boolean |是否启用状态检查, true: 启用; false: 不启用, 默认为false | |required_approvals |int |所需的批准数， 默认为0 | |enable_approvals_whitelist |boolean |是否启用批准仅限列入白名单的用户或团队, true: 启用, false: 不启用, 默认为false | -|approvals_whitelist_username |array |审查者白名单(即具有写操作的项目成员名称的数组), 该参数与enable_approvals_whitelist配合使用 | +|approvals_whitelist_usernames |array |审查者白名单(即具有写操作的项目成员名称的数组), 该参数与enable_approvals_whitelist配合使用 | |block_on_rejected_reviews |boolean |是否启用拒绝审核阻止合并功能, true: 启用, false: 不启用, 默认为false | |dismiss_stale_approvals |boolean |是否启用取消过时的批准, true: 启用, false: 不启用, 默认为false | |require_signed_commits |boolean |是否需要签名提交, true: 是, false: 否, 默认为false | @@ -2765,7 +2765,7 @@ http://localhost:3000/api/trustie/truesite/protected_branches/master/edit.json | |enable_status_check |boolean |是否启用状态检查, true: 启用; false: 不启用, 默认为false | |required_approvals |int |所需的批准数， 默认为0 | |enable_approvals_whitelist |boolean |是否启用批准仅限列入白名单的用户或团队, true: 启用, false: 不启用, 默认为false | -|approvals_whitelist_username |array |审查者白名单(即具有写操作的项目成员名称的数组), 该参数与enable_approvals_whitelist配合使用 | +|approvals_whitelist_usernames |array |审查者白名单(即具有写操作的项目成员名称的数组), 该参数与enable_approvals_whitelist配合使用 | |block_on_rejected_reviews |boolean |是否启用拒绝审核阻止合并功能, true: 启用, false: 不启用, 默认为false | |dismiss_stale_approvals |boolean |是否启用取消过时的批准, true: 启用, false: 不启用, 默认为false | |require_signed_commits |boolean |是否需要签名提交, true: 是, false: 否, 默认为false | @@ -2832,7 +2832,7 @@ http://localhost:3000/api/trustie/truesite/protected_branches/master.json | jq |enable_status_check |否|boolean |是否启用状态检查, true: 启用; false: 不启用, 默认为false | |required_approvals |否|int |所需的批准数， 默认为0 | |enable_approvals_whitelist |否|boolean |是否启用批准仅限列入白名单的用户或团队, true: 启用, false: 不启用, 默认为false | -|approvals_whitelist_username |否|array |审查者白名单(即具有写操作的项目成员名称的数组), 该参数与enable_approvals_whitelist配合使用 | +|approvals_whitelist_usernames |否|array |审查者白名单(即具有写操作的项目成员名称的数组), 该参数与enable_approvals_whitelist配合使用 | |block_on_rejected_reviews |否|boolean |是否启用拒绝审核阻止合并功能, true: 启用, false: 不启用, 默认为false | |dismiss_stale_approvals |否|boolean |是否启用取消过时的批准, true: 启用, false: 不启用, 默认为false | |require_signed_commits |否|boolean |是否需要签名提交, true: 是, false: 否, 默认为false | @@ -2851,7 +2851,7 @@ http://localhost:3000/api/trustie/truesite/protected_branches/master.json | jq |enable_status_check |boolean |是否启用状态检查, true: 启用; false: 不启用, 默认为false | |required_approvals |int |所需的批准数， 默认为0 | |enable_approvals_whitelist |boolean |是否启用批准仅限列入白名单的用户或团队, true: 启用, false: 不启用, 默认为false | -|approvals_whitelist_username |array |审查者白名单(即具有写操作的项目成员名称的数组), 该参数与enable_approvals_whitelist配合使用 | +|approvals_whitelist_usernames |array |审查者白名单(即具有写操作的项目成员名称的数组), 该参数与enable_approvals_whitelist配合使用 | |block_on_rejected_reviews |boolean |是否启用拒绝审核阻止合并功能, true: 启用, false: 不启用, 默认为false | |dismiss_stale_approvals |boolean |是否启用取消过时的批准, true: 启用, false: 不启用, 默认为false | |require_signed_commits |boolean |是否需要签名提交, true: 是, false: 否, 默认为false | @@ -2955,7 +2955,7 @@ http://localhost:3000/api/trustie/truesite/protected_branches.json | jq |enable_status_check |boolean |是否启用状态检查, true: 启用; false: 不启用, 默认为false | |required_approvals |int |所需的批准数， 默认为0 | |enable_approvals_whitelist |boolean |是否启用批准仅限列入白名单的用户或团队, true: 启用, false: 不启用, 默认为false | -|approvals_whitelist_username |array |审查者白名单(即具有写操作的项目成员名称的数组), 该参数与enable_approvals_whitelist配合使用 | +|approvals_whitelist_usernames |array |审查者白名单(即具有写操作的项目成员名称的数组), 该参数与enable_approvals_whitelist配合使用 | |block_on_rejected_reviews |boolean |是否启用拒绝审核阻止合并功能, true: 启用, false: 不启用, 默认为false | |dismiss_stale_approvals |boolean |是否启用取消过时的批准, true: 启用, false: 不启用, 默认为false | |require_signed_commits |boolean |是否需要签名提交, true: 是, false: 否, 默认为false | @@ -3027,7 +3027,7 @@ http://localhost:3000/api/trustie/truesite/protected_branches/master.json | jq |enable_status_check |boolean |是否启用状态检查, true: 启用; false: 不启用, 默认为false | |required_approvals |int |所需的批准数， 默认为0 | |enable_approvals_whitelist |boolean |是否启用批准仅限列入白名单的用户或团队, true: 启用, false: 不启用, 默认为false | -|approvals_whitelist_username |array |审查者白名单(即具有写操作的项目成员名称的数组), 该参数与enable_approvals_whitelist配合使用 | +|approvals_whitelist_usernames |array |审查者白名单(即具有写操作的项目成员名称的数组), 该参数与enable_approvals_whitelist配合使用 | |block_on_rejected_reviews |boolean |是否启用拒绝审核阻止合并功能, true: 启用, false: 不启用, 默认为false | |dismiss_stale_approvals |boolean |是否启用取消过时的批准, true: 启用, false: 不启用, 默认为false | |require_signed_commits |boolean |是否需要签名提交, true: 是, false: 否, 默认为false |