chore(openapi): adopt upstream OpenAPI specs (draft — needs review) - #65
Draft
github-actions[bot] wants to merge 1 commit into
Draft
chore(openapi): adopt upstream OpenAPI specs (draft — needs review)#65github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
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
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.
Automated OpenAPI adopt with breaking classifier findings.
Opened as a draft. Review the report and generated diff carefully before marking ready to merge.
OpenAPI adopt report (broker)
Breaking changes detected.
Operations extended (additive)
POST /v1/jit/settlements— documentation onlySchemas added
CommonREOActivityV2REOActivityV2Schemas modified
AccountExtended— schema keywords changedCommonCDIVActivityV2— changed properties: foreign, specialDIVSPDActivityV2— schema keywords changedSchemas extended (additive)
ActivitySubType— documentation onlyActivityType— added enum valuesActivityV2DetailNTA— added composition membersCDIVActivityV2— documentation onlyTokenizationIssuer— added enum valuesTokenizationNetwork— added enum valuesTradeUpdateEventType— documentation onlyTradeUpdateEventV2— added properties: reasonEnum values added
ActivityType: REOCommonCDIVActivityV2.foreign: falseCommonCDIVActivityV2.foreign: trueCommonCDIVActivityV2.special: falseCommonCDIVActivityV2.special: trueDIVSPDActivityV2.allOf[1].foreign: falseDIVSPDActivityV2.allOf[1].foreign: trueDIVSPDActivityV2.allOf[1].special: falseDIVSPDActivityV2.allOf[1].special: trueTokenizationIssuer: binanceTokenizationIssuer: coinbaseTokenizationNetwork: cronosTokenizationNetwork: hyperevmOpenAPI adopt report (data)
Breaking changes detected.
Operations added
GET /v1beta1/fixed_income/latest/pricesGET /v1beta1/fixed_income/latest/quotesOperations modified
GET /v1beta3/crypto/{loc}/bars— security requirements changedGET /v1beta3/crypto/{loc}/latest/bars— security requirements changedGET /v1beta3/crypto/{loc}/latest/orderbooks— security requirements changedGET /v1beta3/crypto/{loc}/latest/quotes— security requirements changedGET /v1beta3/crypto/{loc}/latest/trades— security requirements changedGET /v1beta3/crypto/{loc}/quotes— security requirements changedGET /v1beta3/crypto/{loc}/snapshots— security requirements changedGET /v1beta3/crypto/{loc}/trades— security requirements changedOperations extended (additive)
GET /v1/corporate-actions— added security alternativesGET /v1beta1/events/corporate-actions— added security alternativesGET /v1beta1/forex/latest/rates— added security alternativesGET /v1beta1/forex/rates— added security alternativesGET /v1beta1/logos/{symbol}— added security alternativesGET /v1beta1/news— added security alternativesGET /v1beta1/options/bars— added security alternativesGET /v1beta1/options/meta/conditions/{ticktype}— added security alternativesGET /v1beta1/options/meta/exchanges— added security alternativesGET /v1beta1/options/quotes/latest— added security alternativesGET /v1beta1/options/snapshots— added security alternativesGET /v1beta1/options/snapshots/{underlying_symbol}— added security alternativesGET /v1beta1/options/trades— added security alternativesGET /v1beta1/options/trades/latest— added security alternativesGET /v1beta1/screener/stocks/most-actives— added security alternativesGET /v1beta1/screener/{market_type}/movers— added security alternativesGET /v2/stocks/auctions— added security alternativesGET /v2/stocks/bars— added security alternativesGET /v2/stocks/bars/latest— added security alternativesGET /v2/stocks/meta/conditions/{ticktype}— added security alternativesGET /v2/stocks/meta/exchanges— added security alternativesGET /v2/stocks/quotes— added security alternativesGET /v2/stocks/quotes/latest— added security alternativesGET /v2/stocks/snapshots— added security alternativesGET /v2/stocks/trades— added security alternativesGET /v2/stocks/trades/latest— added security alternativesGET /v2/stocks/{symbol}/auctions— added security alternativesGET /v2/stocks/{symbol}/bars— added security alternativesGET /v2/stocks/{symbol}/bars/latest— added security alternativesGET /v2/stocks/{symbol}/quotes— added security alternativesGET /v2/stocks/{symbol}/quotes/latest— added security alternativesGET /v2/stocks/{symbol}/snapshot— added security alternativesGET /v2/stocks/{symbol}/trades— added security alternativesGET /v2/stocks/{symbol}/trades/latest— added security alternativesSchemas added
fixed_income_latest_prices_respfixed_income_latest_quotes_respfixed_income_pricefixed_income_quoteSchemas extended (additive)
ca_event_cash_dividend— documentation onlyca_event_cash_merger— documentation onlyca_event_equity_partial_call— documentation onlyca_event_forward_split— documentation onlyca_event_redemption— documentation onlyca_event_reorganization— documentation onlyca_event_reorganization_stock_movement— documentation onlyca_event_reverse_split— documentation onlyca_event_rights_distribution— documentation onlyca_event_spin_off— documentation onlyca_event_stock_and_cash_merger— documentation onlyca_event_stock_dividend— documentation onlyca_event_stock_merger— documentation onlyca_event_unit_split— documentation onlycash_dividend— documentation onlycash_merger— documentation onlycorporate_action_event_base— documentation onlycrypto_bar— documentation onlycrypto_orderbook— documentation onlycrypto_orderbook_entry— documentation onlycrypto_quote— documentation onlycrypto_trade— documentation onlyevent_id— documentation onlyforex_currency_pairs— documentation onlyforex_rate— documentation onlyforward_split— documentation onlymost_active— documentation onlymover— documentation onlyname_change— documentation onlynews_image— documentation onlyoption_bar— documentation onlyoption_conditions— documentation onlyoption_exchanges— documentation onlyoption_quote— documentation onlyoption_trade— documentation onlyredemption— documentation onlyreverse_split— documentation onlyrights_distribution— documentation onlyspin_off— documentation onlystock_and_cash_merger— documentation onlystock_auction— documentation onlystock_bar— documentation onlystock_conditions— documentation onlystock_dividend— documentation onlystock_exchanges— documentation onlystock_merger— documentation onlystock_quote— documentation onlystock_trade— documentation onlyunit_split— documentation onlyworthless_removal— documentation onlyOpenAPI adopt report (trading)
Breaking changes detected.
Operations modified
GET /v2/tokenization/requests— changed parameters: query:issuerSchemas added
CommonREOActivityV2REOActivityV2Schemas modified
CommonCDIVActivityV2— changed properties: foreign, specialDIVSPDActivityV2— schema keywords changedSchemas extended (additive)
ActivitySubType— documentation onlyActivityType— added enum valuesActivityV2DetailNTA— added composition membersCDIVActivityV2— documentation onlyNonTradeActivities— added enum valuesTokenizationIssuer— added enum valuesTokenizationNetwork— added enum valuesEnum values added
ActivityType: REOCommonCDIVActivityV2.foreign: falseCommonCDIVActivityV2.foreign: trueCommonCDIVActivityV2.special: falseCommonCDIVActivityV2.special: trueDIVSPDActivityV2.allOf[1].foreign: falseDIVSPDActivityV2.allOf[1].foreign: trueDIVSPDActivityV2.allOf[1].special: falseDIVSPDActivityV2.allOf[1].special: trueNonTradeActivities.activity_type: REOTokenizationIssuer: binanceTokenizationIssuer: coinbaseTokenizationNetwork: cronosTokenizationNetwork: hyperevmEnum values removed
GET /v2/tokenization/requests parameter query:issuer: xstocksbroker
Changelog draft
Breaking
AccountExtended(schema keywords changed)CommonCDIVActivityV2(changed properties: foreign, special)DIVSPDActivityV2(schema keywords changed)Added
CommonREOActivityV2REOActivityV2ActivityType: REOCommonCDIVActivityV2.foreign: falseCommonCDIVActivityV2.foreign: trueCommonCDIVActivityV2.special: falseCommonCDIVActivityV2.special: trueDIVSPDActivityV2.allOf[1].foreign: falseDIVSPDActivityV2.allOf[1].foreign: trueDIVSPDActivityV2.allOf[1].special: falseDIVSPDActivityV2.allOf[1].special: trueTokenizationIssuer: binanceTokenizationIssuer: coinbaseTokenizationNetwork: cronosTokenizationNetwork: hyperevmPOST /v1/jit/settlements(documentation only)ActivitySubType(documentation only)ActivityType(added enum values)ActivityV2DetailNTA(added composition members)CDIVActivityV2(documentation only)TokenizationIssuer(added enum values)TokenizationNetwork(added enum values)TradeUpdateEventType(documentation only)TradeUpdateEventV2(added properties: reason)data
Changelog draft
Breaking
GET /v1beta3/crypto/{loc}/bars(security requirements changed)GET /v1beta3/crypto/{loc}/latest/bars(security requirements changed)GET /v1beta3/crypto/{loc}/latest/orderbooks(security requirements changed)GET /v1beta3/crypto/{loc}/latest/quotes(security requirements changed)GET /v1beta3/crypto/{loc}/latest/trades(security requirements changed)GET /v1beta3/crypto/{loc}/quotes(security requirements changed)GET /v1beta3/crypto/{loc}/snapshots(security requirements changed)GET /v1beta3/crypto/{loc}/trades(security requirements changed)Added
GET /v1beta1/fixed_income/latest/pricesGET /v1beta1/fixed_income/latest/quotesfixed_income_latest_prices_respfixed_income_latest_quotes_respfixed_income_pricefixed_income_quoteGET /v1/corporate-actions(added security alternatives)GET /v1beta1/events/corporate-actions(added security alternatives)GET /v1beta1/forex/latest/rates(added security alternatives)GET /v1beta1/forex/rates(added security alternatives)GET /v1beta1/logos/{symbol}(added security alternatives)GET /v1beta1/news(added security alternatives)GET /v1beta1/options/bars(added security alternatives)GET /v1beta1/options/meta/conditions/{ticktype}(added security alternatives)GET /v1beta1/options/meta/exchanges(added security alternatives)GET /v1beta1/options/quotes/latest(added security alternatives)GET /v1beta1/options/snapshots(added security alternatives)GET /v1beta1/options/snapshots/{underlying_symbol}(added security alternatives)GET /v1beta1/options/trades(added security alternatives)GET /v1beta1/options/trades/latest(added security alternatives)GET /v1beta1/screener/stocks/most-actives(added security alternatives)GET /v1beta1/screener/{market_type}/movers(added security alternatives)GET /v2/stocks/auctions(added security alternatives)GET /v2/stocks/bars(added security alternatives)GET /v2/stocks/bars/latest(added security alternatives)GET /v2/stocks/meta/conditions/{ticktype}(added security alternatives)GET /v2/stocks/meta/exchanges(added security alternatives)GET /v2/stocks/quotes(added security alternatives)GET /v2/stocks/quotes/latest(added security alternatives)GET /v2/stocks/snapshots(added security alternatives)GET /v2/stocks/trades(added security alternatives)GET /v2/stocks/trades/latest(added security alternatives)GET /v2/stocks/{symbol}/auctions(added security alternatives)GET /v2/stocks/{symbol}/bars(added security alternatives)GET /v2/stocks/{symbol}/bars/latest(added security alternatives)GET /v2/stocks/{symbol}/quotes(added security alternatives)GET /v2/stocks/{symbol}/quotes/latest(added security alternatives)GET /v2/stocks/{symbol}/snapshot(added security alternatives)GET /v2/stocks/{symbol}/trades(added security alternatives)GET /v2/stocks/{symbol}/trades/latest(added security alternatives)ca_event_cash_dividend(documentation only)ca_event_cash_merger(documentation only)ca_event_equity_partial_call(documentation only)ca_event_forward_split(documentation only)ca_event_redemption(documentation only)ca_event_reorganization(documentation only)ca_event_reorganization_stock_movement(documentation only)ca_event_reverse_split(documentation only)ca_event_rights_distribution(documentation only)ca_event_spin_off(documentation only)ca_event_stock_and_cash_merger(documentation only)ca_event_stock_dividend(documentation only)ca_event_stock_merger(documentation only)ca_event_unit_split(documentation only)cash_dividend(documentation only)cash_merger(documentation only)corporate_action_event_base(documentation only)crypto_bar(documentation only)crypto_orderbook(documentation only)crypto_orderbook_entry(documentation only)crypto_quote(documentation only)crypto_trade(documentation only)event_id(documentation only)forex_currency_pairs(documentation only)forex_rate(documentation only)forward_split(documentation only)most_active(documentation only)mover(documentation only)name_change(documentation only)news_image(documentation only)option_bar(documentation only)option_conditions(documentation only)option_exchanges(documentation only)option_quote(documentation only)option_trade(documentation only)redemption(documentation only)reverse_split(documentation only)rights_distribution(documentation only)spin_off(documentation only)stock_and_cash_merger(documentation only)stock_auction(documentation only)stock_bar(documentation only)stock_conditions(documentation only)stock_dividend(documentation only)stock_exchanges(documentation only)stock_merger(documentation only)stock_quote(documentation only)stock_trade(documentation only)unit_split(documentation only)worthless_removal(documentation only)trading
Changelog draft
Breaking
GET /v2/tokenization/requests(changed parameters: query:issuer)CommonCDIVActivityV2(changed properties: foreign, special)DIVSPDActivityV2(schema keywords changed)GET /v2/tokenization/requests parameter query:issuer: xstocksAdded
CommonREOActivityV2REOActivityV2ActivityType: REOCommonCDIVActivityV2.foreign: falseCommonCDIVActivityV2.foreign: trueCommonCDIVActivityV2.special: falseCommonCDIVActivityV2.special: trueDIVSPDActivityV2.allOf[1].foreign: falseDIVSPDActivityV2.allOf[1].foreign: trueDIVSPDActivityV2.allOf[1].special: falseDIVSPDActivityV2.allOf[1].special: trueNonTradeActivities.activity_type: REOTokenizationIssuer: binanceTokenizationIssuer: coinbaseTokenizationNetwork: cronosTokenizationNetwork: hyperevmActivitySubType(documentation only)ActivityType(added enum values)ActivityV2DetailNTA(added composition members)CDIVActivityV2(documentation only)NonTradeActivities(added enum values)TokenizationIssuer(added enum values)TokenizationNetwork(added enum values)