Skip to content

chore(openapi): adopt upstream OpenAPI specs (draft — needs review) - #65

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
bot/openapi-adopt
Draft

chore(openapi): adopt upstream OpenAPI specs (draft — needs review)#65
github-actions[bot] wants to merge 1 commit into
mainfrom
bot/openapi-adopt

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

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 only

Schemas added

  • CommonREOActivityV2
  • REOActivityV2

Schemas modified

  • AccountExtended — schema keywords changed
  • CommonCDIVActivityV2 — changed properties: foreign, special
  • DIVSPDActivityV2 — schema keywords changed

Schemas extended (additive)

  • 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

Enum values added

  • ActivityType: REO
  • CommonCDIVActivityV2.foreign: false
  • CommonCDIVActivityV2.foreign: true
  • CommonCDIVActivityV2.special: false
  • CommonCDIVActivityV2.special: true
  • DIVSPDActivityV2.allOf[1].foreign: false
  • DIVSPDActivityV2.allOf[1].foreign: true
  • DIVSPDActivityV2.allOf[1].special: false
  • DIVSPDActivityV2.allOf[1].special: true
  • TokenizationIssuer: binance
  • TokenizationIssuer: coinbase
  • TokenizationNetwork: cronos
  • TokenizationNetwork: hyperevm

OpenAPI adopt report (data)

Breaking changes detected.

Operations added

  • GET /v1beta1/fixed_income/latest/prices
  • GET /v1beta1/fixed_income/latest/quotes

Operations modified

  • 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

Operations extended (additive)

  • GET /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

Schemas added

  • fixed_income_latest_prices_resp
  • fixed_income_latest_quotes_resp
  • fixed_income_price
  • fixed_income_quote

Schemas extended (additive)

  • 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

OpenAPI adopt report (trading)

Breaking changes detected.

Operations modified

  • GET /v2/tokenization/requests — changed parameters: query:issuer

Schemas added

  • CommonREOActivityV2
  • REOActivityV2

Schemas modified

  • CommonCDIVActivityV2 — changed properties: foreign, special
  • DIVSPDActivityV2 — schema keywords changed

Schemas extended (additive)

  • ActivitySubType — 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

Enum values added

  • ActivityType: REO
  • CommonCDIVActivityV2.foreign: false
  • CommonCDIVActivityV2.foreign: true
  • CommonCDIVActivityV2.special: false
  • CommonCDIVActivityV2.special: true
  • DIVSPDActivityV2.allOf[1].foreign: false
  • DIVSPDActivityV2.allOf[1].foreign: true
  • DIVSPDActivityV2.allOf[1].special: false
  • DIVSPDActivityV2.allOf[1].special: true
  • NonTradeActivities.activity_type: REO
  • TokenizationIssuer: binance
  • TokenizationIssuer: coinbase
  • TokenizationNetwork: cronos
  • TokenizationNetwork: hyperevm

Enum values removed

  • GET /v2/tokenization/requests parameter query:issuer: xstocks

broker

Changelog draft

Breaking

  • Modify schema AccountExtended (schema keywords changed)
  • Modify schema CommonCDIVActivityV2 (changed properties: foreign, special)
  • Modify schema DIVSPDActivityV2 (schema keywords changed)

Added

  • Add schema CommonREOActivityV2
  • Add schema REOActivityV2
  • Add enum value ActivityType: REO
  • Add enum value CommonCDIVActivityV2.foreign: false
  • Add enum value CommonCDIVActivityV2.foreign: true
  • Add enum value CommonCDIVActivityV2.special: false
  • Add enum value CommonCDIVActivityV2.special: true
  • Add enum value DIVSPDActivityV2.allOf[1].foreign: false
  • Add enum value DIVSPDActivityV2.allOf[1].foreign: true
  • Add enum value DIVSPDActivityV2.allOf[1].special: false
  • Add enum value DIVSPDActivityV2.allOf[1].special: true
  • Add enum value TokenizationIssuer: binance
  • Add enum value TokenizationIssuer: coinbase
  • Add enum value TokenizationNetwork: cronos
  • Add enum value TokenizationNetwork: hyperevm
  • Extend operation POST /v1/jit/settlements (documentation only)
  • Extend schema ActivitySubType (documentation only)
  • Extend schema ActivityType (added enum values)
  • Extend schema ActivityV2DetailNTA (added composition members)
  • Extend schema CDIVActivityV2 (documentation only)
  • Extend schema TokenizationIssuer (added enum values)
  • Extend schema TokenizationNetwork (added enum values)
  • Extend schema TradeUpdateEventType (documentation only)
  • Extend schema TradeUpdateEventV2 (added properties: reason)

