Boonlive_RD_Web/Web_BAI_Manage_ApiServer
9
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
0bdaf54eedcd38793c3b36c2bc7f54f4949bb075
Web_BAI_Manage_ApiServer/pocket-base/spec/openapi-wx.yaml

45 lines
1.8 KiB
YAML
Raw Normal View History

feat: 添加微信端 API 文档和字典表初始化脚本 - 新增 openapi-wx.yaml 文件，定义微信端接口文档，包括用户统计、token 刷新、微信登录和用户资料更新等接口。 - 新增 pocketbase.dictionary.js 脚本，用于初始化和校验字典表结构，确保与预期一致。
2026-03-27 19:26:25 +08:00
openapi: 3.1.0
info:
feat: 添加 PocketBase 管理端与自定义 hooks 的 API 文档 - 新增 openapi.yaml 文件，定义管理端与自定义 hooks 的接口文档，包括系统、微信认证、平台认证、字典管理、附件管理、文档管理、购物车和订单等接口。 - 新增 order.yaml 文件，定义订单相关的接口，包括查询订单列表、查询订单详情、新增订单记录、修改订单记录和删除订单记录的请求和响应结构。 - 新增 openapi-wx/openapi.yaml 文件，定义 PocketBase 原生 API 文档，包含企业信息、附件信息、产品信息、文档信息、购物车和订单的接口。 - 新增 pocketbase.scheme.js 文件，包含 PocketBase 集合的创建和更新逻辑，定义了多个集合的字段、索引和权限规则。
2026-04-08 20:14:22 +08:00
title: BAI PocketBase Native API
feat: 添加微信端 API 文档和字典表初始化脚本 - 新增 openapi-wx.yaml 文件，定义微信端接口文档，包括用户统计、token 刷新、微信登录和用户资料更新等接口。 - 新增 pocketbase.dictionary.js 脚本，用于初始化和校验字典表结构，确保与预期一致。
2026-03-27 19:26:25 +08:00
version: 1.0.0-wx
description: |
feat: 添加 PocketBase 管理端与自定义 hooks 的 API 文档 - 新增 openapi.yaml 文件，定义管理端与自定义 hooks 的接口文档，包括系统、微信认证、平台认证、字典管理、附件管理、文档管理、购物车和订单等接口。 - 新增 order.yaml 文件，定义订单相关的接口，包括查询订单列表、查询订单详情、新增订单记录、修改订单记录和删除订单记录的请求和响应结构。 - 新增 openapi-wx/openapi.yaml 文件，定义 PocketBase 原生 API 文档，包含企业信息、附件信息、产品信息、文档信息、购物车和订单的接口。 - 新增 pocketbase.scheme.js 文件，包含 PocketBase 集合的创建和更新逻辑，定义了多个集合的字段、索引和权限规则。
2026-04-08 20:14:22 +08:00
顶层兼容入口。
当前原生 API 文档已整理到 `spec/openapi-wx/` 目录下；本文件保留为兼容总入口。
feat: 添加微信端 API 文档和字典表初始化脚本 - 新增 openapi-wx.yaml 文件，定义微信端接口文档，包括用户统计、token 刷新、微信登录和用户资料更新等接口。 - 新增 pocketbase.dictionary.js 脚本，用于初始化和校验字典表结构，确保与预期一致。
2026-03-27 19:26:25 +08:00
servers:
- url: https://bai-api.blv-oa.com
description: 生产环境
feat: 添加系统刷新令牌请求和用户统计响应的 OpenAPI 规范 feat: 添加微信认证相关的 OpenAPI 规范，包括用户信息、登录请求和个人资料请求 feat: 添加 is_delete 字段迁移脚本，支持在集合中添加软删除字段 feat: 添加软删除规则应用脚本，确保所有相关集合的查询规则包含软删除条件 feat: 添加购物车和订单业务 ID 自动生成的迁移脚本，确保字段类型和自动生成规则正确
2026-04-07 20:02:10 +08:00
- url: http://127.0.0.1:8090
feat: 添加微信端 API 文档和字典表初始化脚本 - 新增 openapi-wx.yaml 文件，定义微信端接口文档，包括用户统计、token 刷新、微信登录和用户资料更新等接口。 - 新增 pocketbase.dictionary.js 脚本，用于初始化和校验字典表结构，确保与预期一致。
2026-03-27 19:26:25 +08:00
description: PocketBase 本地环境
tags:
feat: 规范化PocketBase数据库文档与原生API访问 - 将数据库文档拆分为按collection命名的标准文件，统一格式 - 补充tbl_company、tbl_system_dict等表的原生访问规则 - 新增users_tag、document_create等字段 - 优化用户资料更新接口，支持非必填字段 - 添加公司原生API测试脚本 - 归档本次变更至OpenSpec
2026-03-29 16:21:34 +08:00
- name: 企业信息
feat: 添加 PocketBase 管理端与自定义 hooks 的 API 文档 - 新增 openapi.yaml 文件，定义管理端与自定义 hooks 的接口文档，包括系统、微信认证、平台认证、字典管理、附件管理、文档管理、购物车和订单等接口。 - 新增 order.yaml 文件，定义订单相关的接口，包括查询订单列表、查询订单详情、新增订单记录、修改订单记录和删除订单记录的请求和响应结构。 - 新增 openapi-wx/openapi.yaml 文件，定义 PocketBase 原生 API 文档，包含企业信息、附件信息、产品信息、文档信息、购物车和订单的接口。 - 新增 pocketbase.scheme.js 文件，包含 PocketBase 集合的创建和更新逻辑，定义了多个集合的字段、索引和权限规则。
2026-04-08 20:14:22 +08:00
description: PocketBase 原生公司记录接口
feat: 规范化PocketBase数据库文档与原生API访问 - 将数据库文档拆分为按collection命名的标准文件，统一格式 - 补充tbl_company、tbl_system_dict等表的原生访问规则 - 新增users_tag、document_create等字段 - 优化用户资料更新接口，支持非必填字段 - 添加公司原生API测试脚本 - 归档本次变更至OpenSpec
2026-03-29 16:21:34 +08:00
- name: 附件信息
feat: 添加 PocketBase 管理端与自定义 hooks 的 API 文档 - 新增 openapi.yaml 文件，定义管理端与自定义 hooks 的接口文档，包括系统、微信认证、平台认证、字典管理、附件管理、文档管理、购物车和订单等接口。 - 新增 order.yaml 文件，定义订单相关的接口，包括查询订单列表、查询订单详情、新增订单记录、修改订单记录和删除订单记录的请求和响应结构。 - 新增 openapi-wx/openapi.yaml 文件，定义 PocketBase 原生 API 文档，包含企业信息、附件信息、产品信息、文档信息、购物车和订单的接口。 - 新增 pocketbase.scheme.js 文件，包含 PocketBase 集合的创建和更新逻辑，定义了多个集合的字段、索引和权限规则。
2026-04-08 20:14:22 +08:00
description: PocketBase 原生附件记录接口
feat: 添加产品列表集合初始化脚本，包含字段定义、索引创建及校验逻辑
2026-04-01 11:59:58 +08:00
- name: 产品信息
feat: 添加 PocketBase 管理端与自定义 hooks 的 API 文档 - 新增 openapi.yaml 文件，定义管理端与自定义 hooks 的接口文档，包括系统、微信认证、平台认证、字典管理、附件管理、文档管理、购物车和订单等接口。 - 新增 order.yaml 文件，定义订单相关的接口，包括查询订单列表、查询订单详情、新增订单记录、修改订单记录和删除订单记录的请求和响应结构。 - 新增 openapi-wx/openapi.yaml 文件，定义 PocketBase 原生 API 文档，包含企业信息、附件信息、产品信息、文档信息、购物车和订单的接口。 - 新增 pocketbase.scheme.js 文件，包含 PocketBase 集合的创建和更新逻辑，定义了多个集合的字段、索引和权限规则。
2026-04-08 20:14:22 +08:00
description: PocketBase 原生产品记录接口
feat: 规范化PocketBase数据库文档与原生API访问 - 将数据库文档拆分为按collection命名的标准文件，统一格式 - 补充tbl_company、tbl_system_dict等表的原生访问规则 - 新增users_tag、document_create等字段 - 优化用户资料更新接口，支持非必填字段 - 添加公司原生API测试脚本 - 归档本次变更至OpenSpec
2026-03-29 16:21:34 +08:00
- name: 文档信息
feat: 添加 PocketBase 管理端与自定义 hooks 的 API 文档 - 新增 openapi.yaml 文件，定义管理端与自定义 hooks 的接口文档，包括系统、微信认证、平台认证、字典管理、附件管理、文档管理、购物车和订单等接口。 - 新增 order.yaml 文件，定义订单相关的接口，包括查询订单列表、查询订单详情、新增订单记录、修改订单记录和删除订单记录的请求和响应结构。 - 新增 openapi-wx/openapi.yaml 文件，定义 PocketBase 原生 API 文档，包含企业信息、附件信息、产品信息、文档信息、购物车和订单的接口。 - 新增 pocketbase.scheme.js 文件，包含 PocketBase 集合的创建和更新逻辑，定义了多个集合的字段、索引和权限规则。
2026-04-08 20:14:22 +08:00
description: PocketBase 原生文档记录接口
feat: 添加购物车与订单管理页面及相关API支持 - 新增购物车与订单管理页面，包含用户列表、购物车详情和订单记录展示功能。 - 实现用户搜索、刷新、重置和退出登录功能。 - 新增购物车和订单数据表结构初始化脚本，包含字段、索引及权限规则设置。 - 实现数据表的创建与更新逻辑，并进行结构校验。
2026-04-03 10:50:31 +08:00
- name: 购物车
feat: 添加 PocketBase 管理端与自定义 hooks 的 API 文档 - 新增 openapi.yaml 文件，定义管理端与自定义 hooks 的接口文档，包括系统、微信认证、平台认证、字典管理、附件管理、文档管理、购物车和订单等接口。 - 新增 order.yaml 文件，定义订单相关的接口，包括查询订单列表、查询订单详情、新增订单记录、修改订单记录和删除订单记录的请求和响应结构。 - 新增 openapi-wx/openapi.yaml 文件，定义 PocketBase 原生 API 文档，包含企业信息、附件信息、产品信息、文档信息、购物车和订单的接口。 - 新增 pocketbase.scheme.js 文件，包含 PocketBase 集合的创建和更新逻辑，定义了多个集合的字段、索引和权限规则。
2026-04-08 20:14:22 +08:00
description: PocketBase 原生购物车记录接口
feat: 添加购物车与订单管理页面及相关API支持 - 新增购物车与订单管理页面，包含用户列表、购物车详情和订单记录展示功能。 - 实现用户搜索、刷新、重置和退出登录功能。 - 新增购物车和订单数据表结构初始化脚本，包含字段、索引及权限规则设置。 - 实现数据表的创建与更新逻辑，并进行结构校验。
2026-04-03 10:50:31 +08:00
- name: 订单
feat: 添加 PocketBase 管理端与自定义 hooks 的 API 文档 - 新增 openapi.yaml 文件，定义管理端与自定义 hooks 的接口文档，包括系统、微信认证、平台认证、字典管理、附件管理、文档管理、购物车和订单等接口。 - 新增 order.yaml 文件，定义订单相关的接口，包括查询订单列表、查询订单详情、新增订单记录、修改订单记录和删除订单记录的请求和响应结构。 - 新增 openapi-wx/openapi.yaml 文件，定义 PocketBase 原生 API 文档，包含企业信息、附件信息、产品信息、文档信息、购物车和订单的接口。 - 新增 pocketbase.scheme.js 文件，包含 PocketBase 集合的创建和更新逻辑，定义了多个集合的字段、索引和权限规则。
2026-04-08 20:14:22 +08:00
description: PocketBase 原生订单记录接口
feat: 添加微信端 API 文档和字典表初始化脚本 - 新增 openapi-wx.yaml 文件，定义微信端接口文档，包括用户统计、token 刷新、微信登录和用户资料更新等接口。 - 新增 pocketbase.dictionary.js 脚本，用于初始化和校验字典表结构，确保与预期一致。
2026-03-27 19:26:25 +08:00
paths:
feat: 规范化PocketBase数据库文档与原生API访问 - 将数据库文档拆分为按collection命名的标准文件，统一格式 - 补充tbl_company、tbl_system_dict等表的原生访问规则 - 新增users_tag、document_create等字段 - 优化用户资料更新接口，支持非必填字段 - 添加公司原生API测试脚本 - 归档本次变更至OpenSpec
2026-03-29 16:21:34 +08:00
/pb/api/collections/tbl_company/records:
feat: 添加微信认证相关接口，包括微信登录和用户资料更新功能 - 新增 wechatLogin 接口，支持使用微信临时凭证 code 登录或注册用户，返回用户信息和 auth token。 - 新增 wechatProfile 接口，支持更新微信用户资料，支持非空字段增量更新。 - 定义相关请求和响应的 schema，包括 WechatLoginRequest、WechatProfileRequest、AuthSuccessResponse 和 WechatProfileResponse。 - 处理不同的响应状态码，包括成功、参数错误、认证失败等。
2026-04-08 09:04:36 +08:00
$ref: './openapi-wx/company.yaml#/paths/companyRecords'
feat: 规范化PocketBase数据库文档与原生API访问 - 将数据库文档拆分为按collection命名的标准文件，统一格式 - 补充tbl_company、tbl_system_dict等表的原生访问规则 - 新增users_tag、document_create等字段 - 优化用户资料更新接口，支持非必填字段 - 添加公司原生API测试脚本 - 归档本次变更至OpenSpec
2026-03-29 16:21:34 +08:00
/pb/api/collections/tbl_company/records/{recordId}:
feat: 添加微信认证相关接口，包括微信登录和用户资料更新功能 - 新增 wechatLogin 接口，支持使用微信临时凭证 code 登录或注册用户，返回用户信息和 auth token。 - 新增 wechatProfile 接口，支持更新微信用户资料，支持非空字段增量更新。 - 定义相关请求和响应的 schema，包括 WechatLoginRequest、WechatProfileRequest、AuthSuccessResponse 和 WechatProfileResponse。 - 处理不同的响应状态码，包括成功、参数错误、认证失败等。
2026-04-08 09:04:36 +08:00
$ref: './openapi-wx/company.yaml#/paths/companyRecordById'
feat: 规范化PocketBase数据库文档与原生API访问 - 将数据库文档拆分为按collection命名的标准文件，统一格式 - 补充tbl_company、tbl_system_dict等表的原生访问规则 - 新增users_tag、document_create等字段 - 优化用户资料更新接口，支持非必填字段 - 添加公司原生API测试脚本 - 归档本次变更至OpenSpec
2026-03-29 16:21:34 +08:00
/pb/api/collections/tbl_attachments/records:
feat: 添加微信认证相关接口，包括微信登录和用户资料更新功能 - 新增 wechatLogin 接口，支持使用微信临时凭证 code 登录或注册用户，返回用户信息和 auth token。 - 新增 wechatProfile 接口，支持更新微信用户资料，支持非空字段增量更新。 - 定义相关请求和响应的 schema，包括 WechatLoginRequest、WechatProfileRequest、AuthSuccessResponse 和 WechatProfileResponse。 - 处理不同的响应状态码，包括成功、参数错误、认证失败等。
2026-04-08 09:04:36 +08:00
$ref: './openapi-wx/attachments.yaml#/paths/attachmentRecords'
feat: 添加产品列表集合初始化脚本，包含字段定义、索引创建及校验逻辑
2026-04-01 11:59:58 +08:00
/pb/api/collections/tbl_product_list/records:
feat: 添加微信认证相关接口，包括微信登录和用户资料更新功能 - 新增 wechatLogin 接口，支持使用微信临时凭证 code 登录或注册用户，返回用户信息和 auth token。 - 新增 wechatProfile 接口，支持更新微信用户资料，支持非空字段增量更新。 - 定义相关请求和响应的 schema，包括 WechatLoginRequest、WechatProfileRequest、AuthSuccessResponse 和 WechatProfileResponse。 - 处理不同的响应状态码，包括成功、参数错误、认证失败等。
2026-04-08 09:04:36 +08:00
$ref: './openapi-wx/products.yaml#/paths/productRecords'
feat: 规范化PocketBase数据库文档与原生API访问 - 将数据库文档拆分为按collection命名的标准文件，统一格式 - 补充tbl_company、tbl_system_dict等表的原生访问规则 - 新增users_tag、document_create等字段 - 优化用户资料更新接口，支持非必填字段 - 添加公司原生API测试脚本 - 归档本次变更至OpenSpec
2026-03-29 16:21:34 +08:00
/pb/api/collections/tbl_document/records:
feat: 添加微信认证相关接口，包括微信登录和用户资料更新功能 - 新增 wechatLogin 接口，支持使用微信临时凭证 code 登录或注册用户，返回用户信息和 auth token。 - 新增 wechatProfile 接口，支持更新微信用户资料，支持非空字段增量更新。 - 定义相关请求和响应的 schema，包括 WechatLoginRequest、WechatProfileRequest、AuthSuccessResponse 和 WechatProfileResponse。 - 处理不同的响应状态码，包括成功、参数错误、认证失败等。
2026-04-08 09:04:36 +08:00
$ref: './openapi-wx/documents.yaml#/paths/documentRecords'
/pb/api/collections/tbl_cart/records:
$ref: './openapi-wx/cart.yaml#/paths/cartRecords'
/pb/api/collections/tbl_cart/records/{recordId}:
$ref: './openapi-wx/cart.yaml#/paths/cartRecordById'
feat: 添加 SDK 权限管理页面和产品功能字段迁移脚本 - 新增 SDK 权限管理页面，包含角色管理、用户授权和集合权限配置功能。 - 实现字段迁移脚本，向 tbl_product_list 集合添加 prod_list_function 字段，类型为 json。
2026-04-03 18:35:50 +08:00
/pb/api/collections/tbl_order/records:
feat: 添加微信认证相关接口，包括微信登录和用户资料更新功能 - 新增 wechatLogin 接口，支持使用微信临时凭证 code 登录或注册用户，返回用户信息和 auth token。 - 新增 wechatProfile 接口，支持更新微信用户资料，支持非空字段增量更新。 - 定义相关请求和响应的 schema，包括 WechatLoginRequest、WechatProfileRequest、AuthSuccessResponse 和 WechatProfileResponse。 - 处理不同的响应状态码，包括成功、参数错误、认证失败等。
2026-04-08 09:04:36 +08:00
$ref: './openapi-wx/order.yaml#/paths/orderRecords'
feat: 添加 SDK 权限管理页面和产品功能字段迁移脚本 - 新增 SDK 权限管理页面，包含角色管理、用户授权和集合权限配置功能。 - 实现字段迁移脚本，向 tbl_product_list 集合添加 prod_list_function 字段，类型为 json。
2026-04-03 18:35:50 +08:00
/pb/api/collections/tbl_order/records/{recordId}:
feat: 添加微信认证相关接口，包括微信登录和用户资料更新功能 - 新增 wechatLogin 接口，支持使用微信临时凭证 code 登录或注册用户，返回用户信息和 auth token。 - 新增 wechatProfile 接口，支持更新微信用户资料，支持非空字段增量更新。 - 定义相关请求和响应的 schema，包括 WechatLoginRequest、WechatProfileRequest、AuthSuccessResponse 和 WechatProfileResponse。 - 处理不同的响应状态码，包括成功、参数错误、认证失败等。
2026-04-08 09:04:36 +08:00
$ref: './openapi-wx/order.yaml#/paths/orderRecordById'
Reference in New Issue Copy Permalink