Remove and rename duplicate models in api.yml, change some enum name (bangumi#123)

Author: EverettSummer

.github/scripts/reset-version-json.js

@@ -0,0 +1,2 @@
+const fs = require("fs");
+fs.writeFileSync("open-api/version.json", "{}");

.github/scripts/rewrite-ref-path.js

@@ -0,0 +1,6 @@
+const fs = require('fs');
+
+const apiDoc = fs.readFileSync('open-api/api.yml', {encoding: 'utf-8'});
+
+fs.writeFileSync('open-api/api-gen.yml', apiDoc.replaceAll('v0.yaml#/components/schemas', '#/components/schemas'));
+

.github/workflows/build.yaml

@@ -22,6 +22,7 @@ jobs:
           key: node-hashFiles('yarn.lock') }}
 
       - run: yarn
+      - run: node .github/script/rewrite-ref-path.js
 
       - run: node .github/scripts/write-date.js
         env:

.gitignore

@@ -1,4 +1,6 @@
 .DS_Store
 .idea
 node_modules/
-public/dist.json
+public/dist.json
+open-api/api-gen.json
+open-api/api-gen.yml

config.json

@@ -4,7 +4,7 @@
             "inputFile": "./open-api/version.json"
         },
         {
-            "inputFile": "./open-api/api.yml"
+            "inputFile": "./open-api/api-gen.yml"
         },
         {
             "inputFile": "./open-api/v0.yaml"

open-api/api.yml

@@ -48,7 +48,7 @@ paths:
                   type: object
                   properties:
                     type:
-                      $ref: "#/components/schemas/SubjectType"
+                      $ref: "v0.yaml#/components/schemas/SubjectType"
                     name:
                       $ref: "#/components/schemas/SubjectTypeName"
                     name_cn:
@@ -210,7 +210,7 @@ paths:
       tags:
         - 搜索
       summary: 条目搜索
-      operationId: getSearchSubjectBykeywords
+      operationId: searchSubjectByKeywords
       parameters:
         - name: keywords
           in: path
@@ -224,7 +224,7 @@ paths:
           description: 条目类型，参考 [SubjectType](#model-SubjectType)
           required: false
           schema:
-            $ref: "#/components/schemas/SubjectType"
+            $ref: "v0.yaml#/components/schemas/SubjectType"
         - $ref: "#/components/parameters/responseGroup"
         - name: start
           in: query
@@ -451,6 +451,21 @@ components:
         - 4
         - 5
       example: 5
+      x-ms-enum:
+        name: CollectionStatusId
+        modelAsString: false
+        values:
+          - Wish
+          - Collect
+          - Doing
+          - OnHold
+          - Dropped
+      x-enum-varnames:
+        - Wish
+        - Collect
+        - Doing
+        - OnHold
+        - Dropped
     CollectionStatusType:
       description: 收藏状态类型
       type: string
@@ -475,24 +490,24 @@ components:
         name: CollectionStatusName
         modelAsString: false
         values:
-          - Todo
-          - Done
+          - Wish
+          - Collect
           - Doing
-          - Suspended
-          - Abandoned
+          - OnHold
+          - Dropped
       x-enum-varnames:
-        - Todo
-        - Done
+        - Wish
+        - Collect
         - Doing
-        - Suspended
-        - Abandoned
+        - OnHold
+        - Dropped
     CollectionStatus:
       description: 收藏状态
-        <br> 1 = wish = 想做
-        <br> 2 = collect = 做过
-        <br> 3 = do = 在做
-        <br> 4 = on_hold = 搁置
-        <br> 5 = dropped = 抛弃
+        - 1 = wish = 想做
+        - 2 = collect = 做过
+        - 3 = do = 在做
+        - 4 = on_hold = 搁置
+        - 5 = dropped = 抛弃
       type: object
       properties:
         id:
@@ -529,14 +544,14 @@ components:
         modelAsString: false
         values:
           - Watched
-          - Wish
-          - Abandoned
-          - Undo
+          - Queue
+          - Drop
+          - Remove
       x-enum-varnames:
         - Watched
-        - Wish
-        - Abandoned
-        - Undo
+        - Queue
+        - Drop
+        - Remove
     ResponseGroup:
       description: 返回数据大小
       type: string
@@ -553,21 +568,6 @@ components:
       x-enum-varnames:
         - Small
         - Medium
-    SubjectType:
-      description: 条目类型
-        <br> 1 = book
-        <br> 2 = anime
-        <br> 3 = music
-        <br> 4 = game
-        <br> 6 = real
-      type: integer
-      enum:
-        - 1
-        - 2
-        - 3
-        - 4
-        - 6
-      example: 2
     SubjectTypeName:
       description: 条目类型名称
         <br> book
@@ -622,7 +622,7 @@ components:
           description: 抛弃
           type: integer
           example: 86
-    Subject:
+    SubjectLegacy:
       type: object
       properties:
         id:
@@ -634,14 +634,14 @@ components:
           type: string
           example: http://bgm.tv/subject/12
         type:
-          $ref: "#/components/schemas/SubjectType"
+          $ref: "v0.yaml#/components/schemas/SubjectType"
         name:
           description: 条目名称
           type: string
           example: ちょびっツ
     SubjectBase:
       allOf:
-        - $ref: "#/components/schemas/Subject"
+        - $ref: "#/components/schemas/SubjectLegacy"
         - type: object
           properties:
             name_cn:
@@ -782,31 +782,7 @@ components:
           type: string
           example: Awesome!
         usergroup:
-          $ref: "#/components/schemas/UserGroup"
-    UserGroup:
-      description: >-
-        用户组
-        <br> 1 = 管理员
-        <br> 2 = Bangumi 管理猿
-        <br> 3 = 天窗管理猿
-        <br> 4 = 禁言用户
-        <br> 5 = 禁止访问用户
-        <br> 8 = 人物管理猿
-        <br> 9 = 维基条目管理猿
-        <br> 10 = 用户
-        <br> 11 = 维基人
-      type: integer
-      enum:
-        - 1
-        - 2
-        - 3
-        - 4
-        - 5
-        - 8
-        - 9
-        - 10
-        - 11
-      example: 11
+          $ref: "v0.yaml#/components/schemas/UserGroup"
     StatusCode:
       description: 响应状态（HTTP 状态码都为 200）
       type: object

package.json

@@ -1,7 +1,10 @@
 {
   "scripts": {
+    "fillVersion": "node .github/scripts/write-date.js",
+    "resetVersion": "node .github/scripts/reset-version-json.js",
+    "resolveRef": "node .github/scripts/rewrite-ref-path.js",
     "build": "openapi-merge-cli --config config.json",
-    "build:local": "node .github/scripts/write-date.js && npm run build"
+    "build:local": "npm run resolveRef && npm run fillVersion && npm run build && npm run resetVersion"
   },
   "dependencies": {
     "js-yaml": "^4.1.0",