Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

docs(ee/audit): action type table is out of sync with code

未关闭
#1,581 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
76/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
冷清
技术栈
typescript
领域
api, documentation

调研方向

Start with docs/docs/configuration/audit-logs.mdx and compare its table and schemas with the createAudit calls in the named membership.service.ts and ee/features/scim/actions.ts locations. Use docs/api-reference/sourcebot-public.openapi.json and publicApiDocument.ts as references for the query parameters and headers. Done means the MDX reflects the active actions and schemas, documents the pagination and filtering details, renders cleanly, and leaves openapi generation unaffected.

由索引模型根据 Issue 内容生成。

描述

Title: docs(ee/audit): action type table is out of sync with code

The Audit action types table in docs/docs/configuration/audit-logs.mdx (lines 113-150) is missing 4 entries that the code actually writes, and has 1 stale entry that the code does not write.

Missing entries (in code, not in docs)
  1. org.member_deactivatedpackages/web/src/features/membership/membership.service.ts:305-310 (target type user)
  2. org.member_reactivatedpackages/web/src/features/membership/membership.service.ts:353-358 (target type user)
  3. scim_token.createdpackages/web/src/ee/features/scim/actions.ts:75-84 (target type scim_token, metadata { scim_token: <name> })
  4. scim_token.deletedpackages/web/src/ee/features/scim/actions.ts:112-121 (target type scim_token, metadata { scim_token: <name> })
Stale entry (in docs, not in code)
  • user.delete (line 127) — no createAudit({ action: "user.delete", ... }) or createAudit({ action: "user.deleted", ... }) call exists in packages/. Closest active entry is user.read in the EE user GET handler.
Related gaps in the same file
  • The targetType enum in the response schema (line 197) is missing scim_token as a value.
  • The query parameters (since, until, page, perPage) and the response headers (X-Total-Count, Link) are documented in docs/api-reference/sourcebot-public.openapi.json and the corresponding publicApiDocument.ts registration, but not in the .mdx page. The page only shows a single unparameterised curl example.
  • The metadata schema (line 201-218) is missing scim_token as a known key (used by the two new scim_token.* actions).
Proposed fix

Update docs/docs/configuration/audit-logs.mdx so the action type table, the targetType enum, and the metadata schema all reflect the actual code. Remove the stale user.delete row. Add a short section documenting the four query parameters and the two response headers, with one curl example showing time-range filtering and one showing paginated traversal. No code or behaviour changes; no changelog entry needed (docs only).

Acceptance criteria
  • The action type table in the .mdx contains every action value that any createAudit / createAuditAction call writes, and contains no value the code never writes.
  • The response schema targetType enum includes scim_token.
  • The metadata schema includes scim_token as a known key.
  • The page documents since, until, page, and perPage as query parameters, and X-Total-Count and Link as response headers.
  • The page still renders cleanly (Mintlify) and yarn workspace @sourcebot/web openapi:generate is not affected (the openapi file already documents all of this).
主要语言
TypeScript
星标
3.9k
派生
374
平均合并
21 小时 18 分钟
30 天内合并 PR
39

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

sourcebot-dev/sourcebot 的其他 Issue

查看 sourcebot-dev/sourcebot 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。