Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン
#1,581 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
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分
マージ済み PR(30日)
39

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

sourcebot-dev/sourcebot のほかの issue

sourcebot-dev/sourcebot の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。