node-cnb 1.2.13 → 1.4.0

package/README.md

@@ -5,13 +5,13 @@
 
 node-cnb 是一个用于访问 [CNB API](https://api.cnb.cool/) 的 node 编写的 SDK。
 
-# 安装
+## 安装
 
 ```shell
 npm install node-cnb
 ```
 
-# 使用
+## 使用
 
 ```typescript
 import { getClient  } from "node-cnb";
@@ -40,7 +40,7 @@ client.users.pinnedRepos.list({
 })
 ```
 
-# 方法路径
+## 方法路径
 
 方法路径为由如下几个元素组成： 
 
@@ -52,6 +52,6 @@ client.users.pinnedRepos.list({
 
 `/{repo}/-/git/branches` 的路径下 get 请求的方法名为 `repo.git.branches.list`
 
-`'/{repo}/-/git/branches/{branch}'` 的路径下 get 请求方法名为 `repo.git.branches.get`
+`/{repo}/-/git/branches/{branch}` 的路径下 get 请求方法名为 `repo.git.branches.get`
 
 对于此规则下方法路径仍然重复的 api，则单独定义在 [pathMethodMap.json](./pathMethodMap.json)

package/dist/paths.json

@@ -2242,7 +2242,7 @@
           "BearerAuth": []
         }
       ],
-      "description": "访问令牌调用此接口需包含以下权限 \nregistry-package-delete:rw",
+      "description": "访问令牌调用此接口需包含以下权限 \nrepo-registry-delete:rw",
       "consumes": null,
       "produces": [
         "application/vnd.cnb.api+json",
@@ -2686,72 +2686,6 @@
       "method": "get"
     }
   ],
-  "repo.contributor.trend.list": [
-    {
-      "security": [
-        {
-          "BearerAuth": []
-        }
-      ],
-      "description": "访问令牌调用此接口需包含以下权限 \nrepo-code:r",
-      "consumes": null,
-      "produces": [
-        "application/vnd.cnb.web+json"
-      ],
-      "tags": [
-        "RepoContributor"
-      ],
-      "summary": "查询仓库贡献者前 100 名的详细趋势数据",
-      "parameters": [
-        {
-          "description": "slug",
-          "in": "path",
-          "name": "repo",
-          "required": true,
-          "type": "string"
-        },
-        {
-          "default": 14,
-          "description": "limit, 0~100",
-          "in": "query",
-          "name": "limit",
-          "type": "integer"
-        },
-        {
-          "default": false,
-          "description": "exclude_external_users, true|false",
-          "in": "query",
-          "name": "exclude_external_users",
-          "type": "boolean"
-        }
-      ],
-      "responses": {
-        "200": {
-          "description": "OK",
-          "schema": {
-            "items": {
-              "$ref": "#/definitions/web.RepoContribTrend"
-            },
-            "type": "array"
-          }
-        },
-        "404": {
-          "description": "Not Found",
-          "schema": {
-            "$ref": "#/definitions/die.WebError"
-          }
-        },
-        "500": {
-          "description": "Internal Server Error",
-          "schema": {
-            "$ref": "#/definitions/die.WebError"
-          }
-        }
-      },
-      "path": "/{repo}/-/contributor/trend",
-      "method": "get"
-    }
-  ],
   "repo.files.get": [
     {
       "security": [
@@ -4758,16 +4692,14 @@
       },
       "path": "/{repo}/-/issues",
       "method": "get"
-    }
-  ],
-  "repo.issues.post": [
+    },
     {
       "security": [
         {
           "BearerAuth": []
         }
       ],
-      "description": "访问令牌调用此接口需包含以下权限 \nrepo-notes:rw",
+      "description": "访问令牌调用此接口需包含以下权限 \nrepo-notes:r",
       "consumes": null,
       "produces": [
         "application/json",
@@ -4776,7 +4708,7 @@
       "tags": [
         "Issues"
       ],
-      "summary": "创建一个 Issue",
+      "summary": "查询指定的 Issues",
       "parameters": [
         {
           "description": "repo",
@@ -4786,20 +4718,21 @@
           "type": "string"
         },
         {
-          "description": "Post Issue Form",
-          "in": "body",
-          "name": "post_issue_form",
+          "description": "issue number",
+          "in": "path",
+          "name": "number",
           "required": true,
-          "schema": {
-            "$ref": "#/definitions/api.PostIssueForm"
-          }
+          "type": "integer"
         }
       ],
       "responses": {
-        "201": {
-          "description": "Created",
+        "200": {
+          "description": "OK",
           "schema": {
-            "$ref": "#/definitions/api.IssueDetail"
+            "items": {
+              "$ref": "#/definitions/api.IssueDetail"
+            },
+            "type": "array"
           }
         },
         "404": {
@@ -4815,18 +4748,18 @@
           }
         }
       },
-      "path": "/{repo}/-/issues",
-      "method": "post"
+      "path": "/{repo}/-/issues/{number}",
+      "method": "get"
     }
   ],
