chore(query-runs): clarify user_public_id documentation - #153
chore(query-runs): clarify user_public_id documentation#153hotdata-automation[bot] wants to merge 1 commit into
Conversation
| 'SessionId', | ||
| ), | ||
| } | ||
| return auth |
There was a problem hiding this comment.
Blocking: dropping the SessionId scheme here turns the hand-maintained session_id kwarg/property into a silent no-op.
hotdata/configuration.py still ships (from .openapi-generator-templates/configuration.mustache, which is not regenerated by this PR):
- line 145 docstring:
:param session_id: Public id of an active sandbox, sent as `X-Session-Id`. - lines 240–241:
if session_id is not None: self.api_keys["SessionId"] = session_id - lines 543–557: the
session_idproperty/setter, documented as "sent asX-Session-Id"
With SessionId gone from auth_settings() and from every operation's _auth_settings list, Configuration(session_id="sb_xyz") still accepts the value and config.session_id still reads it back, but no X-Session-Id header is ever sent. Callers relying on sandbox scoping lose isolation with no error and no type failure — reads/writes silently hit unscoped data. The AuthSettings TypedDict no longer declares the key either, so nothing catches it statically.
Pick one:
- If
SessionIdwas intentionally removed from the spec, also removesession_id(kwarg,api_keyswiring, property, docstrings, the:Example:block at line 180) from.openapi-generator-templates/configuration.mustacheand regenerate, and record the removal under### RemovedinCHANGELOG.md. - If the removal is unintentional spec drift, restore the
SessionIdsecurity scheme in the OpenAPI source and regenerate.
Either way this should not merge as-is, since the current state is "documented parameter that quietly does nothing."
|
|
||
| ### Changed | ||
|
|
||
| - chore(query-runs): clarify user_public_id documentation |
There was a problem hiding this comment.
nit: the changelog entry only covers the doc-string change, but this PR also removes the SessionId / X-Session-Id API-key auth scheme from Configuration.auth_settings() and from the query, get_result, and list_results operations. That is a user-facing breaking change and warrants its own entry under ### Removed, alongside the existing uploads note. (not blocking on its own — but it needs to happen as part of resolving the session_id issue in hotdata/configuration.py)
There was a problem hiding this comment.
Review
Blocking Issues
-
hotdata/configuration.py:601—auth_settings()no longer emits theSessionId/X-Session-Idscheme, and no operation lists it in_auth_settingsanymore, but the hand-maintained template still exposessession_id:hotdata/configuration.py:145documents:param session_id: ... sent as X-Session-Idhotdata/configuration.py:240-241writes it intoself.api_keys["SessionId"]hotdata/configuration.py:543-557exposes thesession_idproperty/setter
Result:
Configuration(session_id="sb_xyz")is accepted and round-trips throughconfig.session_id, but the header is never sent. Sandbox scoping silently degrades to unscoped access — no exception, and no static error sinceAuthSettingsno longer declares the key. The source of the stale code is.openapi-generator-templates/configuration.mustache:337,669-676, which this PR does not touch.
Action Required
- Decide whether the
SessionIdscheme removal is intentional:- Intentional → remove
session_id(kwarg,api_keyswiring, property/setter, docstrings at lines 145-149, and the:Example:block at line 180) from.openapi-generator-templates/configuration.mustacheand regenerate. Also drop the now-danglingSandboxesApi.create_sandboxreferences in those docstrings — there is noSandboxesApiin this SDK. - Unintentional spec drift → restore the
SessionIdsecurity scheme in the OpenAPI source and regenerate.
- Intentional → remove
- Add a
### Removedentry toCHANGELOG.mdfor the droppedSessionId/X-Session-Idauth scheme. The current entry only mentions theuser_public_iddoc change, which understates a breaking change.
The user_public_id description update itself (hotdata/models/query_run_info.py:48, docs/QueryRunInfo.md) is fine and matches the PR intent.
|
Closing in favor of #154, a fresh regen on top of main. This PR branched from #154 is generated from current main ( |
Pull request was closed
Auto-generated from the updated HotData OpenAPI spec.
Source: https://github.com/hotdata-dev/www.hotdata.dev/pull/289