From 624c8fc280c3d5e431796be74e22cb492077d360 Mon Sep 17 00:00:00 2001 From: zfarrell <1420220+zfarrell@users.noreply.github.com> Date: Thu, 30 Jul 2026 02:04:01 +0000 Subject: [PATCH] chore(query-runs): clarify user_public_id documentation --- CHANGELOG.md | 1 + docs/QueryRunInfo.md | 2 +- hotdata/models/query_run_info.py | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 73cc94f..98e0b6f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed +- chore(query-runs): clarify user_public_id documentation - feat(databases): add search parameter to list endpoint - chore(databases): make pagination fields nullable diff --git a/docs/QueryRunInfo.md b/docs/QueryRunInfo.md index e2b1cf2..b66c521 100644 --- a/docs/QueryRunInfo.md +++ b/docs/QueryRunInfo.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes **sql_text** | **str** | | **status** | **str** | | **trace_id** | **str** | | [optional] -**user_public_id** | **str** | Caller identity derived from the Authorization Bearer token (SHA-256 hash). Format: `user_{first_10_hex_chars}`. | [optional] +**user_public_id** | **str** | Who ran this query: the account id from the access token the request was made with. Use it to group a caller's query history. Requests made with a credential that identifies no account instead record an opaque `user_`-prefixed identifier, which is stable for that credential but cannot be resolved to an account. | [optional] **warning_message** | **str** | | [optional] ## Example diff --git a/hotdata/models/query_run_info.py b/hotdata/models/query_run_info.py index 070a9d5..b47edab 100644 --- a/hotdata/models/query_run_info.py +++ b/hotdata/models/query_run_info.py @@ -45,7 +45,7 @@ class QueryRunInfo(BaseModel): sql_text: StrictStr status: StrictStr trace_id: Optional[StrictStr] = None - user_public_id: Optional[StrictStr] = Field(default=None, description="Caller identity derived from the Authorization Bearer token (SHA-256 hash). Format: `user_{first_10_hex_chars}`.") + user_public_id: Optional[StrictStr] = Field(default=None, description="Who ran this query: the account id from the access token the request was made with. Use it to group a caller's query history. Requests made with a credential that identifies no account instead record an opaque `user_`-prefixed identifier, which is stable for that credential but cannot be resolved to an account.") warning_message: Optional[StrictStr] = None __properties: ClassVar[List[str]] = ["bytes_scanned", "completed_at", "created_at", "error_message", "execution_time_ms", "id", "result_id", "row_count", "rows_scanned", "saved_query_id", "saved_query_version", "server_processing_ms", "snapshot_id", "sql_hash", "sql_text", "status", "trace_id", "user_public_id", "warning_message"]