diff --git a/public/docs/api.html b/public/docs/api.html index 0f67e27c5..1b75a97a2 100644 --- a/public/docs/api.html +++ b/public/docs/api.html @@ -349,7 +349,10 @@ 项目主页
  • - 更改项目导航 + 项目模块信息 +
  • +
  • + 更改项目模块展示
  • 创建项目 @@ -1119,8 +1122,48 @@ http://localhost:3000/api/jasder/forgeplus/about | jq -

    更改项目导航

    -

    更改项目导航信息

    +

    项目模块信息

    +

    项目模块信息

    + +
    +

    示例:

    +
    +
    curl -X GET \
    +http://localhost:3000/api/yystopf/ceshi/project_units.json
    +
    await octokit.request('GET /api/yystopf/ceshi/project_units')
    +

    HTTP 请求

    +

    GET /api/yystopf/ceshi/project_units

    +

    返回字段说明:

    + + + + + + + + + + + + +
    参数类型字段说明
    typestring模块名称
    + +
    +

    返回的JSON示例:

    +
    +
    [
    +    {
    +        "type": "code"
    +    },
    +    {
    +        "type": "pulls"
    +    },
    +    {
    +        "type": "issues"
    +    }
    +]
    +

    更改项目模块展示

    +

    更改项目模块展示

    示例:

    @@ -1131,7 +1174,7 @@ Remember — a happy kitten is an authenticated kitten! -d "{ \"unit_typs\": [\"code\", \"pulls\"]}" \ http://localhost:3000/api/yystopf/ceshi/project_units.json
    await octokit.request('POST /api/yystopf/ceshi/project_units')
    -

    HTTP 请求

    +

    HTTP 请求

    POST /api/yystopf/ceshi/project_units

    请求参数

    @@ -1151,7 +1194,7 @@ http://localhost:3000/api/yystopf/ceshi/project_units.json
    项目模块内容, 支持以下参数:code:代码库,issues:易修,pulls:合并请求,devops:工作流,versions:里程碑
    -

    返回字段说明:

    +

    返回字段说明:

    @@ -1195,7 +1238,7 @@ http://localhost:3000/api/yystopf/ceshi/project_units.json -d"license_id=1"\ http://localhost:3000/api/projects.json
    await octokit.request('GET /api/projects.json')
    -

    HTTP 请求

    +

    HTTP 请求

    POST api/projects

    请求参数

    参数
    @@ -1313,7 +1356,7 @@ http://localhost:3000/api/projects.json -d"project_language_id=2"\ http://localhost:3000/api/projects/migrate.json
    await octokit.request('GET /api/projects/migrate.json')
    -

    HTTP 请求

    +

    HTTP 请求

    POST api/projects/migrate.json

    请求参数

    @@ -1438,7 +1481,7 @@ http://localhost:3000/api/projects/migrate.json
    curl -X POST http://localhost:3000/api/repositories/1244/sync_mirror.json
     
    await octokit.request('POST /api/repositories/1244/sync_mirror.json')
    -

    HTTP 请求

    +

    HTTP 请求

    POST api/repositories/:id/sync_mirror.json

    请求参数

    @@ -1493,7 +1536,7 @@ http://localhost:3000/api/projects/migrate.json
    curl -X POST http://localhost:3000/api/jasder/forgeplus/forks.json
     
    await octokit.request('POST /api/jaser/jasder_test/forks.json')
    -

    HTTP 请求

    +

    HTTP 请求

    POST api/:owner/:repo/forks.json

    请求参数