Skip to content

Commit c3bcde2

Browse files
docs(ee/audit): address CodeRabbit review on #1582
Three CodeRabbit findings on PR #1582, all verified against current code before fixing. - Add scim.enabled and scim.disabled rows to the action type table. They are written from a ternary at packages/web/src/ee/features/scim/actions.ts:38 (action: enabled ? 'scim.enabled' : 'scim.disabled') with target type 'org'. My initial grep for the action string missed them because the value is built, not a literal. Actor type is 'user', target type is 'org'. - Use double quotes around the URL and the API-key header in the new 'fetch with time range' curl example so SOURCEBOT_URL and SOURCEBOT_OWNER_API_KEY actually expand at shell execution. The original example on the page has the same issue but is outside this PR's diff and out of scope here. - Replace the em-dash placeholder in the since/until table cells with 'Not set' to match the rest of the docs' 'no default' convention and remove ambiguity about whether a blank cell means 'unset' or 'no default'.
1 parent a1d79b7 commit c3bcde2

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

docs/docs/configuration/audit-logs.mdx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,8 @@ curl --request GET '$SOURCEBOT_URL/api/ee/audit' \
151151
| `org.owner_demoted_to_member` | `user` | `user` |
152152
| `scim_token.created` | `user` | `scim_token` |
153153
| `scim_token.deleted` | `user` | `scim_token` |
154+
| `scim.enabled` | `user` | `org` |
155+
| `scim.disabled` | `user` | `org` |
154156

155157

156158
## Query parameters and response headers
@@ -163,8 +165,8 @@ The endpoint is paginated and accepts a time range filter.
163165
| :------- | :------ | :------ | :------ |
164166
| `page` | positive integer | `1` | Page number. |
165167
| `perPage` | positive integer, max `100` | `50` | Number of records per page. |
166-
| `since` | ISO 8601 timestamp | | Return records at or after this timestamp (inclusive). |
167-
| `until` | ISO 8601 timestamp | | Return records at or before this timestamp (inclusive). |
168+
| `since` | ISO 8601 timestamp | Not set | Return records at or after this timestamp (inclusive). |
169+
| `until` | ISO 8601 timestamp | Not set | Return records at or before this timestamp (inclusive). |
168170

169171
`since` must be strictly before `until` if both are supplied; otherwise the endpoint returns `400`.
170172

@@ -176,9 +178,9 @@ The endpoint is paginated and accepts a time range filter.
176178
| `Link` | Pagination links (`rel="first"`, `rel="prev"`, `rel="next"`, `rel="last"`) formatted per [RFC 8288](https://datatracker.ietf.org/doc/html/rfc8288). Only set when more than one page of results exists. |
177179

178180
```bash icon="terminal" Fetch audit logs for a time range, then page
179-
curl --request GET '$SOURCEBOT_URL/api/ee/audit?since=2026-08-01T00:00:00Z&until=2026-08-13T23:59:59Z&perPage=25' \
181+
curl --request GET "$SOURCEBOT_URL/api/ee/audit?since=2026-08-01T00:00:00Z&until=2026-08-13T23:59:59Z&perPage=25" \
180182
--header 'X-Org-Domain: ~' \
181-
--header 'X-Sourcebot-Api-Key: $SOURCEBOT_OWNER_API_KEY'
183+
--header "X-Sourcebot-Api-Key: $SOURCEBOT_OWNER_API_KEY"
182184
```
183185

184186

0 commit comments

Comments
 (0)