data

Changelog draft

Breaking

  • Modify operation GET /v1beta3/crypto/{loc}/bars (security requirements changed)
  • Modify operation GET /v1beta3/crypto/{loc}/latest/bars (security requirements changed)
  • Modify operation GET /v1beta3/crypto/{loc}/latest/orderbooks (security requirements changed)
  • Modify operation GET /v1beta3/crypto/{loc}/latest/quotes (security requirements changed)
  • Modify operation GET /v1beta3/crypto/{loc}/latest/trades (security requirements changed)
  • Modify operation GET /v1beta3/crypto/{loc}/quotes (security requirements changed)
  • Modify operation GET /v1beta3/crypto/{loc}/snapshots (security requirements changed)
  • Modify operation GET /v1beta3/crypto/{loc}/trades (security requirements changed)

Added

  • Add operation GET /v1beta1/fixed_income/latest/prices
  • Add operation GET /v1beta1/fixed_income/latest/quotes
  • Add schema fixed_income_latest_prices_resp
  • Add schema fixed_income_latest_quotes_resp
  • Add schema fixed_income_price
  • Add schema fixed_income_quote
  • Extend operation GET /v1/corporate-actions (added security alternatives)
  • Extend operation GET /v1beta1/events/corporate-actions (added security alternatives)
  • Extend operation GET /v1beta1/forex/latest/rates (added security alternatives)
  • Extend operation GET /v1beta1/forex/rates (added security alternatives)
  • Extend operation GET /v1beta1/logos/{symbol} (added security alternatives)
  • Extend operation GET /v1beta1/news (added security alternatives)
  • Extend operation GET /v1beta1/options/bars (added security alternatives)
  • Extend operation GET /v1beta1/options/meta/conditions/{ticktype} (added security alternatives)
  • Extend operation GET /v1beta1/options/meta/exchanges (added security alternatives)
  • Extend operation GET /v1beta1/options/quotes/latest (added security alternatives)
  • Extend operation GET /v1beta1/options/snapshots (added security alternatives)
  • Extend operation GET /v1beta1/options/snapshots/{underlying_symbol} (added security alternatives)
  • Extend operation GET /v1beta1/options/trades (added security alternatives)
  • Extend operation GET /v1beta1/options/trades/latest (added security alternatives)
  • Extend operation GET /v1beta1/screener/stocks/most-actives (added security alternatives)
  • Extend operation GET /v1beta1/screener/{market_type}/movers (added security alternatives)
  • Extend operation GET /v2/stocks/auctions (added security alternatives)
  • Extend operation GET /v2/stocks/bars (added security alternatives)
  • Extend operation GET /v2/stocks/bars/latest (added security alternatives)
  • Extend operation GET /v2/stocks/meta/conditions/{ticktype} (added security alternatives)
  • Extend operation GET /v2/stocks/meta/exchanges (added security alternatives)
  • Extend operation GET /v2/stocks/quotes (added security alternatives)
  • Extend operation GET /v2/stocks/quotes/latest (added security alternatives)
  • Extend operation GET /v2/stocks/snapshots (added security alternatives)
  • Extend operation GET /v2/stocks/trades (added security alternatives)
  • Extend operation GET /v2/stocks/trades/latest (added security alternatives)
  • Extend operation GET /v2/stocks/{symbol}/auctions (added security alternatives)
  • Extend operation GET /v2/stocks/{symbol}/bars (added security alternatives)
  • Extend operation GET /v2/stocks/{symbol}/bars/latest (added security alternatives)
  • Extend operation GET /v2/stocks/{symbol}/quotes (added security alternatives)
  • Extend operation GET /v2/stocks/{symbol}/quotes/latest (added security alternatives)
  • Extend operation GET /v2/stocks/{symbol}/snapshot (added security alternatives)
  • Extend operation GET /v2/stocks/{symbol}/trades (added security alternatives)
  • Extend operation GET /v2/stocks/{symbol}/trades/latest (added security alternatives)
  • Extend schema ca_event_cash_dividend (documentation only)
  • Extend schema ca_event_cash_merger (documentation only)
  • Extend schema ca_event_equity_partial_call (documentation only)
  • Extend schema ca_event_forward_split (documentation only)
  • Extend schema ca_event_redemption (documentation only)
  • Extend schema ca_event_reorganization (documentation only)
  • Extend schema ca_event_reorganization_stock_movement (documentation only)
  • Extend schema ca_event_reverse_split (documentation only)
  • Extend schema ca_event_rights_distribution (documentation only)
  • Extend schema ca_event_spin_off (documentation only)
  • Extend schema ca_event_stock_and_cash_merger (documentation only)
  • Extend schema ca_event_stock_dividend (documentation only)
  • Extend schema ca_event_stock_merger (documentation only)
  • Extend schema ca_event_unit_split (documentation only)
  • Extend schema cash_dividend (documentation only)
  • Extend schema cash_merger (documentation only)
  • Extend schema corporate_action_event_base (documentation only)
  • Extend schema crypto_bar (documentation only)
  • Extend schema crypto_orderbook (documentation only)
  • Extend schema crypto_orderbook_entry (documentation only)
  • Extend schema crypto_quote (documentation only)
  • Extend schema crypto_trade (documentation only)
  • Extend schema event_id (documentation only)
  • Extend schema forex_currency_pairs (documentation only)
  • Extend schema forex_rate (documentation only)
  • Extend schema forward_split (documentation only)
  • Extend schema most_active (documentation only)
  • Extend schema mover (documentation only)
  • Extend schema name_change (documentation only)
  • Extend schema news_image (documentation only)
  • Extend schema option_bar (documentation only)
  • Extend schema option_conditions (documentation only)
  • Extend schema option_exchanges (documentation only)
  • Extend schema option_quote (documentation only)
  • Extend schema option_trade (documentation only)
  • Extend schema redemption (documentation only)
  • Extend schema reverse_split (documentation only)
  • Extend schema rights_distribution (documentation only)
  • Extend schema spin_off (documentation only)
  • Extend schema stock_and_cash_merger (documentation only)
  • Extend schema stock_auction (documentation only)
  • Extend schema stock_bar (documentation only)
  • Extend schema stock_conditions (documentation only)
  • Extend schema stock_dividend (documentation only)
  • Extend schema stock_exchanges (documentation only)
  • Extend schema stock_merger (documentation only)
  • Extend schema stock_quote (documentation only)
  • Extend schema stock_trade (documentation only)
  • Extend schema unit_split (documentation only)
  • Extend schema worthless_removal (documentation only)

