Skip to content

fix(sdk): Fix microversion header negotiation#1863

Merged
gtema merged 1 commit into
mainfrom
sanity
Jul 21, 2026
Merged

fix(sdk): Fix microversion header negotiation#1863
gtema merged 1 commit into
mainfrom
sanity

Conversation

@gtema

@gtema gtema commented Jul 15, 2026

Copy link
Copy Markdown
Owner

Rename set_latest_microversion to set_request_microversion_header and
rewrite to use endpoint.api_version() as the microversion value sent in
the OpenStack-API-Version header. Previously the function used
service_endpoint.version() (URL-parsed, always 2.1 for compute),
ignoring the actual microversion the generated struct requires.

Add bounds validation: if the endpoint's required microversion falls
outside the cloud's discovered min/max range, return a new
ApiError::MicroversionIncompatible error instead of sending a doomed
request. The error carries required version and cloud range for a
clear user-facing message.

Add Copy, Eq, PartialOrd, Ord derives to ApiVersion to enable direct
comparison. Reuse ApiVersion::from_apiver_str for parsing cloud
min/max version strings instead of a custom parser.

Signed-off-by: Artem Goncharov artem.goncharov@gmail.com

@gtema
gtema force-pushed the sanity branch 5 times, most recently from c8b73fc to 4353615 Compare July 21, 2026 07:57
Rename set_latest_microversion to set_request_microversion_header and
rewrite to use endpoint.min_version()/max_version() instead of
service_endpoint.version() (URL-parsed, always 2.1 for compute) when
building the OpenStack-API-Version header.

Expand RestEndpoint with min_version()/max_version(), both optional
and defaulting to back-compat with the existing api_version(). A
variant's min_version() is a floor, not a hard requirement: codegen's
min-ver only marks when a struct variant was introduced, so a cloud
reporting a higher min_version doesn't make the variant unsupported.
Sent version is bumped up to max(endpoint.min_version(),
cloud.min_version()) instead of silently sending a stale low value.
max_version(), when a variant sets it, is a real ceiling: fail hard
if the cloud's floor has already moved past it, meaning a newer
variant should have been picked instead. Also fail hard if the
endpoint's floor is newer than anything the cloud supports.

Return ApiError::MicroversionIncompatible instead of sending a
doomed request when neither bound can be satisfied. The error
carries required version and cloud range for a clear user-facing
message.

Extract the bounds-check/version-pick math into a standalone
negotiate_microversion(), with set_request_microversion_header as a
thin wrapper over it. Callers that already hold client + the
endpoint can call it directly to learn the negotiated version (e.g.
to pick a version-correct response schema) without duplicating the
logic or an extra HTTP round-trip, since get_service_endpoint is a
cached in-memory catalog lookup.

Add Copy, Eq, PartialOrd, Ord derives to ApiVersion to enable direct
comparison. Reuse ApiVersion::from_apiver_str for parsing cloud
min/max version strings instead of a custom parser.

Signed-off-by: Artem Goncharov <artem.goncharov@gmail.com>
@gtema
gtema merged commit 93a2ec5 into main Jul 21, 2026
16 checks passed
@gtema-release-plz gtema-release-plz Bot mentioned this pull request Jul 21, 2026
@gtema
gtema deleted the sanity branch July 21, 2026 13:26
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.

1 participant