Skip to content

feat: added docs for audit logs#817

Merged
evantahler merged 20 commits intomainfrom
pascal/plt-1232-add-docs-for-audit-logs
Mar 3, 2026
Merged

feat: added docs for audit logs#817
evantahler merged 20 commits intomainfrom
pascal/plt-1232-add-docs-for-audit-logs

Conversation

@pmdroid
Copy link
Member

@pmdroid pmdroid commented Feb 25, 2026

Note

Low Risk
Low risk: documentation-only additions plus a regenerated llms.txt index entry; no runtime logic changes.

Overview
Adds a new Audit Logs guide page documenting Arcade’s audit logging capabilities, including REST endpoints, pagination, and enum/reference schemas.

Updates guides navigation (app/en/guides/_meta.tsx) to include the new page, and regenerates the published markdown artifact (public/_markdown/.../audit-logs.md) plus public/llms.txt to index the new documentation.

Written by Cursor Bugbot for commit 6de839a. This will update automatically on new commits. Configure here.

@vercel
Copy link

vercel bot commented Feb 25, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Mar 3, 2026 10:07pm

Request Review

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Style Review

Found 4 style suggestion(s).

Powered by Vale + Claude

}
```

### Pagination
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

write-good.Illusions: The repetition issue is between line 127 and 129, but the actual content shows proper heading structure, so no change needed

Suggested change
### Pagination
### Pagination

pmdroid and others added 3 commits February 25, 2026 13:58
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link
Contributor

@evantahler evantahler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The main change I'd like to see is that this page describe the feature in addition to the API - we need a screenshot and explanation about what it does

@@ -0,0 +1,243 @@
---
title: "Audit Logs"
description: "If you want audit events outside the dashboard, there's a REST API. You can pull logs programmatically to feed into your existing SIEM, compliance tooling, or internal reporting."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You've got some great content in the blogs post - how about:

Arcade.dev now captures every administrative action across the platform automatically — who did it, how, what changed, and when.

Comment on lines +14 to +17
```bash
curl -s "https://cloud.arcade.dev/api/v1/orgs/{org_id}/audit_logs?action=AUDIT_ACTION_CREATED&limit=10" \
-H "Authorization: Bearer $ARCADE_API_KEY"
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Double checking we want to publish the cloud API route. Does cloud have an OpenAPI Spec we want to publish to https://docs.arcade.dev/en/references/api?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@evantahler did we also documented it for internal proposes in a openapi spec

@evantahler evantahler merged commit 1fb3787 into main Mar 3, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants