docs(ee/audit): action type table is out of sync with code
まだ誰も着手していません。
評価
- 難易度
- 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)
org.member_deactivated—packages/web/src/features/membership/membership.service.ts:305-310(target typeuser)org.member_reactivated—packages/web/src/features/membership/membership.service.ts:353-358(target typeuser)scim_token.created—packages/web/src/ee/features/scim/actions.ts:75-84(target typescim_token, metadata{ scim_token: <name> })scim_token.deleted—packages/web/src/ee/features/scim/actions.ts:112-121(target typescim_token, metadata{ scim_token: <name> })
Stale entry (in docs, not in code)
user.delete(line 127) — nocreateAudit({ action: "user.delete", ... })orcreateAudit({ action: "user.deleted", ... })call exists inpackages/. Closest active entry isuser.readin the EE user GET handler.
Related gaps in the same file
- The
targetTypeenum in the response schema (line 197) is missingscim_tokenas a value. - The query parameters (
since,until,page,perPage) and the response headers (X-Total-Count,Link) are documented indocs/api-reference/sourcebot-public.openapi.jsonand the correspondingpublicApiDocument.tsregistration, but not in the.mdxpage. The page only shows a single unparameterisedcurlexample. - The
metadataschema (line 201-218) is missingscim_tokenas a known key (used by the two newscim_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
.mdxcontains everyactionvalue that anycreateAudit/createAuditActioncall writes, and contains no value the code never writes. - The response schema
targetTypeenum includesscim_token. - The
metadataschema includesscim_tokenas a known key. - The page documents
since,until,page, andperPageas query parameters, andX-Total-CountandLinkas response headers. - The page still renders cleanly (Mintlify) and
yarn workspace @sourcebot/web openapi:generateis not affected (the openapi file already documents all of this).
- 主要言語
- TypeScript
- スター
- 3.9k
- フォーク
- 374
- 平均マージ
- 21時間 18分
- マージ済み PR(30日)
- 39
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
sourcebot-dev/sourcebot のほかの issue
-
bug triage needed
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
sourcebot-dev/sourcebot#1681 · コメント 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
sourcebot-dev/sourcebot#1633 ·
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
sourcebot-dev/sourcebot#1384 · コメント 4 件 ·
-
ask_sb bug
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
sourcebot-dev/sourcebot#1137 · コメント 4 件 ·
-
bug triage needed
難易度 3/5 1〜2日 初心者へのやさしさ 48/100
sourcebot-dev/sourcebot#1661 · コメント 1 件 ·
sourcebot-dev/sourcebot の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
bug v2
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
modelcontextprotocol/inspector#2458 · コメント 1 件 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
railmapgen/rmp-gallery#4068 ·
-
Mend: dependency security vulnerability status: needs triage 🕵️♀️
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
carbon-design-system/ibm-products#9907 ·