mirrors/nocobase
1
0
Fork 0
mirror of https://github.com/nocobase/nocobase synced 2024-11-14 22:05:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch 'next' of github.com:nocobase/nocobase into next

Browse Source
This commit is contained in:
chenos 2024-10-11 15:22:25 +08:00
commit 664eb3df24
2 changed files with 198 additions and 117 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

117
packages/plugins/@nocobase/plugin-users/src/swagger/index.json
View File

@ -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"
}
}
}
}
}
}

198
packages/plugins/@nocobase/plugin-users/src/swagger/index.ts Normal file
View File

@ -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: '更新时间',
},
},
},
},
},
};