docs(ee/audit): action type table is out of sync with code
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 76/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Tranquilla
- Stack tecnologico
- typescript
- Ambito
- api, documentation
Direzione di ricerca
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.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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).
- Lingua principale
- TypeScript
- Stelle
- 3.9k
- Fork
- 374
- Merge medio
- 21h 18m
- PR unite (30g)
- 39
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di sourcebot-dev/sourcebot
-
bug triage needed
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
sourcebot-dev/sourcebot#1681 · 1 commento ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
sourcebot-dev/sourcebot#1633 ·
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
sourcebot-dev/sourcebot#1384 · 4 commenti ·
-
ask_sb bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
sourcebot-dev/sourcebot#1137 · 4 commenti ·
-
bug triage needed
Difficoltà 3/5 1-2 giorni Idoneità per principianti 48/100
sourcebot-dev/sourcebot#1661 · 1 commento ·
Tutte le issue di sourcebot-dev/sourcebot
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
safetrustcr/dApp-SafeTrust#426 ·
-
area:workflow bug ready-for-agent
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
fil-donadoni/tolaria#4409 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
Fission-AI/OpenSpec#1960 ·
-
Add dependabot Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
corsairdev/corsair#1764 ·