Skip to content

[P3] docs: services.{data,sharing,audit,queue,email,settings,storage} APIs undocumented #1327

Description

@xuyushun441-sys

来源:docs/PLATFORM_GAPS_FROM_TEMPLATES.md 第 23 条(P3)。

现象

services.data.{get, list, update, create, delete} 等运行时 API 在文档中未系统化呈现,模板作者 / 插件开发者只能读源码。

涉及:

  • services.data
  • services.sharing
  • services.audit
  • services.queue
  • services.email
  • services.settings
  • services.storage

建议范围

M1:服务 API 参考页

  • 每个 service 一页:方法签名 / 参数 / 返回 / 错误 / 示例
  • 自动从 TS 类型生成 + 手写说明

M2:示例

  • 「在 flow 自定义节点里读关联记录」
  • 「在 hook 里查 sharing 权限」
  • 「在 plugin 中订阅事件」

M3:版本化

  • API 稳定性等级标记(stable / experimental)
  • 破坏性变更记录

验收

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions