Reconcile OpenAPI/AsyncAPI/perps/SCM spec drift (v11.0.0) - #500
Merged
Conversation
Closes #499. Sync upstream specs and align models/maps after nightly contract failures. Breaking: remove Klear active_obligation() and settlement_estimate() after upstream deleted the singular endpoints. Prefer active_obligations() and settlement_estimate_by_asset_class(). Additive: Klear paged obligation detail endpoints, ExchangeIndexStatus.description, MarginMarket.exchange_index, TradePayload.is_block_trade; required position/ funding fields on SettlementDetail and ObligationEntry. Release prep for 11.0.0 (CHANGELOG, migration, ROADMAP, docs accuracy).
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Closes #499. Syncs upstream OpenAPI 3.27.0 content, AsyncAPI, perps OpenAPI, and perps SCM OpenAPI after nightly contract drift (including the later SCM obligation reshape).
Breaking
active_obligation()+GetActiveMarginObligationResponse(useactive_obligations())settlement_estimate()+GetSettlementEstimateResponse(usesettlement_estimate_by_asset_class())SettlementDetail.position_quantity_fp,ObligationEntry.funding_payments,ExchangeIndexStatus.description,MarginMarket.exchange_index,TradePayload.is_block_tradeAdditive
settlement_details/maintenance_margin_details/funding_payments(+*_all)FundingPaymentDetail+ paged response wrappersObligationEntry.*_truncatedflags when inline arrays hit the 1000-row capRelease prep
Test plan
uv run mypy kalshi/uv run ruff check kalshi/ tests/uv run pytest tests/ --ignore=tests/integration(4197 passed)uv run --group docs mkdocs build --strict