docs(ee/audit): action type table is out of sync with code
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 76/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Tranquilo
- Stack tecnológico
- typescript
- Área
- api, documentation
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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).
- Lenguaje dominante
- TypeScript
- Estrellas
- 3.9k
- Forks
- 374
- Merge medio
- 21 h 18 min
- PR fusionados (30 d)
- 39
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de sourcebot-dev/sourcebot
-
bug triage needed
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
sourcebot-dev/sourcebot#1681 · 1 comentario ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
sourcebot-dev/sourcebot#1633 ·
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
sourcebot-dev/sourcebot#1384 · 4 comentarios ·
-
ask_sb bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
sourcebot-dev/sourcebot#1137 · 4 comentarios ·
-
bug triage needed
Dificultad 3/5 1-2 días Aptitud para principiantes 48/100
sourcebot-dev/sourcebot#1661 · 1 comentario ·
Todos los issues de sourcebot-dev/sourcebot
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
bug v2
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
modelcontextprotocol/inspector#2458 · 1 comentario ·
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 75/100
railmapgen/rmp-gallery#4068 ·
-
Mend: dependency security vulnerability status: needs triage 🕵️♀️
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
carbon-design-system/ibm-products#9907 ·