From 64b6e45709a801e41928d4f32bc095cbb386ff00 Mon Sep 17 00:00:00 2001
From: ChengLei Shao <chareice@live.com>
Date: Fri, 11 Oct 2024 15:20:00 +0800
Subject: [PATCH] fix: api doc of user plugin (#5391)

---
 .../plugin-users/src/swagger/index.json       | 117 -----------
 .../plugin-users/src/swagger/index.ts         | 198 ++++++++++++++++++
 2 files changed, 198 insertions(+), 117 deletions(-)
 delete mode 100644 packages/plugins/@nocobase/plugin-users/src/swagger/index.json
 create mode 100644 packages/plugins/@nocobase/plugin-users/src/swagger/index.ts

diff --git a/packages/plugins/@nocobase/plugin-users/src/swagger/index.json b/packages/plugins/@nocobase/plugin-users/src/swagger/index.json
deleted file mode 100644
index f290dbce6..000000000
--- a/packages/plugins/@nocobase/plugin-users/src/swagger/index.json
+++ /dev/null
@@ -1,117 +0,0 @@
-{
-  "openapi": "3.0.2",
-  "info": {
-    "title": "NocoBase API - Users plugin"
-  },
-  "tags": [],
-  "paths": {
-    "/users:list": {
-      "get": {
-        "tags": ["users"],
-        "description": "",
-        "parameters": [],
-        "responses": {
-          "200": {
-            "description": "OK"
-          }
-        }
-      }
-    },
-    "/users:get": {
-      "get": {
-        "tags": ["users"],
-        "description": "",
-        "parameters": [],
-        "responses": {
-          "200": {
-            "description": "OK"
-          }
-        }
-      }
-    },
-    "/users:create": {
-      "post": {
-        "tags": ["users"],
-        "description": "",
-        "parameters": [],
-        "responses": {
-          "200": {
-            "description": "OK"
-          }
-        }
-      }
-    },
-    "/users:update": {
-      "post": {
-        "tags": ["users"],
-        "description": "",
-        "parameters": [],
-        "responses": {
-          "200": {
-            "description": "OK"
-          }
-        }
-      }
-    },
-    "/users:updateProfile": {
-      "post": {
-        "tags": ["users"],
-        "description": "",
-        "parameters": [],
-        "responses": {
-          "200": {
-            "description": "OK"
-          }
-        }
-      }
-    },
-    "/users:changePassword": {
-      "post": {
-        "tags": ["users"],
-        "description": "",
-        "parameters": [],
-        "responses": {
-          "200": {
-            "description": "OK"
-          }
-        }
-      }
-    },
-    "/users:destroy": {
-      "post": {
-        "tags": ["users"],
-        "description": "",
-        "parameters": [],
-        "responses": {
-          "200": {
-            "description": "OK"
-          }
-        }
-      }
-    },
-    "/{collectionName}/{collectionIndex}/createdBy:get": {
-      "post": {
-        "tags": ["$collection.createdBy"],
-        "description": "",
-        "parameters": [],
-        "responses": {
-          "200": {
-            "description": "OK"
-          }
-        }
-      }
-    },
-    "/{collectionName}/{collectionIndex}/updatedBy:get": {
-      "post": {
-        "tags": ["$collection.updatedBy"],
-        "description": "",
-        "parameters": [],
-        "responses": {
-          "200": {
-            "description": "OK"
-          }
-        }
-      }
-    }
-  }
-}
diff --git a/packages/plugins/@nocobase/plugin-users/src/swagger/index.ts b/packages/plugins/@nocobase/plugin-users/src/swagger/index.ts
new file mode 100644
index 000000000..cb12777c7
--- /dev/null
+++ b/packages/plugins/@nocobase/plugin-users/src/swagger/index.ts
@@ -0,0 +1,198 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+export default {
+  openapi: '3.0.2',
+  info: {
+    title: 'NocoBase API - User plugin',
+  },
+  paths: {
+    '/users:list': {
+      get: {
+        tags: ['users'],
+        description: '',
+        parameters: [],
+        responses: {
+          200: {
+            description: 'ok',
+            content: {
+              'application/json': {
+                schema: {
+                  type: 'array',
+                  items: {
+                    $ref: '#/components/schemas/user',
+                  },
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+    '/users:get': {
+      get: {
+        tags: ['users'],
+        description: '',
+        parameters: [
+          {
+            name: 'filterByTk',
+            in: 'query',
+            description: 'user id',
+            required: true,
+            schema: {
+              type: 'integer',
+            },
+          },
+        ],
+        responses: {
+          200: {
+            description: 'ok',
+            content: {
+              'application/json': {
+                schema: {
+                  $ref: '#/components/schemas/user',
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+    '/users:create': {
+      post: {
+        tags: ['users'],
+        description: '',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                $ref: '#/components/schemas/user',
+              },
+            },
+          },
+        },
+        responses: {
+          '200': {
+            description: 'OK',
+            content: {
+              'application/json': {
+                schema: {
+                  $ref: '#/components/schemas/user',
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+    '/users:update': {
+      post: {
+        tags: ['users'],
+        description: '',
+        parameters: [
+          {
+            name: 'filterByTk',
+            in: 'query',
+            description: 'user id',
+            required: true,
+            schema: {
+              type: 'integer',
+            },
+          },
+        ],
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                $ref: '#/components/schemas/user',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            description: 'ok',
+            content: {
+              'application/json': {
+                schema: {
+                  $ref: '#/components/schemas/user',
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+    '/users:destroy': {
+      post: {
+        tags: ['users'],
+        description: '',
+        parameters: [
+          {
+            name: 'filterByTk',
+            in: 'query',
+            description: 'role name',
+            required: true,
+            schema: {
+              type: 'string',
+            },
+          },
+        ],
+        responses: {
+          '200': {
+            description: 'OK',
+          },
+        },
+      },
+    },
+  },
+  components: {
+    schemas: {
+      user: {
+        type: 'object',
+        properties: {
+          id: {
+            type: 'integer',
+            description: '用户ID',
+          },
+          nickname: {
+            type: 'string',
+            description: '昵称',
+          },
+          username: {
+            type: 'string',
+            description: '用户名',
+          },
+          email: {
+            type: 'string',
+            description: 'email',
+          },
+          phone: {
+            type: 'string',
+            description: '手机号码',
+          },
+          password: {
+            type: 'string',
+            description: '密码',
+          },
+          createdAt: {
+            type: 'string',
+            format: 'date-time',
+            description: '创建时间',
+          },
+          updatedAt: {
+            type: 'string',
+            format: 'date-time',
+            description: '更新时间',
+          },
+        },
+      },
+    },
+  },
+};