-  "repo.issues.get": [
+  "repo.issues.post": [
     {
       "security": [
         {
           "BearerAuth": []
         }
       ],
-      "description": "访问令牌调用此接口需包含以下权限 \nrepo-notes:r",
+      "description": "访问令牌调用此接口需包含以下权限 \nrepo-notes:rw",
       "consumes": null,
       "produces": [
         "application/json",
@@ -4835,7 +4768,7 @@
       "tags": [
         "Issues"
       ],
-      "summary": "查询指定的 Issues",
+      "summary": "创建一个 Issue",
       "parameters": [
         {
           "description": "repo",
@@ -4845,16 +4778,18 @@
           "type": "string"
         },
         {
-          "description": "issue number",
-          "in": "path",
-          "name": "number",
+          "description": "Post Issue Form",
+          "in": "body",
+          "name": "post_issue_form",
           "required": true,
-          "type": "integer"
+          "schema": {
+            "$ref": "#/definitions/api.PostIssueForm"
+          }
         }
       ],
       "responses": {
-        "200": {
-          "description": "OK",
+        "201": {
+          "description": "Created",
           "schema": {
             "$ref": "#/definitions/api.IssueDetail"
           }
@@ -4872,8 +4807,8 @@
           }
         }
       },
-      "path": "/{repo}/-/issues/{number}",
-      "method": "get"
+      "path": "/{repo}/-/issues",
+      "method": "post"
     }
   ],
   "repo.issues.patch": [

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "node-cnb",
-  "version": "1.2.13",
+  "version": "1.4.0",
   "description": "node sdk for cnb open api",
   "main": "dist/index.js",
   "typings": "./src/index.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "node build.js && tsc && cp src/*.json dist/",
+    "sync-swagger": "wget -O openapi_swagger.json https://api.cnb.cool/swagger.json",
     "release": "standard-version && git push --follow-tags origin main"
   },
   "repository": {

package/src/client.d.ts

@@ -17,7 +17,6 @@ import {
   DtoBuildLogsResult,
   DtoBuildResult,
   DtoBuildStatusResult,
-  WebRepoContribTrend,
   DtoForks,
   ApiBranch,
   ApiBranchDetail,
@@ -371,16 +370,6 @@ export interface Client {
       };
     };
 
-    contributor: {
-      trend: {
-        list: (params: {
-          repo: string;
-          limit?: number;
-          exclude_external_users?: boolean;
-        }) => Promise<WebRepoContribTrend[]>;
-      };
-    };
-
     files: {
       get: (params: {
         repo: string;
@@ -600,11 +589,6 @@ export interface Client {
 
       post: (params: { repo: string; post_issue_form: any }) => Promise<any>;
 
-      get: (params: {
-        repo: string;
-        number: number;
-      }) => Promise<ApiIssueDetail>;
-
       patch: (params: {
         repo: string;
         number: number;

package/src/types.d.ts

@@ -764,27 +764,20 @@ export type DtoBoolResponse = {
 };
 
 export type DtoBudget = {
-  /**单位：核时*/
-  charge_type_ci: number;
   charge_type_ci_policy: number;
 
   /**ci价格，单位：分*/
   charge_type_ci_price: number;
-  charge_type_dev: number;
   charge_type_dev_policy: number;
 
   /**开发价格，单位：分*/
   charge_type_dev_price: number;
 
-  /**单位：Gib*/
-  charge_type_git: number;
-
   /**折扣，没折扣是100*/
   charge_type_git_policy: number;
 
   /**git存储价格，单位：分*/
   charge_type_git_price: number;
-  charge_type_object: number;
   charge_type_object_policy: number;
 
   /**对象存储价格，单位：分*/
@@ -792,14 +785,11 @@ export type DtoBudget = {
 
   /**预算单名称*/
   name: string;
-  status: DtoBudgetSts;
 
   /**云账号id*/
   uin: string;
 };
 
-export type DtoBudgetSts = number;
-
 export type DtoBuildLogsResult = {
   /**构建数据列表*/
   data: DtoLogInfo[];
@@ -3312,10 +3302,6 @@ export type WebRepository = {
   ssh_clone_url: string;
 };
 
-export type WebResource = {
-  type: string;
-};
-
 export type WebSignature = {
   date: string;
   email: string;
@@ -3579,7 +3565,6 @@ export type WebapiPullRequestNumber = {
 };
 
 export type WebapiPullRequestReviewId = {
-  comment_ids: string[];
   review_id: string;
 };