[auditbox] update api docs #94
Open
+128
−150
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| ### Single event upload | ||
|
|
||
| */AuditEvent* endpoint is used for uploading a single AuditEvent to | ||
| `/AuditEvent` endpoint is used for uploading a single AuditEvent to |
Contributor
There was a problem hiding this comment.
The
/AuditEventendpoint accepts a single AuditEvent for upload to Auditbox.
Comment on lines
+133
to
+138
| ### Pagination Parameters | ||
|
|
||
| | Parameter | Type | Description | Example | | ||
| |-----------|------|-------------|---------| | ||
| | `_offset` | number | How many entries to skip displaying | `?_offset=10` | | ||
| | `_count` | number | How many entries to displaying | `?_count=10` | |
Contributor
There was a problem hiding this comment.
Pagination Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
_offset |
number | Number of entries to skip | ?_offset=10 |
_count |
number | Number of entries to return | ?_count=10 |
| [parameters] | ||
| ``` | ||
|
|
||
| You can read about all supported search parameters in the API reference. |
Contributor
There was a problem hiding this comment.
Would be cool to add a link to API reference here. WDYT?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note
Reorganizes and streamlines Auditbox documentation.
Using Auditbox Programmaticallywith two guides—Send AuditEvents to AuditboxandRead AuditEvents Using API—covering auth, single/bulk upload, fetching by ID, search, and paginationPagination Parameterssection (_count,_offset) and removes inlined example blocks and duplicate pagination/how‑to snippets to reduce clutter0.5.0and0.4.0(customusersearch param; remove Keycloak references)Written by Cursor Bugbot for commit 660ed5f. This will update automatically on new commits. Configure here.