From 60b3c7925d71ba4f6cb92d4167d446b54efba501 Mon Sep 17 00:00:00 2001 From: yystopf Date: Tue, 30 Aug 2022 10:34:37 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=B0=E5=A2=9E=EF=BC=9A=E6=B7=BB=E5=8A=A0?= =?UTF-8?q?=E5=85=A8=E9=83=A8=E6=88=96=E8=80=85=E7=A7=BB=E9=99=A4=E5=85=A8?= =?UTF-8?q?=E9=83=A8=E5=9B=A2=E9=98=9F=E9=A1=B9=E7=9B=AE[=E6=96=87?= =?UTF-8?q?=E6=A1=A3]?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- app/docs/slate/source/includes/_teams.md | 77 ++++++++++++++++ public/docs/api.html | 106 ++++++++++++++++++++++- 2 files changed, 182 insertions(+), 1 deletion(-) diff --git a/app/docs/slate/source/includes/_teams.md b/app/docs/slate/source/includes/_teams.md index c50f6973..eaaf6bf6 100644 --- a/app/docs/slate/source/includes/_teams.md +++ b/app/docs/slate/source/includes/_teams.md @@ -1 +1,78 @@ # Teams + +## 团队下新增所有的项目 +团队下新增所有的项目 + +> 示例: + +```shell +curl -X POST \ +http://localhost:3000/api/organizations/ceshi_org/teams/28/team_projects/create_all +``` + +```javascript +await octokit.request('POST /api/organizations/ceshi_org/teams/28/team_projects/create_all.json') +``` + +### HTTP 请求 +`POST /api/organizations/:organization/teams/:id/team_projects/create_all.json` + +### 请求参数: +参数 | 必选 | 默认 | 类型 | 字段说明 +--------- | ------- | ------- | -------- | ---------- +|organization |是| | string |组织标识 | +|id |是| | integer|团队 ID| + +### 返回字段说明: + + +> 返回的JSON示例: + +```json +{ + "status": 0, + "message": "success" +} +``` + + + +## 团队下删除所有的项目 +团队下删除所有的项目 + +> 示例: + +```shell +curl -X DELETE \ +http://localhost:3000/api/organizations/ceshi_org/teams/28/team_projects/destroy_all +``` + +```javascript +await octokit.request('DELETE /api/organizations/ceshi_org/teams/28/team_projects/destroy_all.json') +``` + +### HTTP 请求 +`DELETE /api/organizations/:organization/teams/:id/team_projects/destroy_all.json` + +### 请求参数: +参数 | 必选 | 默认 | 类型 | 字段说明 +--------- | ------- | ------- | -------- | ---------- +|organization |是| | string |组织标识 | +|id |是| | integer|团队 ID| + +### 返回字段说明: + + +> 返回的JSON示例: + +```json +{ + "status": 0, + "message": "success" +} +``` + \ No newline at end of file diff --git a/public/docs/api.html b/public/docs/api.html index c43f7c40..b4127232 100644 --- a/public/docs/api.html +++ b/public/docs/api.html @@ -646,6 +646,14 @@
  • Teams +
  • Errors @@ -15446,7 +15454,103 @@ http://localhost:3000/api/v1/yystopf/ceshi/pulls/1/journals/200.json -

    Issues

    Organizations

    Teams

    Errors

    +

    Issues

    Organizations

    Teams

    团队下新增所有的项目

    +

    团队下新增所有的项目

    + +
    +

    示例:

    +
    +
    curl -X POST \
+http://localhost:3000/api/organizations/ceshi_org/teams/28/team_projects/create_all
+
    await octokit.request('POST /api/organizations/ceshi_org/teams/28/team_projects/create_all.json')
+

    HTTP 请求

    +

    POST /api/organizations/:organization/teams/:id/team_projects/create_all.json

    +

    请求参数:

    + + + + + + + + + + + + + + + + + + + + + + + +
    参数必选默认类型字段说明
    organization是string组织标识
    id是integer团队 ID
    +

    返回字段说明:

    +
    +

    返回的JSON示例:

    +
    +
    {
+    "status": 0,
+    "message": "success"
+}
+
    + +

    团队下删除所有的项目

    +

    团队下删除所有的项目

    + +
    +

    示例:

    +
    +
    curl -X DELETE \
+http://localhost:3000/api/organizations/ceshi_org/teams/28/team_projects/destroy_all
+
    await octokit.request('DELETE /api/organizations/ceshi_org/teams/28/team_projects/destroy_all.json')
+

    HTTP 请求

    +

    DELETE /api/organizations/:organization/teams/:id/team_projects/destroy_all.json

    +

    请求参数:

    + + + + + + + + + + + + + + + + + + + + + + + +
    参数必选默认类型字段说明
    organization是string组织标识
    id是integer团队 ID
    +

    返回字段说明:

    +
    +

    返回的JSON示例:

    +
    +
    {
+    "status": 0,
+    "message": "success"
+}
+
    + +

    Errors