trading

Changelog draft

Breaking

  • Modify operation GET /v2/tokenization/requests (changed parameters: query:issuer)
  • Modify schema CommonCDIVActivityV2 (changed properties: foreign, special)
  • Modify schema DIVSPDActivityV2 (schema keywords changed)
  • Remove enum value GET /v2/tokenization/requests parameter query:issuer: xstocks

Added

  • Add schema CommonREOActivityV2
  • Add schema REOActivityV2
  • Add enum value ActivityType: REO
  • Add enum value CommonCDIVActivityV2.foreign: false
  • Add enum value CommonCDIVActivityV2.foreign: true
  • Add enum value CommonCDIVActivityV2.special: false
  • Add enum value CommonCDIVActivityV2.special: true
  • Add enum value DIVSPDActivityV2.allOf[1].foreign: false
  • Add enum value DIVSPDActivityV2.allOf[1].foreign: true
  • Add enum value DIVSPDActivityV2.allOf[1].special: false
  • Add enum value DIVSPDActivityV2.allOf[1].special: true
  • Add enum value NonTradeActivities.activity_type: REO
  • Add enum value TokenizationIssuer: binance
  • Add enum value TokenizationIssuer: coinbase
  • Add enum value TokenizationNetwork: cronos
  • Add enum value TokenizationNetwork: hyperevm
  • Extend schema ActivitySubType (documentation only)
  • Extend schema ActivityType (added enum values)
  • Extend schema ActivityV2DetailNTA (added composition members)
  • Extend schema CDIVActivityV2 (documentation only)
  • Extend schema NonTradeActivities (added enum values)
  • Extend schema TokenizationIssuer (added enum values)
  • Extend schema TokenizationNetwork (added enum values)

@github-actions github-actions Bot added openapi-drift OpenAPI pin/generated drift adopt openapi-adopt Automated OpenAPI adopt PR breaking Classifier reported breaking OpenAPI surface changes labels Aug 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking Classifier reported breaking OpenAPI surface changes openapi-adopt Automated OpenAPI adopt PR openapi-drift OpenAPI pin/generated drift adopt

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants