feat: 添加系统刷新令牌请求和用户统计响应的 OpenAPI 规范
feat: 添加微信认证相关的 OpenAPI 规范,包括用户信息、登录请求和个人资料请求 feat: 添加 is_delete 字段迁移脚本,支持在集合中添加软删除字段 feat: 添加软删除规则应用脚本,确保所有相关集合的查询规则包含软删除条件 feat: 添加购物车和订单业务 ID 自动生成的迁移脚本,确保字段类型和自动生成规则正确
This commit is contained in:
125
pocket-base/spec/openapi-wx/schemas/attachments.yaml
Normal file
125
pocket-base/spec/openapi-wx/schemas/attachments.yaml
Normal file
@@ -0,0 +1,125 @@
|
||||
PocketBaseAttachmentRecord:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: PocketBase 记录主键
|
||||
example: PocketBase记录主键 | string
|
||||
collectionId:
|
||||
type: string
|
||||
description: 集合ID
|
||||
example: 集合ID | string
|
||||
collectionName:
|
||||
type: string
|
||||
description: 集合名称
|
||||
example: 集合名称 | string
|
||||
attachments_id:
|
||||
type: string
|
||||
description: 附件业务 ID
|
||||
example: 附件业务ID | string
|
||||
attachments_link:
|
||||
type: string
|
||||
description: PocketBase 文件字段值,可按标准文件路径拼接文件流地址
|
||||
example: PocketBase文件字段值,可拼接文件流地址 | string
|
||||
attachments_filename:
|
||||
type: string
|
||||
description: 原始文件名
|
||||
example: 原始文件名 | string
|
||||
attachments_filetype:
|
||||
type: string
|
||||
description: 文件类型 / MIME
|
||||
example: 文件类型或MIME | string
|
||||
attachments_size:
|
||||
type:
|
||||
- number
|
||||
- integer
|
||||
- string
|
||||
description: 文件大小
|
||||
example: 文件大小 | number
|
||||
attachments_owner:
|
||||
type: string
|
||||
description: 上传者业务标识
|
||||
example: 上传者业务标识 | string
|
||||
attachments_md5:
|
||||
type: string
|
||||
description: 文件 MD5
|
||||
example: 文件MD5 | string
|
||||
attachments_ocr:
|
||||
type: string
|
||||
description: OCR 识别结果
|
||||
example: OCR识别结果 | string
|
||||
attachments_status:
|
||||
type: string
|
||||
description: 附件状态
|
||||
example: 附件状态 | string
|
||||
attachments_remark:
|
||||
type: string
|
||||
description: 备注
|
||||
example: 备注 | string
|
||||
example:
|
||||
id: PocketBase记录主键 | string
|
||||
collectionId: 集合ID | string
|
||||
collectionName: 集合名称 | string
|
||||
attachments_id: 附件业务ID | string
|
||||
attachments_link: PocketBase文件字段值,可拼接文件流地址 | string
|
||||
attachments_filename: 原始文件名 | string
|
||||
attachments_filetype: 文件类型或MIME | string
|
||||
attachments_size: 文件大小 | number
|
||||
attachments_owner: 上传者业务标识 | string
|
||||
attachments_md5: 文件MD5 | string
|
||||
attachments_ocr: OCR识别结果 | string
|
||||
attachments_status: 附件状态 | string
|
||||
attachments_remark: 备注 | string
|
||||
|
||||
PocketBaseAttachmentListResponse:
|
||||
type: object
|
||||
required:
|
||||
- page
|
||||
- perPage
|
||||
- totalItems
|
||||
- totalPages
|
||||
- items
|
||||
properties:
|
||||
page:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
example: 页码 | integer
|
||||
perPage:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
example: 每页条数 | integer
|
||||
totalItems:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
example: 总记录数 | integer
|
||||
totalPages:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
example: 总页数 | integer
|
||||
items:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi-wx.yaml#/components/schemas/PocketBaseAttachmentRecord'
|
||||
example:
|
||||
page: 页码 | integer
|
||||
perPage: 每页条数 | integer
|
||||
totalItems: 总记录数 | integer
|
||||
totalPages: 总页数 | integer
|
||||
items:
|
||||
- id: PocketBase记录主键 | string
|
||||
collectionId: 集合ID | string
|
||||
collectionName: 集合名称 | string
|
||||
attachments_id: 附件业务ID | string
|
||||
attachments_link: PocketBase文件字段值,可拼接文件流地址 | string
|
||||
attachments_filename: 原始文件名 | string
|
||||
attachments_filetype: 文件类型或MIME | string
|
||||
attachments_size: 文件大小 | number
|
||||
attachments_owner: 上传者业务标识 | string
|
||||
attachments_md5: 文件MD5 | string
|
||||
attachments_ocr: OCR识别结果 | string
|
||||
attachments_status: 附件状态 | string
|
||||
attachments_remark: 备注 | string
|
||||
185
pocket-base/spec/openapi-wx/schemas/cart-hooks.yaml
Normal file
185
pocket-base/spec/openapi-wx/schemas/cart-hooks.yaml
Normal file
@@ -0,0 +1,185 @@
|
||||
CartRecord:
|
||||
allOf:
|
||||
- $ref: '../../openapi-wx.yaml#/components/schemas/HookRecordBase'
|
||||
- type: object
|
||||
properties:
|
||||
cart_id:
|
||||
type: string
|
||||
description: 购物车业务 ID
|
||||
example: CART-1770000000000-abc123
|
||||
cart_number:
|
||||
type: string
|
||||
description: 购物车名称或分组号
|
||||
example: wx-user-20260403153000
|
||||
cart_create:
|
||||
type: string
|
||||
description: 购物车项创建时间,由数据库自动生成
|
||||
example: 2026-04-03 15:30:00.000Z
|
||||
cart_owner:
|
||||
type: string
|
||||
description: 购物车所有者 openid
|
||||
example: wx-openid-user-001
|
||||
cart_product_id:
|
||||
type: string
|
||||
description: 产品业务 ID
|
||||
example: PROD-1770000000000-abcd12
|
||||
cart_product_quantity:
|
||||
type:
|
||||
- integer
|
||||
- number
|
||||
description: 产品数量
|
||||
example: 2
|
||||
cart_status:
|
||||
type: string
|
||||
description: 购物车状态
|
||||
example: 有效
|
||||
cart_at_price:
|
||||
type:
|
||||
- integer
|
||||
- number
|
||||
description: 加入购物车时价格
|
||||
example: 1999
|
||||
cart_remark:
|
||||
type: string
|
||||
description: 备注
|
||||
example: 小程序加入购物车示例
|
||||
is_delete:
|
||||
type:
|
||||
- integer
|
||||
- number
|
||||
description: 软删除标记;目标契约字段,当前 hooks 响应可能尚未显式透出
|
||||
example: 0
|
||||
product_name:
|
||||
type: string
|
||||
description: 产品名称(服务端联动补充)
|
||||
example: BAI 智能主机
|
||||
product_modelnumber:
|
||||
type: string
|
||||
description: 产品型号(服务端联动补充)
|
||||
example: BAI-HOST-01
|
||||
product_basic_price:
|
||||
type:
|
||||
- integer
|
||||
- number
|
||||
- 'null'
|
||||
description: 产品基础价格(服务端联动补充)
|
||||
example: 1999
|
||||
|
||||
CartListRequest:
|
||||
type: object
|
||||
properties:
|
||||
keyword:
|
||||
type: string
|
||||
description: 对 `cart_id`、`cart_number`、`cart_product_id` 等索引相关字段的统一模糊搜索关键字
|
||||
example: CART-1770
|
||||
cart_status:
|
||||
type: string
|
||||
description: 购物车状态精确过滤
|
||||
example: 有效
|
||||
cart_number:
|
||||
type: string
|
||||
description: 购物车名称或分组号精确过滤
|
||||
example: wx-user-20260403153000
|
||||
|
||||
CartDetailRequest:
|
||||
type: object
|
||||
required:
|
||||
- cart_id
|
||||
properties:
|
||||
cart_id:
|
||||
type: string
|
||||
description: 购物车业务 ID
|
||||
example: CART-1770000000000-abc123
|
||||
|
||||
CartCreateRequest:
|
||||
type: object
|
||||
required:
|
||||
- cart_product_id
|
||||
- cart_product_quantity
|
||||
- cart_at_price
|
||||
properties:
|
||||
cart_number:
|
||||
type: string
|
||||
description: 可选;未传时服务端自动生成
|
||||
cart_product_id:
|
||||
type: string
|
||||
description: 产品业务 ID
|
||||
example: PROD-1770000000000-abcd12
|
||||
cart_product_quantity:
|
||||
type:
|
||||
- integer
|
||||
- number
|
||||
description: 产品数量,需为正整数
|
||||
example: 2
|
||||
cart_status:
|
||||
type: string
|
||||
description: 可选;未传时默认 `有效`
|
||||
example: 有效
|
||||
cart_at_price:
|
||||
type:
|
||||
- integer
|
||||
- number
|
||||
description: 加入购物车时价格
|
||||
example: 1999
|
||||
cart_remark:
|
||||
type: string
|
||||
description: 备注
|
||||
example: 小程序加入购物车示例
|
||||
|
||||
CartUpdateRequest:
|
||||
type: object
|
||||
required:
|
||||
- cart_id
|
||||
properties:
|
||||
cart_id:
|
||||
type: string
|
||||
description: 购物车业务 ID
|
||||
example: CART-1770000000000-abc123
|
||||
cart_number:
|
||||
type: string
|
||||
cart_product_id:
|
||||
type: string
|
||||
cart_product_quantity:
|
||||
type:
|
||||
- integer
|
||||
- number
|
||||
cart_status:
|
||||
type: string
|
||||
cart_at_price:
|
||||
type:
|
||||
- integer
|
||||
- number
|
||||
cart_remark:
|
||||
type: string
|
||||
|
||||
CartDeleteRequest:
|
||||
type: object
|
||||
required:
|
||||
- cart_id
|
||||
properties:
|
||||
cart_id:
|
||||
type: string
|
||||
description: 购物车业务 ID
|
||||
example: CART-1770000000000-abc123
|
||||
|
||||
CartListResponse:
|
||||
type: object
|
||||
properties:
|
||||
items:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi-wx.yaml#/components/schemas/CartRecord'
|
||||
|
||||
CartDeleteResponse:
|
||||
type: object
|
||||
properties:
|
||||
cart_id:
|
||||
type: string
|
||||
description: 购物车业务 ID
|
||||
example: CART-1770000000000-abc123
|
||||
is_delete:
|
||||
type:
|
||||
- integer
|
||||
- number
|
||||
description: 目标软删除标记值;当前实现可能仍返回物理删除结果
|
||||
example: 1
|
||||
134
pocket-base/spec/openapi-wx/schemas/cart-native.yaml
Normal file
134
pocket-base/spec/openapi-wx/schemas/cart-native.yaml
Normal file
@@ -0,0 +1,134 @@
|
||||
PocketBaseCartFields:
|
||||
type: object
|
||||
properties:
|
||||
cart_id:
|
||||
type: string
|
||||
description: 购物车业务 ID
|
||||
example: CART-1770000000000-abc123
|
||||
cart_number:
|
||||
type: string
|
||||
description: 购物车名称或分组号
|
||||
example: wx-user-20260403153000
|
||||
cart_create:
|
||||
type: string
|
||||
description: 购物车项创建时间,由数据库自动生成
|
||||
example: 2026-04-03 15:30:00.000Z
|
||||
cart_owner:
|
||||
type: string
|
||||
description: 购物车所有者 openid
|
||||
example: wx-openid-user-001
|
||||
cart_product_id:
|
||||
type: string
|
||||
description: 产品业务 ID
|
||||
example: PROD-1770000000000-abcd12
|
||||
cart_product_quantity:
|
||||
type:
|
||||
- integer
|
||||
- number
|
||||
description: 产品数量
|
||||
example: 2
|
||||
cart_status:
|
||||
type: string
|
||||
description: 购物车状态
|
||||
example: 有效
|
||||
cart_at_price:
|
||||
type:
|
||||
- number
|
||||
- integer
|
||||
description: 加入购物车时价格
|
||||
example: 1999
|
||||
cart_remark:
|
||||
type: string
|
||||
description: 备注
|
||||
example: 小程序加入购物车示例
|
||||
|
||||
PocketBaseCartRecord:
|
||||
allOf:
|
||||
- $ref: '../../openapi-wx.yaml#/components/schemas/PocketBaseRecordBase'
|
||||
- $ref: '../../openapi-wx.yaml#/components/schemas/PocketBaseCartFields'
|
||||
|
||||
PocketBaseCartCreateRequest:
|
||||
type: object
|
||||
required:
|
||||
- cart_id
|
||||
- cart_number
|
||||
- cart_owner
|
||||
- cart_product_id
|
||||
- cart_product_quantity
|
||||
- cart_status
|
||||
- cart_at_price
|
||||
properties:
|
||||
cart_id:
|
||||
type: string
|
||||
cart_number:
|
||||
type: string
|
||||
cart_owner:
|
||||
type: string
|
||||
description: 必须显式提交,且值必须等于当前 token 对应 openid
|
||||
cart_product_id:
|
||||
type: string
|
||||
cart_product_quantity:
|
||||
type:
|
||||
- integer
|
||||
- number
|
||||
cart_status:
|
||||
type: string
|
||||
cart_at_price:
|
||||
type:
|
||||
- number
|
||||
- integer
|
||||
cart_remark:
|
||||
type: string
|
||||
|
||||
PocketBaseCartUpdateRequest:
|
||||
type: object
|
||||
properties:
|
||||
cart_number:
|
||||
type: string
|
||||
cart_owner:
|
||||
type: string
|
||||
description: 若提交,必须仍等于当前 token 对应 openid
|
||||
cart_product_id:
|
||||
type: string
|
||||
cart_product_quantity:
|
||||
type:
|
||||
- integer
|
||||
- number
|
||||
cart_status:
|
||||
type: string
|
||||
cart_at_price:
|
||||
type:
|
||||
- number
|
||||
- integer
|
||||
cart_remark:
|
||||
type: string
|
||||
|
||||
PocketBaseCartListResponse:
|
||||
type: object
|
||||
required:
|
||||
- page
|
||||
- perPage
|
||||
- totalItems
|
||||
- totalPages
|
||||
- items
|
||||
properties:
|
||||
page:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
perPage:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
totalItems:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
totalPages:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
items:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi-wx.yaml#/components/schemas/PocketBaseCartRecord'
|
||||
125
pocket-base/spec/openapi-wx/schemas/common.yaml
Normal file
125
pocket-base/spec/openapi-wx/schemas/common.yaml
Normal file
@@ -0,0 +1,125 @@
|
||||
ApiResponseBase:
|
||||
type: object
|
||||
required:
|
||||
- statusCode
|
||||
- errMsg
|
||||
- data
|
||||
properties:
|
||||
statusCode:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
description: "业务状态码"
|
||||
example: 业务状态码 | integer
|
||||
errMsg:
|
||||
type: string
|
||||
description: "业务提示信息"
|
||||
example: 业务提示信息 | string
|
||||
data:
|
||||
description: "业务响应数据"
|
||||
type: object
|
||||
additionalProperties: true
|
||||
example:
|
||||
statusCode: 业务状态码 | integer
|
||||
errMsg: 业务提示信息 | string
|
||||
data:
|
||||
任意业务字段: 业务响应数据 | object
|
||||
|
||||
ErrorResponse:
|
||||
type: object
|
||||
required:
|
||||
- statusCode
|
||||
- errMsg
|
||||
- data
|
||||
properties:
|
||||
statusCode:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
description: "业务状态码"
|
||||
example: 业务状态码 | integer
|
||||
errMsg:
|
||||
type: string
|
||||
description: "业务提示信息"
|
||||
example: 失败原因提示 | string
|
||||
data:
|
||||
description: "业务响应数据"
|
||||
type: object
|
||||
additionalProperties: true
|
||||
example:
|
||||
statusCode: 业务状态码 | integer
|
||||
errMsg: 失败原因提示 | string
|
||||
data:
|
||||
任意错误字段: 错误附加信息 | object
|
||||
|
||||
HookRecordBase:
|
||||
type: object
|
||||
properties:
|
||||
pb_id:
|
||||
type: string
|
||||
description: PocketBase 记录主键 id
|
||||
example: l2r3nq7rqhuob0h
|
||||
created:
|
||||
type: string
|
||||
description: PocketBase 系统创建时间
|
||||
example: 2026-04-03 15:30:00.000Z
|
||||
updated:
|
||||
type: string
|
||||
description: PocketBase 系统更新时间
|
||||
example: 2026-04-03 15:35:00.000Z
|
||||
|
||||
PocketBaseNativeError:
|
||||
type: object
|
||||
properties:
|
||||
code:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
description: "业务状态码"
|
||||
example: 错误状态码 | integer
|
||||
message:
|
||||
type: string
|
||||
example: PocketBase原生错误信息 | string
|
||||
data:
|
||||
description: "业务响应数据"
|
||||
type: object
|
||||
additionalProperties: true
|
||||
example:
|
||||
code: 错误状态码 | integer
|
||||
message: PocketBase原生错误信息 | string
|
||||
data:
|
||||
任意错误字段: 原生错误附加信息 | object
|
||||
|
||||
PocketBaseRecordBase:
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- collectionId
|
||||
- collectionName
|
||||
- created
|
||||
- updated
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: "PocketBase 记录主键"
|
||||
example: PocketBase记录主键 | string
|
||||
collectionId:
|
||||
type: string
|
||||
example: 集合ID | string
|
||||
collectionName:
|
||||
type: string
|
||||
example: 集合名称 | string
|
||||
created:
|
||||
type: string
|
||||
description: "记录创建时间"
|
||||
example: 记录创建时间 | string
|
||||
updated:
|
||||
type: string
|
||||
description: "记录更新时间"
|
||||
example: 记录更新时间 | string
|
||||
example:
|
||||
id: PocketBase记录主键 | string
|
||||
collectionId: 集合ID | string
|
||||
collectionName: 集合名称 | string
|
||||
created: 记录创建时间 | string
|
||||
updated: 记录更新时间 | string
|
||||
412
pocket-base/spec/openapi-wx/schemas/company.yaml
Normal file
412
pocket-base/spec/openapi-wx/schemas/company.yaml
Normal file
@@ -0,0 +1,412 @@
|
||||
CompanyInfo:
|
||||
anyOf:
|
||||
- type: object
|
||||
description: 用户所属公司信息;当用户尚未绑定公司时返回 `null`
|
||||
properties:
|
||||
pb_id:
|
||||
type: string
|
||||
description: PocketBase 记录主键 id
|
||||
example: PocketBase记录主键id | string
|
||||
company_id:
|
||||
type: string
|
||||
description: 公司业务 id,由数据库自动生成
|
||||
example: 公司业务id,由数据库自动生成 | string
|
||||
company_name:
|
||||
type: string
|
||||
description: 公司名称
|
||||
example: 公司名称 | string
|
||||
company_type:
|
||||
type: string
|
||||
description: 公司类型
|
||||
example: 公司类型 | string
|
||||
company_entity:
|
||||
type: string
|
||||
description: 公司法人
|
||||
example: 公司法人 | string
|
||||
company_usci:
|
||||
type: string
|
||||
description: 统一社会信用代码
|
||||
example: 统一社会信用代码 | string
|
||||
company_nationality:
|
||||
type: string
|
||||
description: 国家名称
|
||||
example: 国家名称 | string
|
||||
company_nationality_code:
|
||||
type: string
|
||||
description: 国家编码
|
||||
example: 国家编码 | string
|
||||
company_province:
|
||||
type: string
|
||||
description: 省份名称
|
||||
example: 省份名称 | string
|
||||
company_province_code:
|
||||
type: string
|
||||
description: 省份编码
|
||||
example: 省份编码 | string
|
||||
company_city:
|
||||
type: string
|
||||
description: 城市名称
|
||||
example: 城市名称 | string
|
||||
company_city_code:
|
||||
type: string
|
||||
description: 城市编码
|
||||
example: 城市编码 | string
|
||||
company_district:
|
||||
type: string
|
||||
description: 区/县名称
|
||||
example: 区县名称 | string
|
||||
company_district_code:
|
||||
type: string
|
||||
description: 区/县编码
|
||||
example: 区县编码 | string
|
||||
company_postalcode:
|
||||
type: string
|
||||
description: 邮政编码
|
||||
example: 邮政编码 | string
|
||||
company_add:
|
||||
type: string
|
||||
description: 公司地址
|
||||
example: 公司地址 | string
|
||||
company_status:
|
||||
type: string
|
||||
description: 公司状态
|
||||
example: 公司状态 | string
|
||||
company_level:
|
||||
type: string
|
||||
description: 公司等级
|
||||
example: 公司等级 | string
|
||||
company_owner_openid:
|
||||
type: string
|
||||
description: 公司所有者 openid
|
||||
example: 公司所有者openid | string
|
||||
company_remark:
|
||||
type: string
|
||||
description: 备注
|
||||
example: 备注 | string
|
||||
created:
|
||||
type: string
|
||||
description: 记录创建时间
|
||||
example: 记录创建时间 | string
|
||||
updated:
|
||||
type: string
|
||||
description: 记录更新时间
|
||||
example: 记录更新时间 | string
|
||||
example:
|
||||
pb_id: PocketBase记录主键id | string
|
||||
company_id: 公司业务id,由数据库自动生成 | string
|
||||
company_name: 公司名称 | string
|
||||
company_type: 公司类型 | string
|
||||
company_entity: 公司法人 | string
|
||||
company_usci: 统一社会信用代码 | string
|
||||
company_nationality: 国家名称 | string
|
||||
company_nationality_code: 国家编码 | string
|
||||
company_province: 省份名称 | string
|
||||
company_province_code: 省份编码 | string
|
||||
company_city: 城市名称 | string
|
||||
company_city_code: 城市编码 | string
|
||||
company_district: 区县名称 | string
|
||||
company_district_code: 区县编码 | string
|
||||
company_postalcode: 邮政编码 | string
|
||||
company_add: 公司地址 | string
|
||||
company_status: 公司状态 | string
|
||||
company_level: 公司等级 | string
|
||||
company_owner_openid: 公司所有者openid | string
|
||||
company_remark: 备注 | string
|
||||
created: 记录创建时间 | string
|
||||
updated: 记录更新时间 | string
|
||||
- type: 'null'
|
||||
|
||||
PocketBaseCompanyFields:
|
||||
type: object
|
||||
properties:
|
||||
company_id:
|
||||
type: string
|
||||
description: 公司业务 id,由数据库自动生成
|
||||
example: 公司业务id,由数据库自动生成 | string
|
||||
company_name:
|
||||
type: string
|
||||
description: 公司名称
|
||||
example: 公司名称 | string
|
||||
company_type:
|
||||
type: string
|
||||
description: 公司类型
|
||||
example: 公司类型 | string
|
||||
company_entity:
|
||||
type: string
|
||||
description: 公司法人
|
||||
example: 公司法人 | string
|
||||
company_usci:
|
||||
type: string
|
||||
description: 统一社会信用代码
|
||||
example: 统一社会信用代码 | string
|
||||
company_nationality:
|
||||
type: string
|
||||
description: 国家名称
|
||||
example: 国家名称 | string
|
||||
company_nationality_code:
|
||||
type: string
|
||||
description: 国家编码
|
||||
example: 国家编码 | string
|
||||
company_province:
|
||||
type: string
|
||||
description: 省份名称
|
||||
example: 省份名称 | string
|
||||
company_province_code:
|
||||
type: string
|
||||
description: 省份编码
|
||||
example: 省份编码 | string
|
||||
company_city:
|
||||
type: string
|
||||
description: 城市名称
|
||||
example: 城市名称 | string
|
||||
company_city_code:
|
||||
type: string
|
||||
description: 城市编码
|
||||
example: 城市编码 | string
|
||||
company_district:
|
||||
type: string
|
||||
description: 区/县名称
|
||||
example: 区县名称 | string
|
||||
company_district_code:
|
||||
type: string
|
||||
description: 区/县编码
|
||||
example: 区县编码 | string
|
||||
company_postalcode:
|
||||
type: string
|
||||
description: 邮政编码
|
||||
example: 邮政编码 | string
|
||||
company_add:
|
||||
type: string
|
||||
description: 公司地址
|
||||
example: 公司地址 | string
|
||||
company_status:
|
||||
type: string
|
||||
description: 公司状态
|
||||
example: 公司状态 | string
|
||||
company_level:
|
||||
type: string
|
||||
description: 公司等级
|
||||
example: 公司等级 | string
|
||||
company_owner_openid:
|
||||
type: string
|
||||
description: 公司所有者 openid
|
||||
example: 公司所有者openid | string
|
||||
company_remark:
|
||||
type: string
|
||||
description: 备注
|
||||
example: 备注 | string
|
||||
|
||||
PocketBaseCompanyRecord:
|
||||
allOf:
|
||||
- $ref: '../../openapi-wx.yaml#/components/schemas/PocketBaseRecordBase'
|
||||
- $ref: '../../openapi-wx.yaml#/components/schemas/PocketBaseCompanyFields'
|
||||
example:
|
||||
id: PocketBase记录主键 | string
|
||||
collectionId: 集合ID | string
|
||||
collectionName: 集合名称 | string
|
||||
created: 记录创建时间 | string
|
||||
updated: 记录更新时间 | string
|
||||
company_id: 公司业务id,由数据库自动生成 | string
|
||||
company_name: 公司名称 | string
|
||||
company_type: 公司类型 | string
|
||||
company_entity: 公司法人 | string
|
||||
company_usci: 统一社会信用代码 | string
|
||||
company_nationality: 国家名称 | string
|
||||
company_nationality_code: 国家编码 | string
|
||||
company_province: 省份名称 | string
|
||||
company_province_code: 省份编码 | string
|
||||
company_city: 城市名称 | string
|
||||
company_city_code: 城市编码 | string
|
||||
company_district: 区县名称 | string
|
||||
company_district_code: 区县编码 | string
|
||||
company_postalcode: 邮政编码 | string
|
||||
company_add: 公司地址 | string
|
||||
company_status: 公司状态 | string
|
||||
company_level: 公司等级 | string
|
||||
company_owner_openid: 公司所有者openid | string
|
||||
company_remark: 备注 | string
|
||||
|
||||
PocketBaseCompanyCreateRequest:
|
||||
type: object
|
||||
properties:
|
||||
company_name:
|
||||
description: "公司名称"
|
||||
type: string
|
||||
company_type:
|
||||
description: "公司类型"
|
||||
type: string
|
||||
company_entity:
|
||||
description: "公司法人"
|
||||
type: string
|
||||
company_usci:
|
||||
description: "统一社会信用代码"
|
||||
type: string
|
||||
company_nationality:
|
||||
description: "国家名称"
|
||||
type: string
|
||||
company_nationality_code:
|
||||
description: "国家编码"
|
||||
type: string
|
||||
company_province:
|
||||
description: "省份名称"
|
||||
type: string
|
||||
company_province_code:
|
||||
description: "省份编码"
|
||||
type: string
|
||||
company_city:
|
||||
description: "城市名称"
|
||||
type: string
|
||||
company_city_code:
|
||||
description: "城市编码"
|
||||
type: string
|
||||
company_district:
|
||||
description: "区 / 县名称"
|
||||
type: string
|
||||
company_district_code:
|
||||
description: "区 / 县编码"
|
||||
type: string
|
||||
company_postalcode:
|
||||
description: "邮编"
|
||||
type: string
|
||||
company_add:
|
||||
description: "地址"
|
||||
type: string
|
||||
company_status:
|
||||
description: "公司状态"
|
||||
type: string
|
||||
company_level:
|
||||
description: "公司等级"
|
||||
type: string
|
||||
company_owner_openid:
|
||||
description: "公司所有者 openid"
|
||||
type: string
|
||||
company_remark:
|
||||
description: "备注"
|
||||
type: string
|
||||
additionalProperties: false
|
||||
|
||||
PocketBaseCompanyUpdateRequest:
|
||||
type: object
|
||||
properties:
|
||||
company_id:
|
||||
description: "所属公司业务 ID"
|
||||
type: string
|
||||
company_name:
|
||||
description: "公司名称"
|
||||
type: string
|
||||
company_type:
|
||||
description: "公司类型"
|
||||
type: string
|
||||
company_entity:
|
||||
description: "公司法人"
|
||||
type: string
|
||||
company_usci:
|
||||
description: "统一社会信用代码"
|
||||
type: string
|
||||
company_nationality:
|
||||
description: "国家名称"
|
||||
type: string
|
||||
company_nationality_code:
|
||||
description: "国家编码"
|
||||
type: string
|
||||
company_province:
|
||||
description: "省份名称"
|
||||
type: string
|
||||
company_province_code:
|
||||
description: "省份编码"
|
||||
type: string
|
||||
company_city:
|
||||
description: "城市名称"
|
||||
type: string
|
||||
company_city_code:
|
||||
description: "城市编码"
|
||||
type: string
|
||||
company_district:
|
||||
description: "区 / 县名称"
|
||||
type: string
|
||||
company_district_code:
|
||||
description: "区 / 县编码"
|
||||
type: string
|
||||
company_postalcode:
|
||||
description: "邮编"
|
||||
type: string
|
||||
company_add:
|
||||
description: "地址"
|
||||
type: string
|
||||
company_status:
|
||||
description: "公司状态"
|
||||
type: string
|
||||
company_level:
|
||||
description: "公司等级"
|
||||
type: string
|
||||
company_owner_openid:
|
||||
description: "公司所有者 openid"
|
||||
type: string
|
||||
company_remark:
|
||||
description: "备注"
|
||||
type: string
|
||||
additionalProperties: false
|
||||
|
||||
PocketBaseCompanyListResponse:
|
||||
type: object
|
||||
required:
|
||||
- page
|
||||
- perPage
|
||||
- totalItems
|
||||
- totalPages
|
||||
- items
|
||||
properties:
|
||||
page:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
example: 页码 | integer
|
||||
perPage:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
example: 每页条数 | integer
|
||||
totalItems:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
example: 总记录数 | integer
|
||||
totalPages:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
example: 总页数 | integer
|
||||
items:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi-wx.yaml#/components/schemas/PocketBaseCompanyRecord'
|
||||
example:
|
||||
page: 页码 | integer
|
||||
perPage: 每页条数 | integer
|
||||
totalItems: 总记录数 | integer
|
||||
totalPages: 总页数 | integer
|
||||
items:
|
||||
- id: PocketBase记录主键 | string
|
||||
collectionId: 集合ID | string
|
||||
collectionName: 集合名称 | string
|
||||
created: 记录创建时间 | string
|
||||
updated: 记录更新时间 | string
|
||||
company_id: 公司业务id,由数据库自动生成 | string
|
||||
company_name: 公司名称 | string
|
||||
company_type: 公司类型 | string
|
||||
company_entity: 公司法人 | string
|
||||
company_usci: 统一社会信用代码 | string
|
||||
company_nationality: 国家名称 | string
|
||||
company_nationality_code: 国家编码 | string
|
||||
company_province: 省份名称 | string
|
||||
company_province_code: 省份编码 | string
|
||||
company_city: 城市名称 | string
|
||||
company_city_code: 城市编码 | string
|
||||
company_district: 区县名称 | string
|
||||
company_district_code: 区县编码 | string
|
||||
company_postalcode: 邮政编码 | string
|
||||
company_add: 公司地址 | string
|
||||
company_status: 公司状态 | string
|
||||
company_level: 公司等级 | string
|
||||
company_owner_openid: 公司所有者openid | string
|
||||
company_remark: 备注 | string
|
||||
221
pocket-base/spec/openapi-wx/schemas/documents.yaml
Normal file
221
pocket-base/spec/openapi-wx/schemas/documents.yaml
Normal file
@@ -0,0 +1,221 @@
|
||||
PocketBaseDocumentFields:
|
||||
type: object
|
||||
properties:
|
||||
document_id:
|
||||
type: string
|
||||
description: "文档业务 ID"
|
||||
example: 文档业务ID | string
|
||||
document_create:
|
||||
type: string
|
||||
description: "文档创建时间,由数据库自动生成"
|
||||
example: 文档创建时间,由数据库自动生成 | string
|
||||
document_effect_date:
|
||||
type: string
|
||||
description: "文档生效日期"
|
||||
example: 文档生效日期 | string
|
||||
document_expiry_date:
|
||||
type: string
|
||||
description: "文档到期日期"
|
||||
example: 文档到期日期 | string
|
||||
document_title:
|
||||
type: string
|
||||
description: "文档标题"
|
||||
example: 文档标题 | string
|
||||
document_type:
|
||||
type: string
|
||||
description: "文档类型,多选时按 system_dict_id@dict_word_enum|... 保存"
|
||||
example: 文档类型,按system_dict_id@dict_word_enum保存 | string
|
||||
document_subtitle:
|
||||
type: string
|
||||
description: "文档副标题"
|
||||
example: 文档副标题 | string
|
||||
document_summary:
|
||||
type: string
|
||||
description: "文档摘要"
|
||||
example: 文档摘要 | string
|
||||
document_content:
|
||||
type: string
|
||||
description: "正文内容,保存 Markdown"
|
||||
example: 正文内容 | string
|
||||
document_image:
|
||||
type: string
|
||||
description: "图片附件 ID 集合,底层以 | 分隔"
|
||||
example: 图片附件ID串,底层按|分隔 | string
|
||||
document_video:
|
||||
type: string
|
||||
description: "视频附件 ID 集合,底层以 | 分隔"
|
||||
example: 视频附件ID串,底层按|分隔 | string
|
||||
document_file:
|
||||
type: string
|
||||
description: "文件附件 ID 集合,底层以 | 分隔"
|
||||
example: 文件附件ID串,底层按|分隔 | string
|
||||
document_status:
|
||||
type: string
|
||||
description: "文档状态,仅 `有效` / `过期`"
|
||||
example: 文档状态 | string
|
||||
document_owner:
|
||||
type: string
|
||||
description: "上传者 openid"
|
||||
example: 上传者openid | string
|
||||
document_relation_model:
|
||||
type: string
|
||||
description: "关联机型 / 模型标识"
|
||||
example: 关联机型标识 | string
|
||||
document_keywords:
|
||||
type: string
|
||||
description: "关键词,多选后以 | 分隔"
|
||||
example: 关键词,多选按|分隔 | string
|
||||
document_share_count:
|
||||
type: number
|
||||
description: "分享次数"
|
||||
example: 0
|
||||
document_download_count:
|
||||
type: number
|
||||
description: "下载次数"
|
||||
example: 0
|
||||
document_favorite_count:
|
||||
type: number
|
||||
description: "收藏次数"
|
||||
example: 0
|
||||
document_embedding_status:
|
||||
type: string
|
||||
description: "文档嵌入状态"
|
||||
example: 文档嵌入状态 | string
|
||||
document_embedding_error:
|
||||
type: string
|
||||
description: "文档嵌入错误原因"
|
||||
example: 文档嵌入错误原因 | string
|
||||
document_embedding_lasttime:
|
||||
type: string
|
||||
description: "最后一次嵌入更新时间"
|
||||
example: 最后一次嵌入更新时间 | string
|
||||
document_vector_version:
|
||||
type: string
|
||||
description: "向量版本号 / 模型名称"
|
||||
example: 向量版本号或模型名称 | string
|
||||
document_product_categories:
|
||||
type: string
|
||||
description: "产品关联文档,多选后以 | 分隔"
|
||||
example: 产品关联文档,多选按|分隔 | string
|
||||
document_application_scenarios:
|
||||
type: string
|
||||
description: "筛选依据,多选后以 | 分隔"
|
||||
example: 筛选依据,多选按|分隔 | string
|
||||
document_hotel_type:
|
||||
type: string
|
||||
description: "适用场景,多选后以 | 分隔"
|
||||
example: 适用场景,多选按|分隔 | string
|
||||
document_remark:
|
||||
type: string
|
||||
description: "备注"
|
||||
example: 备注 | string
|
||||
|
||||
PocketBaseDocumentRecord:
|
||||
allOf:
|
||||
- $ref: '../../openapi-wx.yaml#/components/schemas/PocketBaseRecordBase'
|
||||
- $ref: '../../openapi-wx.yaml#/components/schemas/PocketBaseDocumentFields'
|
||||
example:
|
||||
id: PocketBase记录主键 | string
|
||||
collectionId: 集合ID | string
|
||||
collectionName: 集合名称 | string
|
||||
created: 记录创建时间 | string
|
||||
updated: 记录更新时间 | string
|
||||
document_id: 文档业务ID | string
|
||||
document_create: 文档创建时间,由数据库自动生成 | string
|
||||
document_effect_date: 文档生效日期 | string
|
||||
document_expiry_date: 文档到期日期 | string
|
||||
document_title: 文档标题 | string
|
||||
document_type: 文档类型,按system_dict_id@dict_word_enum保存 | string
|
||||
document_subtitle: 文档副标题 | string
|
||||
document_summary: 文档摘要 | string
|
||||
document_content: 正文内容 | string
|
||||
document_image: 图片附件ID串,底层按|分隔 | string
|
||||
document_video: 视频附件ID串,底层按|分隔 | string
|
||||
document_file: 文件附件ID串,底层按|分隔 | string
|
||||
document_status: 文档状态 | string
|
||||
document_owner: 上传者openid | string
|
||||
document_relation_model: 关联机型标识 | string
|
||||
document_keywords: 关键词,多选按|分隔 | string
|
||||
document_share_count: 0
|
||||
document_download_count: 0
|
||||
document_favorite_count: 0
|
||||
document_embedding_status: 文档嵌入状态 | string
|
||||
document_embedding_error: 文档嵌入错误原因 | string
|
||||
document_embedding_lasttime: 最后一次嵌入更新时间 | string
|
||||
document_vector_version: 向量版本号或模型名称 | string
|
||||
document_product_categories: 产品关联文档,多选按|分隔 | string
|
||||
document_application_scenarios: 筛选依据,多选按|分隔 | string
|
||||
document_hotel_type: 适用场景,多选按|分隔 | string
|
||||
document_remark: 备注 | string
|
||||
|
||||
PocketBaseDocumentListResponse:
|
||||
type: object
|
||||
required:
|
||||
- page
|
||||
- perPage
|
||||
- totalItems
|
||||
- totalPages
|
||||
- items
|
||||
properties:
|
||||
page:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
example: 页码 | integer
|
||||
perPage:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
example: 每页条数 | integer
|
||||
totalItems:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
example: 总记录数 | integer
|
||||
totalPages:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
example: 总页数 | integer
|
||||
items:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi-wx.yaml#/components/schemas/PocketBaseDocumentRecord'
|
||||
example:
|
||||
page: 页码 | integer
|
||||
perPage: 每页条数 | integer
|
||||
totalItems: 总记录数 | integer
|
||||
totalPages: 总页数 | integer
|
||||
items:
|
||||
- id: PocketBase记录主键 | string
|
||||
collectionId: 集合ID | string
|
||||
collectionName: 集合名称 | string
|
||||
created: 记录创建时间 | string
|
||||
updated: 记录更新时间 | string
|
||||
document_id: 文档业务ID | string
|
||||
document_create: 文档创建时间,由数据库自动生成 | string
|
||||
document_effect_date: 文档生效日期 | string
|
||||
document_expiry_date: 文档到期日期 | string
|
||||
document_title: 文档标题 | string
|
||||
document_type: 文档类型,按system_dict_id@dict_word_enum保存 | string
|
||||
document_subtitle: 文档副标题 | string
|
||||
document_summary: 文档摘要 | string
|
||||
document_content: 正文内容 | string
|
||||
document_image: 图片附件ID串,底层按|分隔 | string
|
||||
document_video: 视频附件ID串,底层按|分隔 | string
|
||||
document_file: 文件附件ID串,底层按|分隔 | string
|
||||
document_status: 文档状态 | string
|
||||
document_owner: 上传者openid | string
|
||||
document_relation_model: 关联机型标识 | string
|
||||
document_keywords: 关键词,多选按|分隔 | string
|
||||
document_share_count: 0
|
||||
document_download_count: 0
|
||||
document_favorite_count: 0
|
||||
document_embedding_status: 文档嵌入状态 | string
|
||||
document_embedding_error: 文档嵌入错误原因 | string
|
||||
document_embedding_lasttime: 最后一次嵌入更新时间 | string
|
||||
document_vector_version: 向量版本号或模型名称 | string
|
||||
document_product_categories: 产品关联文档,多选按|分隔 | string
|
||||
document_application_scenarios: 筛选依据,多选按|分隔 | string
|
||||
document_hotel_type: 适用场景,多选按|分隔 | string
|
||||
document_remark: 备注 | string
|
||||
191
pocket-base/spec/openapi-wx/schemas/order-hooks.yaml
Normal file
191
pocket-base/spec/openapi-wx/schemas/order-hooks.yaml
Normal file
@@ -0,0 +1,191 @@
|
||||
OrderRecord:
|
||||
allOf:
|
||||
- $ref: '../../openapi-wx.yaml#/components/schemas/HookRecordBase'
|
||||
- type: object
|
||||
properties:
|
||||
order_id:
|
||||
type: string
|
||||
description: 订单业务 ID
|
||||
example: ORDER-1770000000000-abc123
|
||||
order_number:
|
||||
type: string
|
||||
description: 订单编号
|
||||
example: wx-user-20260403153500
|
||||
order_create:
|
||||
type: string
|
||||
description: 订单创建时间,由数据库自动生成
|
||||
example: 2026-04-03 15:35:00.000Z
|
||||
order_owner:
|
||||
type: string
|
||||
description: 订单所有者 openid
|
||||
example: wx-openid-user-001
|
||||
order_source:
|
||||
type: string
|
||||
description: 订单来源
|
||||
example: 购物车
|
||||
order_status:
|
||||
type: string
|
||||
description: 订单状态
|
||||
example: 订单已生成
|
||||
order_source_id:
|
||||
type: string
|
||||
description: 来源关联业务 ID
|
||||
example: CART-1770000000000-abc123
|
||||
order_snap:
|
||||
description: 订单快照 JSON
|
||||
oneOf:
|
||||
- type: object
|
||||
additionalProperties: true
|
||||
- type: array
|
||||
items:
|
||||
type: object
|
||||
additionalProperties: true
|
||||
order_amount:
|
||||
type:
|
||||
- integer
|
||||
- number
|
||||
description: 订单金额
|
||||
example: 3998
|
||||
order_remark:
|
||||
type: string
|
||||
description: 备注
|
||||
example: 小程序订单示例
|
||||
is_delete:
|
||||
type:
|
||||
- integer
|
||||
- number
|
||||
description: 软删除标记;目标契约字段,当前 hooks 响应可能尚未显式透出
|
||||
example: 0
|
||||
|
||||
OrderListRequest:
|
||||
type: object
|
||||
properties:
|
||||
keyword:
|
||||
type: string
|
||||
description: 对 `order_id`、`order_number`、`order_source_id` 等索引相关字段的统一模糊搜索关键字
|
||||
example: ORDER-1770
|
||||
order_status:
|
||||
type: string
|
||||
description: 订单状态精确过滤
|
||||
example: 订单已生成
|
||||
order_source:
|
||||
type: string
|
||||
description: 订单来源精确过滤
|
||||
example: 购物车
|
||||
|
||||
OrderDetailRequest:
|
||||
type: object
|
||||
required:
|
||||
- order_id
|
||||
properties:
|
||||
order_id:
|
||||
type: string
|
||||
description: 订单业务 ID
|
||||
example: ORDER-1770000000000-abc123
|
||||
|
||||
OrderCreateRequest:
|
||||
type: object
|
||||
required:
|
||||
- order_source
|
||||
- order_source_id
|
||||
- order_snap
|
||||
- order_amount
|
||||
properties:
|
||||
order_number:
|
||||
type: string
|
||||
description: 可选;未传时服务端自动生成
|
||||
order_source:
|
||||
type: string
|
||||
description: 订单来源
|
||||
example: 购物车
|
||||
order_status:
|
||||
type: string
|
||||
description: 可选;未传时默认 `订单已生成`
|
||||
example: 订单已生成
|
||||
order_source_id:
|
||||
type: string
|
||||
description: 来源关联业务 ID
|
||||
example: CART-1770000000000-abc123
|
||||
order_snap:
|
||||
description: 订单快照 JSON
|
||||
oneOf:
|
||||
- type: object
|
||||
additionalProperties: true
|
||||
- type: array
|
||||
items:
|
||||
type: object
|
||||
additionalProperties: true
|
||||
order_amount:
|
||||
type:
|
||||
- integer
|
||||
- number
|
||||
description: 订单金额
|
||||
example: 3998
|
||||
order_remark:
|
||||
type: string
|
||||
description: 备注
|
||||
example: 小程序订单示例
|
||||
|
||||
OrderUpdateRequest:
|
||||
type: object
|
||||
required:
|
||||
- order_id
|
||||
properties:
|
||||
order_id:
|
||||
type: string
|
||||
description: 订单业务 ID
|
||||
example: ORDER-1770000000000-abc123
|
||||
order_number:
|
||||
type: string
|
||||
order_source:
|
||||
type: string
|
||||
order_status:
|
||||
type: string
|
||||
order_source_id:
|
||||
type: string
|
||||
order_snap:
|
||||
oneOf:
|
||||
- type: object
|
||||
additionalProperties: true
|
||||
- type: array
|
||||
items:
|
||||
type: object
|
||||
additionalProperties: true
|
||||
order_amount:
|
||||
type:
|
||||
- integer
|
||||
- number
|
||||
order_remark:
|
||||
type: string
|
||||
|
||||
OrderDeleteRequest:
|
||||
type: object
|
||||
required:
|
||||
- order_id
|
||||
properties:
|
||||
order_id:
|
||||
type: string
|
||||
description: 订单业务 ID
|
||||
example: ORDER-1770000000000-abc123
|
||||
|
||||
OrderListResponse:
|
||||
type: object
|
||||
properties:
|
||||
items:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi-wx.yaml#/components/schemas/OrderRecord'
|
||||
|
||||
OrderDeleteResponse:
|
||||
type: object
|
||||
properties:
|
||||
order_id:
|
||||
type: string
|
||||
description: 订单业务 ID
|
||||
example: ORDER-1770000000000-abc123
|
||||
is_delete:
|
||||
type:
|
||||
- integer
|
||||
- number
|
||||
description: 目标软删除标记值;当前实现可能仍返回物理删除结果
|
||||
example: 1
|
||||
154
pocket-base/spec/openapi-wx/schemas/order-native.yaml
Normal file
154
pocket-base/spec/openapi-wx/schemas/order-native.yaml
Normal file
@@ -0,0 +1,154 @@
|
||||
PocketBaseOrderFields:
|
||||
type: object
|
||||
properties:
|
||||
order_id:
|
||||
type: string
|
||||
description: 订单业务 ID
|
||||
example: ORDER-1770000000000-abc123
|
||||
order_number:
|
||||
type: string
|
||||
description: 订单编号
|
||||
example: wx-user-20260403153500
|
||||
order_create:
|
||||
type: string
|
||||
description: 订单创建时间,由数据库自动生成
|
||||
example: 2026-04-03 15:35:00.000Z
|
||||
order_owner:
|
||||
type: string
|
||||
description: 订单所有者 openid
|
||||
example: wx-openid-user-001
|
||||
order_source:
|
||||
type: string
|
||||
description: 订单来源
|
||||
example: 购物车
|
||||
order_status:
|
||||
type: string
|
||||
description: 订单状态
|
||||
example: 订单已生成
|
||||
order_source_id:
|
||||
type: string
|
||||
description: 来源关联业务 ID
|
||||
example: CART-1770000000000-abc123
|
||||
order_snap:
|
||||
description: 订单快照 JSON
|
||||
oneOf:
|
||||
- type: object
|
||||
additionalProperties: true
|
||||
- type: array
|
||||
items:
|
||||
type: object
|
||||
additionalProperties: true
|
||||
order_amount:
|
||||
type:
|
||||
- number
|
||||
- integer
|
||||
description: 订单金额
|
||||
example: 3998
|
||||
order_remark:
|
||||
type: string
|
||||
description: 备注
|
||||
example: 小程序订单示例
|
||||
|
||||
PocketBaseOrderRecord:
|
||||
allOf:
|
||||
- $ref: '../../openapi-wx.yaml#/components/schemas/PocketBaseRecordBase'
|
||||
- $ref: '../../openapi-wx.yaml#/components/schemas/PocketBaseOrderFields'
|
||||
|
||||
PocketBaseOrderCreateRequest:
|
||||
type: object
|
||||
required:
|
||||
- order_id
|
||||
- order_number
|
||||
- order_owner
|
||||
- order_source
|
||||
- order_status
|
||||
- order_source_id
|
||||
- order_snap
|
||||
- order_amount
|
||||
properties:
|
||||
order_id:
|
||||
type: string
|
||||
order_number:
|
||||
type: string
|
||||
order_owner:
|
||||
type: string
|
||||
description: 必须显式提交,且值必须等于当前 token 对应 openid
|
||||
order_source:
|
||||
type: string
|
||||
order_status:
|
||||
type: string
|
||||
order_source_id:
|
||||
type: string
|
||||
order_snap:
|
||||
oneOf:
|
||||
- type: object
|
||||
additionalProperties: true
|
||||
- type: array
|
||||
items:
|
||||
type: object
|
||||
additionalProperties: true
|
||||
order_amount:
|
||||
type:
|
||||
- number
|
||||
- integer
|
||||
order_remark:
|
||||
type: string
|
||||
|
||||
PocketBaseOrderUpdateRequest:
|
||||
type: object
|
||||
properties:
|
||||
order_number:
|
||||
type: string
|
||||
order_owner:
|
||||
type: string
|
||||
description: 若提交,必须仍等于当前 token 对应 openid
|
||||
order_source:
|
||||
type: string
|
||||
order_status:
|
||||
type: string
|
||||
order_source_id:
|
||||
type: string
|
||||
order_snap:
|
||||
oneOf:
|
||||
- type: object
|
||||
additionalProperties: true
|
||||
- type: array
|
||||
items:
|
||||
type: object
|
||||
additionalProperties: true
|
||||
order_amount:
|
||||
type:
|
||||
- number
|
||||
- integer
|
||||
order_remark:
|
||||
type: string
|
||||
|
||||
PocketBaseOrderListResponse:
|
||||
type: object
|
||||
required:
|
||||
- page
|
||||
- perPage
|
||||
- totalItems
|
||||
- totalPages
|
||||
- items
|
||||
properties:
|
||||
page:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
perPage:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
totalItems:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
totalPages:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
items:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi-wx.yaml#/components/schemas/PocketBaseOrderRecord'
|
||||
203
pocket-base/spec/openapi-wx/schemas/products.yaml
Normal file
203
pocket-base/spec/openapi-wx/schemas/products.yaml
Normal file
@@ -0,0 +1,203 @@
|
||||
PocketBaseProductListFields:
|
||||
type: object
|
||||
properties:
|
||||
prod_list_id:
|
||||
type: string
|
||||
description: 产品列表业务 ID,唯一标识
|
||||
example: <产品列表业务ID>|<string>
|
||||
prod_list_name:
|
||||
type: string
|
||||
description: 产品名称
|
||||
example: <产品名称>|<string>
|
||||
prod_list_modelnumber:
|
||||
type: string
|
||||
description: 产品型号
|
||||
example: <产品型号>|<string>
|
||||
prod_list_icon:
|
||||
type: string
|
||||
description: 产品图标附件 ID,保存 `tbl_attachments.attachments_id`
|
||||
example: <产品图标附件ID>|<string>
|
||||
prod_list_description:
|
||||
type: string
|
||||
description: 产品说明
|
||||
example: <产品说明>|<string>
|
||||
prod_list_feature:
|
||||
type: string
|
||||
description: 产品特色
|
||||
example: <产品特色>|<string>
|
||||
prod_list_parameters:
|
||||
type: array
|
||||
description: 产品参数数组,每项包含 name/value
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
example: <属性名>|<string>
|
||||
value:
|
||||
type: string
|
||||
example: <属性值>|<string>
|
||||
example:
|
||||
- name: <属性名>|<string>
|
||||
value: <属性值>|<string>
|
||||
prod_list_plantype:
|
||||
type: string
|
||||
description: 产品方案
|
||||
example: <产品方案>|<string>
|
||||
prod_list_category:
|
||||
type: string
|
||||
description: 产品分类(必填,单选)
|
||||
example: <产品分类>|<string>
|
||||
prod_list_sort:
|
||||
type:
|
||||
- number
|
||||
- integer
|
||||
description: 排序值(同分类内按升序)
|
||||
example: 10
|
||||
prod_list_comm_type:
|
||||
type: string
|
||||
description: 通讯类型
|
||||
example: <通讯类型>|<string>
|
||||
prod_list_series:
|
||||
type: string
|
||||
description: 产品系列
|
||||
example: <产品系列>|<string>
|
||||
prod_list_power_supply:
|
||||
type: string
|
||||
description: 供电方式
|
||||
example: <供电方式>|<string>
|
||||
prod_list_tags:
|
||||
type: string
|
||||
description: 产品标签(辅助检索,以 `|` 聚合)
|
||||
example: <产品标签>|<string>
|
||||
prod_list_status:
|
||||
type: string
|
||||
description: 产品状态(有效 / 过期 / 主推等)
|
||||
example: <产品状态>|<string>
|
||||
prod_list_basic_price:
|
||||
type:
|
||||
- number
|
||||
- integer
|
||||
description: 基础价格
|
||||
example: 1999
|
||||
prod_list_vip_price:
|
||||
type: array
|
||||
description: 会员价数组,每项包含会员等级枚举值与价格
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
viplevel:
|
||||
type: string
|
||||
example: <会员等级枚举值>|<string>
|
||||
price:
|
||||
type:
|
||||
- number
|
||||
- integer
|
||||
example: 1899
|
||||
example:
|
||||
- viplevel: VIP1
|
||||
price: 1899
|
||||
prod_list_remark:
|
||||
type: string
|
||||
description: 备注
|
||||
example: <备注>|<string>
|
||||
|
||||
PocketBaseProductListRecord:
|
||||
allOf:
|
||||
- $ref: '../../openapi-wx.yaml#/components/schemas/PocketBaseRecordBase'
|
||||
- $ref: '../../openapi-wx.yaml#/components/schemas/PocketBaseProductListFields'
|
||||
example:
|
||||
id: <PocketBase记录主键>|<string>
|
||||
collectionId: <集合ID>|<string>
|
||||
collectionName: <集合名称>|<string>
|
||||
created: <记录创建时间>|<string>
|
||||
updated: <记录更新时间>|<string>
|
||||
prod_list_id: <产品列表业务ID>|<string>
|
||||
prod_list_name: <产品名称>|<string>
|
||||
prod_list_modelnumber: <产品型号>|<string>
|
||||
prod_list_icon: <产品图标附件ID>|<string>
|
||||
prod_list_description: <产品说明>|<string>
|
||||
prod_list_feature: <产品特色>|<string>
|
||||
prod_list_parameters:
|
||||
- name: <属性名>|<string>
|
||||
value: <属性值>|<string>
|
||||
prod_list_plantype: <产品方案>|<string>
|
||||
prod_list_category: <产品分类>|<string>
|
||||
prod_list_sort: 10
|
||||
prod_list_comm_type: <通讯类型>|<string>
|
||||
prod_list_series: <产品系列>|<string>
|
||||
prod_list_power_supply: <供电方式>|<string>
|
||||
prod_list_tags: <产品标签>|<string>
|
||||
prod_list_status: <产品状态>|<string>
|
||||
prod_list_basic_price: 1999
|
||||
prod_list_vip_price:
|
||||
- viplevel: VIP1
|
||||
price: 1899
|
||||
prod_list_remark: <备注>|<string>
|
||||
|
||||
PocketBaseProductListListResponse:
|
||||
type: object
|
||||
required:
|
||||
- page
|
||||
- perPage
|
||||
- totalItems
|
||||
- totalPages
|
||||
- items
|
||||
properties:
|
||||
page:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
example: <页码>|<integer>
|
||||
perPage:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
example: <每页条数>|<integer>
|
||||
totalItems:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
example: <总记录数>|<integer>
|
||||
totalPages:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
example: <总页数>|<integer>
|
||||
items:
|
||||
type: array
|
||||
items:
|
||||
$ref: '../../openapi-wx.yaml#/components/schemas/PocketBaseProductListRecord'
|
||||
example:
|
||||
page: <页码>|<integer>
|
||||
perPage: <每页条数>|<integer>
|
||||
totalItems: <总记录数>|<integer>
|
||||
totalPages: <总页数>|<integer>
|
||||
items:
|
||||
- id: <PocketBase记录主键>|<string>
|
||||
collectionId: <集合ID>|<string>
|
||||
collectionName: <集合名称>|<string>
|
||||
created: <记录创建时间>|<string>
|
||||
updated: <记录更新时间>|<string>
|
||||
prod_list_id: <产品列表业务ID>|<string>
|
||||
prod_list_name: <产品名称>|<string>
|
||||
prod_list_modelnumber: <产品型号>|<string>
|
||||
prod_list_icon: <产品图标附件ID>|<string>
|
||||
prod_list_description: <产品说明>|<string>
|
||||
prod_list_feature: <产品特色>|<string>
|
||||
prod_list_parameters:
|
||||
- name: <属性名>|<string>
|
||||
value: <属性值>|<string>
|
||||
prod_list_plantype: <产品方案>|<string>
|
||||
prod_list_category: <产品分类>|<string>
|
||||
prod_list_sort: 10
|
||||
prod_list_comm_type: <通讯类型>|<string>
|
||||
prod_list_series: <产品系列>|<string>
|
||||
prod_list_power_supply: <供电方式>|<string>
|
||||
prod_list_tags: <产品标签>|<string>
|
||||
prod_list_status: <产品状态>|<string>
|
||||
prod_list_basic_price: 1999
|
||||
prod_list_vip_price:
|
||||
- viplevel: VIP1
|
||||
price: 1899
|
||||
prod_list_remark: <备注>|<string>
|
||||
55
pocket-base/spec/openapi-wx/schemas/system.yaml
Normal file
55
pocket-base/spec/openapi-wx/schemas/system.yaml
Normal file
@@ -0,0 +1,55 @@
|
||||
SystemRefreshTokenRequest:
|
||||
type: object
|
||||
properties:
|
||||
users_wx_code:
|
||||
type:
|
||||
- string
|
||||
- 'null'
|
||||
description: |
|
||||
可选。
|
||||
当前 token 失效时,可通过该 code 重新签发 token。
|
||||
example: 0a1b2c3d4e5f6g
|
||||
|
||||
RefreshTokenResponse:
|
||||
allOf:
|
||||
- $ref: '../../openapi-wx.yaml#/components/schemas/ApiResponseBase'
|
||||
- type: object
|
||||
required:
|
||||
- token
|
||||
properties:
|
||||
data:
|
||||
type: object
|
||||
additionalProperties: true
|
||||
description: "业务响应数据"
|
||||
example: {}
|
||||
token:
|
||||
type: string
|
||||
description: 新签发的 PocketBase 原生 auth token
|
||||
example:
|
||||
statusCode: 业务状态码 | integer
|
||||
errMsg: 刷新成功 | string
|
||||
data: {}
|
||||
token: 新签发的PocketBase原生auth token | string
|
||||
|
||||
UsersCountData:
|
||||
type: object
|
||||
properties:
|
||||
total_users:
|
||||
type:
|
||||
- integer
|
||||
- string
|
||||
example: 用户总数 | integer
|
||||
|
||||
UsersCountResponse:
|
||||
allOf:
|
||||
- $ref: '../../openapi-wx.yaml#/components/schemas/ApiResponseBase'
|
||||
- type: object
|
||||
properties:
|
||||
data:
|
||||
description: "业务响应数据"
|
||||
$ref: '../../openapi-wx.yaml#/components/schemas/UsersCountData'
|
||||
example:
|
||||
statusCode: 业务状态码 | integer
|
||||
errMsg: 业务提示信息 | string
|
||||
data:
|
||||
total_users: 用户总数 | integer
|
||||
389
pocket-base/spec/openapi-wx/schemas/wechat-auth.yaml
Normal file
389
pocket-base/spec/openapi-wx/schemas/wechat-auth.yaml
Normal file
@@ -0,0 +1,389 @@
|
||||
UserInfo:
|
||||
type: object
|
||||
properties:
|
||||
pb_id:
|
||||
description: "PocketBase 记录主键 id"
|
||||
type: string
|
||||
users_convers_id:
|
||||
description: "会话侧用户 ID"
|
||||
type: string
|
||||
users_id:
|
||||
description: "用户业务 ID"
|
||||
type: string
|
||||
users_idtype:
|
||||
description: "身份来源类型或证件类型"
|
||||
anyOf:
|
||||
- type: string
|
||||
enum:
|
||||
- WeChat
|
||||
- ManagePlatform
|
||||
- type: string
|
||||
users_id_number:
|
||||
description: "证件号"
|
||||
type: string
|
||||
users_type:
|
||||
description: "用户类型"
|
||||
anyOf:
|
||||
- type: string
|
||||
enum:
|
||||
- 游客
|
||||
- 注册用户
|
||||
- type: string
|
||||
users_name:
|
||||
description: "用户姓名 / 昵称"
|
||||
type: string
|
||||
users_status:
|
||||
description: "用户状态"
|
||||
type:
|
||||
- string
|
||||
- number
|
||||
users_rank_level:
|
||||
description: "用户星级数值"
|
||||
type:
|
||||
- number
|
||||
- integer
|
||||
- string
|
||||
users_auth_type:
|
||||
description: "账户类型"
|
||||
type:
|
||||
- number
|
||||
- integer
|
||||
- string
|
||||
users_phone:
|
||||
description: "手机号"
|
||||
type: string
|
||||
users_phone_masked:
|
||||
type: string
|
||||
users_level:
|
||||
type: string
|
||||
description: 用户等级
|
||||
users_level_name:
|
||||
type: string
|
||||
description: 用户等级名称,按 `users_level -> 数据-会员等级` 字典描述实时解析
|
||||
users_tag:
|
||||
type: string
|
||||
description: 用户标签
|
||||
users_picture:
|
||||
type: string
|
||||
description: 用户头像附件的 `attachments_id`
|
||||
users_picture_url:
|
||||
type: string
|
||||
description: 根据 `users_picture -> tbl_attachments` 自动解析出的头像文件流链接
|
||||
users_id_pic_a:
|
||||
type: string
|
||||
description: 证件正面附件的 `attachments_id`
|
||||
users_id_pic_a_url:
|
||||
type: string
|
||||
description: 根据 `users_id_pic_a -> tbl_attachments` 自动解析出的文件流链接
|
||||
users_id_pic_b:
|
||||
type: string
|
||||
description: 证件反面附件的 `attachments_id`
|
||||
users_id_pic_b_url:
|
||||
type: string
|
||||
description: 根据 `users_id_pic_b -> tbl_attachments` 自动解析出的文件流链接
|
||||
users_title_picture:
|
||||
type: string
|
||||
description: 资质附件的 `attachments_id`
|
||||
users_title_picture_url:
|
||||
type: string
|
||||
description: 根据 `users_title_picture -> tbl_attachments` 自动解析出的文件流链接
|
||||
openid:
|
||||
type: string
|
||||
description: 全平台统一身份标识
|
||||
company_id:
|
||||
type: string
|
||||
description: 公司业务 id,存储 `tbl_company.company_id`
|
||||
users_parent_id:
|
||||
type: string
|
||||
description: 上级用户业务 id
|
||||
users_promo_code:
|
||||
type: string
|
||||
description: 推广码
|
||||
usergroups_id:
|
||||
type: string
|
||||
description: 用户组业务 id
|
||||
company:
|
||||
$ref: '../../openapi-wx.yaml#/components/schemas/CompanyInfo'
|
||||
created:
|
||||
type: string
|
||||
description: 用户创建时间
|
||||
updated:
|
||||
type: string
|
||||
description: 用户更新时间
|
||||
example:
|
||||
pb_id: PocketBase记录主键id | string
|
||||
users_convers_id: 会话侧用户ID | string
|
||||
users_id: 用户业务ID | string
|
||||
users_idtype: 用户身份来源类型 | string
|
||||
users_id_number: 证件号 | string
|
||||
users_type: 用户类型 | string
|
||||
users_name: 用户姓名或昵称 | string
|
||||
users_status: 用户状态 | string
|
||||
users_rank_level: 用户星级数值 | number
|
||||
users_auth_type: 账户类型 | number
|
||||
users_phone: 手机号 | string
|
||||
users_phone_masked: 手机号脱敏值 | string
|
||||
users_level: 用户等级 | string
|
||||
users_level_name: 用户等级名称 | string
|
||||
users_tag: 用户标签 | string
|
||||
users_picture: 用户头像附件ID | string
|
||||
users_picture_url: 用户头像文件流链接 | string
|
||||
users_id_pic_a: 证件正面附件ID | string
|
||||
users_id_pic_a_url: 证件正面文件流链接 | string
|
||||
users_id_pic_b: 证件反面附件ID | string
|
||||
users_id_pic_b_url: 证件反面文件流链接 | string
|
||||
users_title_picture: 资质附件ID | string
|
||||
users_title_picture_url: 资质附件文件流链接 | string
|
||||
openid: 全平台统一身份标识 | string
|
||||
company_id: 公司业务id | string
|
||||
users_parent_id: 上级用户业务id | string
|
||||
users_promo_code: 推广码 | string
|
||||
usergroups_id: 用户组业务id | string
|
||||
company:
|
||||
pb_id: PocketBase记录主键id | string
|
||||
company_id: 公司业务id,由数据库自动生成 | string
|
||||
company_name: 公司名称 | string
|
||||
company_type: 公司类型 | string
|
||||
company_entity: 公司法人 | string
|
||||
company_usci: 统一社会信用代码 | string
|
||||
company_nationality: 国家名称 | string
|
||||
company_nationality_code: 国家编码 | string
|
||||
company_province: 省份名称 | string
|
||||
company_province_code: 省份编码 | string
|
||||
company_city: 城市名称 | string
|
||||
company_city_code: 城市编码 | string
|
||||
company_district: 区县名称 | string
|
||||
company_district_code: 区县编码 | string
|
||||
company_postalcode: 邮政编码 | string
|
||||
company_add: 公司地址 | string
|
||||
company_status: 公司状态 | string
|
||||
company_level: 公司等级 | string
|
||||
company_owner_openid: 公司所有者openid | string
|
||||
company_remark: 备注 | string
|
||||
created: 记录创建时间 | string
|
||||
updated: 记录更新时间 | string
|
||||
created: 用户创建时间 | string
|
||||
updated: 用户更新时间 | string
|
||||
|
||||
WechatLoginRequest:
|
||||
type: object
|
||||
required:
|
||||
- users_wx_code
|
||||
properties:
|
||||
users_wx_code:
|
||||
type: string
|
||||
description: 微信小程序登录临时凭证 code
|
||||
example: 0a1b2c3d4e5f6g
|
||||
|
||||
WechatProfileRequest:
|
||||
type: object
|
||||
properties:
|
||||
users_name:
|
||||
type: string
|
||||
description: "用户姓名 / 昵称"
|
||||
example: 张三
|
||||
users_phone_code:
|
||||
type: string
|
||||
description: 可选。若传入,服务端优先通过微信接口换取真实手机号并写入数据库
|
||||
example: 2b7d9f2e3c4a5b6d7e8f
|
||||
users_phone:
|
||||
type: string
|
||||
description: 可选。未传 `users_phone_code` 时,可直接写入手机号
|
||||
example: '13800138000'
|
||||
users_type:
|
||||
type: string
|
||||
description: 可选。用户类型;仅在传入非空值时更新
|
||||
example: 服务商
|
||||
company_id:
|
||||
type: string
|
||||
description: 可选。公司业务 id;仅在传入非空值时更新
|
||||
example: WX-COMPANY-10001
|
||||
users_tag:
|
||||
type: string
|
||||
description: 可选。用户标签;非空时才更新
|
||||
example: 核心客户
|
||||
users_picture:
|
||||
type: string
|
||||
description: 可选。用户头像附件的 `attachments_id`
|
||||
example: ATT-1743123456789-abc123
|
||||
users_id_pic_a:
|
||||
type: string
|
||||
description: 可选。证件正面附件的 `attachments_id`
|
||||
users_id_pic_b:
|
||||
type: string
|
||||
description: 可选。证件反面附件的 `attachments_id`
|
||||
users_title_picture:
|
||||
type: string
|
||||
description: 可选。资质附件的 `attachments_id`
|
||||
|
||||
AuthSuccessData:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
anyOf:
|
||||
- type: string
|
||||
enum:
|
||||
- register_success
|
||||
- login_success
|
||||
- type: string
|
||||
is_info_complete:
|
||||
type:
|
||||
- boolean
|
||||
- string
|
||||
user:
|
||||
$ref: '../../openapi-wx.yaml#/components/schemas/UserInfo'
|
||||
|
||||
AuthSuccessResponse:
|
||||
allOf:
|
||||
- $ref: '../../openapi-wx.yaml#/components/schemas/ApiResponseBase'
|
||||
- type: object
|
||||
required:
|
||||
- token
|
||||
properties:
|
||||
data:
|
||||
description: "业务响应数据"
|
||||
$ref: '../../openapi-wx.yaml#/components/schemas/AuthSuccessData'
|
||||
token:
|
||||
type: string
|
||||
description: PocketBase 原生 auth token
|
||||
example:
|
||||
statusCode: 业务状态码 | integer
|
||||
errMsg: 业务提示信息 | string
|
||||
data:
|
||||
status: 登录或注册状态 | string
|
||||
is_info_complete: 资料是否完整 | boolean
|
||||
user:
|
||||
pb_id: PocketBase记录主键id | string
|
||||
users_convers_id: 会话侧用户ID | string
|
||||
users_id: 用户业务ID | string
|
||||
users_idtype: 用户身份来源类型 | string
|
||||
users_id_number: 证件号 | string
|
||||
users_type: 用户类型 | string
|
||||
users_name: 用户姓名或昵称 | string
|
||||
users_status: 用户状态 | string
|
||||
users_rank_level: 用户星级数值 | number
|
||||
users_auth_type: 账户类型 | number
|
||||
users_phone: 手机号 | string
|
||||
users_phone_masked: 手机号脱敏值 | string
|
||||
users_level: 用户等级 | string
|
||||
users_level_name: 用户等级名称 | string
|
||||
users_tag: 用户标签 | string
|
||||
users_picture: 用户头像附件ID | string
|
||||
users_picture_url: 用户头像文件流链接 | string
|
||||
users_id_pic_a: 证件正面附件ID | string
|
||||
users_id_pic_a_url: 证件正面文件流链接 | string
|
||||
users_id_pic_b: 证件反面附件ID | string
|
||||
users_id_pic_b_url: 证件反面文件流链接 | string
|
||||
users_title_picture: 资质附件ID | string
|
||||
users_title_picture_url: 资质附件文件流链接 | string
|
||||
openid: 全平台统一身份标识 | string
|
||||
company_id: 公司业务id | string
|
||||
users_parent_id: 上级用户业务id | string
|
||||
users_promo_code: 推广码 | string
|
||||
usergroups_id: 用户组业务id | string
|
||||
company:
|
||||
pb_id: PocketBase记录主键id | string
|
||||
company_id: 公司业务id,由数据库自动生成 | string
|
||||
company_name: 公司名称 | string
|
||||
company_type: 公司类型 | string
|
||||
company_entity: 公司法人 | string
|
||||
company_usci: 统一社会信用代码 | string
|
||||
company_nationality: 国家名称 | string
|
||||
company_nationality_code: 国家编码 | string
|
||||
company_province: 省份名称 | string
|
||||
company_province_code: 省份编码 | string
|
||||
company_city: 城市名称 | string
|
||||
company_city_code: 城市编码 | string
|
||||
company_district: 区县名称 | string
|
||||
company_district_code: 区县编码 | string
|
||||
company_postalcode: 邮政编码 | string
|
||||
company_add: 公司地址 | string
|
||||
company_status: 公司状态 | string
|
||||
company_level: 公司等级 | string
|
||||
company_owner_openid: 公司所有者openid | string
|
||||
company_remark: 备注 | string
|
||||
created: 记录创建时间 | string
|
||||
updated: 记录更新时间 | string
|
||||
created: 用户创建时间 | string
|
||||
updated: 用户更新时间 | string
|
||||
token: PocketBase原生认证token | string
|
||||
|
||||
WechatProfileResponseData:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
anyOf:
|
||||
- type: string
|
||||
enum:
|
||||
- update_success
|
||||
- type: string
|
||||
user:
|
||||
$ref: '../../openapi-wx.yaml#/components/schemas/UserInfo'
|
||||
|
||||
WechatProfileResponse:
|
||||
allOf:
|
||||
- $ref: '../../openapi-wx.yaml#/components/schemas/ApiResponseBase'
|
||||
- type: object
|
||||
properties:
|
||||
data:
|
||||
description: "业务响应数据"
|
||||
$ref: '../../openapi-wx.yaml#/components/schemas/WechatProfileResponseData'
|
||||
example:
|
||||
statusCode: 业务状态码 | integer
|
||||
errMsg: 业务提示信息 | string
|
||||
data:
|
||||
status: 资料更新状态 | string
|
||||
user:
|
||||
pb_id: PocketBase记录主键id | string
|
||||
users_convers_id: 会话侧用户ID | string
|
||||
users_id: 用户业务ID | string
|
||||
users_idtype: 用户身份来源类型 | string
|
||||
users_id_number: 证件号 | string
|
||||
users_type: 用户类型 | string
|
||||
users_name: 用户姓名或昵称 | string
|
||||
users_status: 用户状态 | string
|
||||
users_rank_level: 用户星级数值 | number
|
||||
users_auth_type: 账户类型 | number
|
||||
users_phone: 手机号 | string
|
||||
users_phone_masked: 手机号脱敏值 | string
|
||||
users_level: 用户等级 | string
|
||||
users_level_name: 用户等级名称 | string
|
||||
users_tag: 用户标签 | string
|
||||
users_picture: 用户头像附件ID | string
|
||||
users_picture_url: 用户头像文件流链接 | string
|
||||
users_id_pic_a: 证件正面附件ID | string
|
||||
users_id_pic_a_url: 证件正面文件流链接 | string
|
||||
users_id_pic_b: 证件反面附件ID | string
|
||||
users_id_pic_b_url: 证件反面文件流链接 | string
|
||||
users_title_picture: 资质附件ID | string
|
||||
users_title_picture_url: 资质附件文件流链接 | string
|
||||
openid: 全平台统一身份标识 | string
|
||||
company_id: 公司业务id | string
|
||||
users_parent_id: 上级用户业务id | string
|
||||
users_promo_code: 推广码 | string
|
||||
usergroups_id: 用户组业务id | string
|
||||
company:
|
||||
pb_id: PocketBase记录主键id | string
|
||||
company_id: 公司业务id,由数据库自动生成 | string
|
||||
company_name: 公司名称 | string
|
||||
company_type: 公司类型 | string
|
||||
company_entity: 公司法人 | string
|
||||
company_usci: 统一社会信用代码 | string
|
||||
company_nationality: 国家名称 | string
|
||||
company_nationality_code: 国家编码 | string
|
||||
company_province: 省份名称 | string
|
||||
company_province_code: 省份编码 | string
|
||||
company_city: 城市名称 | string
|
||||
company_city_code: 城市编码 | string
|
||||
company_district: 区县名称 | string
|
||||
company_district_code: 区县编码 | string
|
||||
company_postalcode: 邮政编码 | string
|
||||
company_add: 公司地址 | string
|
||||
company_status: 公司状态 | string
|
||||
company_level: 公司等级 | string
|
||||
company_owner_openid: 公司所有者openid | string
|
||||
company_remark: 备注 | string
|
||||
created: 记录创建时间 | string
|
||||
updated: 记录更新时间 | string
|
||||
created: 用户创建时间 | string
|
||||
updated: 用户更新时间 | string
|
||||
Reference in New Issue
Block a user