Skip to content

docs: clarify audit log filtering behavior. #9871

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jmcarp wants to merge 1 commit into
base: main
Choose a base branch
from
+31,818 −7
Open

docs: clarify audit log filtering behavior. #9871

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions nexus/external-api/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ api_versions!([
// | date-based version should be at the top of the list.
// v
// (next_yyyymmddnn, IDENT),
(2026021800, BUMP_AUDIT_LOG_DOCS),
(2026021301, BGP_UNNUMBERED_PEERS),
(2026021300, STALE_DOCS_AND_PUNCTUATION),
(2026020901, UPDATE_EXTERNAL_SUBNET_DOCS),
Expand Down Expand Up @@ -6374,10 +6375,10 @@ pub trait NexusExternalApi {
///
/// Audit log entries are designed to be immutable: once you see an entry,
/// fetching it again will never get you a different result. The list is
/// ordered by `time_completed`, not `time_started`. If you fetch the audit
/// log for a time range that is fully in the past, the resulting list is
/// guaranteed to be complete, i.e., fetching the same timespan again later
/// will always produce the same set of entries.
/// ordered and filtered by `time_completed`, not `time_started`. If
/// you fetch the audit log for a time range that is fully in the past,
/// the resulting list is guaranteed to be complete, i.e., fetching the
/// same timespan again later will always produce the same set of entries.
#[endpoint {
method = GET,
path = "/v1/system/audit-log",
Expand Down
4 changes: 2 additions & 2 deletions nexus/types/src/external_api/params.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3456,9 +3456,9 @@ pub struct AlertReceiverProbe {
/// Audit log has its own pagination scheme because it paginates by timestamp.
#[derive(Deserialize, JsonSchema, Serialize, PartialEq, Debug, Clone)]
pub struct AuditLog {
/// Required, inclusive
/// Start of time range (inclusive). Filters on `time_completed`.
Copy link
Contributor

@sudomateo sudomateo Feb 17, 2026

Choose a reason for hiding this comment

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

This query parameter is indeed required but not marked as required in the OpenAPI specification so it doesn't have the required badge on the rendered site. I think this is a dropshot bug?

Image 
> curl https://oxide.sys.r3.oxide-preview.com/v1/system/audit-log
{
  "request_id": "7fb4332d-c9f4-4400-a863-d78749965d79",
  "message": "unable to parse query string: missing field `start_time`"
}

pub start_time: DateTime<Utc>,
/// Exclusive
/// End of time range (exclusive). Filters on `time_completed`.
pub end_time: Option<DateTime<Utc>>,
}

Expand Down
Loading
Loading