remove unused order types from documentation #1559
Conversation
WalkthroughThe recent changes primarily involve the removal of Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (54)
indexer/services/comlink/public/api-documentation.md (54)
Line range hint
2676-2676: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_PerpetualPositionStatus"></a> + <an id="schema_PerpetualPositionStatus"></a>
Line range hint
2702-2702: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_PositionSide"></a> + <an id="schema_PositionSide"></a>
Line range hint
2727-2727: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_IsoString"></a> + <an id="schema_IsoString"></a>
Line range hint
2745-2745: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_PerpetualPositionResponseObject"></a> + <an id="schema_PerpetualPositionResponseObject"></a>
Line range hint
2795-2795: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_PerpetualPositionsMap"></a> + <an id="schema_PerpetualPositionsMap"></a>
Line range hint
2850-2850: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_AssetPositionResponseObject"></a> + <an id="schema_AssetPositionResponseObject"></a>
Line range hint
2878-2878: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_AssetPositionsMap"></a> + <an id="schema_AssetPositionsMap"></a>
Line range hint
2911-2911: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_SubaccountResponseObject"></a> + <an id="schema_SubaccountResponseObject"></a>
Line range hint
2997-2997: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_AddressResponse"></a> + <an id="schema_AddressResponse"></a>
Line range hint
3082-3082: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_ParentSubaccountResponse"></a> + <an id="schema_ParentSubaccountResponse"></a>
Line range hint
3173-3173: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_AssetPositionResponse"></a> + <an id="schema_AssetPositionResponse"></a>
Line range hint
3201-3201: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_CandleResolution"></a> + <an id="schema_CandleResolution"></a>
Line range hint
3231-3231: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_CandleResponseObject"></a> + <an id="schema_CandleResponseObject"></a>
Line range hint
3273-3273: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_CandleResponse"></a> + <an id="schema_CandleResponse"></a>
Line range hint
3308-3308: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_ComplianceResponse"></a> + <an id="schema_ComplianceResponse"></a>
Line range hint
3330-3330: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_ComplianceStatus"></a> + <an id="schema_ComplianceStatus"></a>
Line range hint
3358-3358: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_ComplianceReason"></a> + <an id="schema_ComplianceReason"></a>
Line range hint
3386-3386: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_ComplianceV2Response"></a> + <an id="schema_ComplianceV2Response"></a>
Line range hint
3410-3410: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_OrderSide"></a> + <an id="schema_OrderSide"></a>
Line range hint
3435-3435: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_Liquidity"></a> + <an id="schema_Liquidity"></a>
Line range hint
3460-3460: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_FillType"></a> + <an id="schema_FillType"></a>
Line range hint
3488-3488: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_MarketType"></a> + <an id="schema_MarketType"></a>
Line range hint
3513-3513: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_FillResponseObject"></a> + <an id="schema_FillResponseObject"></a>
Line range hint
3559-3559: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_FillResponse"></a> + <an id="schema_FillResponse"></a>
Line range hint
3602-3602: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_HeightResponse"></a> + <an id="schema_HeightResponse"></a>
Line range hint
3624-3624: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_HistoricalBlockTradingReward"></a> + <an id="schema_HistoricalBlockTradingReward"></a>
Line range hint
3648-3648: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_HistoricalBlockTradingRewardsResponse"></a> + <an id="schema_HistoricalBlockTradingRewardsResponse"></a>
Line range hint
3674-3674: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_HistoricalFundingResponseObject"></a> + <an id="schema_HistoricalFundingResponseObject"></a>
Line range hint
3702-3702: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_HistoricalFundingResponse"></a> + <an id="schema_HistoricalFundingResponse"></a>
Line range hint
3730-3730: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_PnlTicksResponseObject"></a> + <an id="schema_PnlTicksResponseObject"></a>
Line range hint
3764-3764: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_HistoricalPnlResponse"></a> + <an id="schema_HistoricalPnlResponse"></a>
Line range hint
3801-3801: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_TradingRewardAggregationPeriod"></a> + <an id="schema_TradingRewardAggregationPeriod"></a>
Line range hint
3827-3827: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_HistoricalTradingRewardAggregation"></a> + <an id="schema_HistoricalTradingRewardAggregation"></a>
Line range hint
3857-3857: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_HistoricalTradingRewardAggregationsResponse"></a> + <an id="schema_HistoricalTradingRewardAggregationsResponse"></a>
Line range hint
3886-3886: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_OrderbookResponsePriceLevel"></a> + <an id="schema_OrderbookResponsePriceLevel"></a>
Line range hint
3908-3908: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_OrderbookResponseObject"></a> + <an id="schema_OrderbookResponseObject"></a>
Line range hint
3940-3940: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_APITimeInForce"></a> + <an id="schema_APITimeInForce"></a>
Line range hint
3966-3966: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_OrderStatus"></a> + <an id="schema_OrderStatus"></a>
Line range hint
3994-3994: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_BestEffortOpenedStatus"></a> + <an id="schema_BestEffortOpenedStatus"></a>
Line range hint
4018-4018: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_APIOrderStatus"></a> + <an id="schema_APIOrderStatus"></a>
Line range hint
4044-4044: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_OrderType"></a> + <an id="schema_OrderType"></a>
Line range hint
4074-4074: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_OrderResponseObject"></a> + <an id="schema_OrderResponseObject"></a>
Line range hint
4138-4138: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_PerpetualMarketStatus"></a> + <an id="schema_PerpetualMarketStatus"></a>
Line range hint
4167-4167: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_PerpetualMarketType"></a> + <an id="schema_PerpetualMarketType"></a>
Line range hint
4192-4192: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_PerpetualMarketResponseObject"></a> + <an id="schema_PerpetualMarketResponseObject"></a>
Line range hint
4252-4252: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_PerpetualMarketResponse"></a> + <an id="schema_PerpetualMarketResponse"></a>
Line range hint
4320-4320: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_PerpetualPositionResponse"></a> + <an id="schema_PerpetualPositionResponse"></a>
Line range hint
4359-4359: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_SparklineResponseObject"></a> + <an id="schema_SparklineResponseObject"></a>
Line range hint
4384-4384: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_SparklineTimePeriod"></a> + <an id="schema_SparklineTimePeriod"></a>
Line range hint
4409-4409: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_TimeResponse"></a> + <an id="schema_TimeResponse"></a>
Line range hint
4431-4431: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_TradeType"></a> + <an id="schema_TradeType"></a>
Line range hint
4457-4457: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_TradeResponseObject"></a> + <an id="schema_TradeResponseObject"></a>
Line range hint
4489-4489: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_TradeResponse"></a> + <an id="schema_TradeResponse"></a>
Line range hint
4525-4525: Use "an" instead of "a" before words that start with a vowel sound.- <a id="schema_TransferType"></a> + <an id="schema_TransferType"></a>
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
indexer/services/comlink/public/swagger.jsonis excluded by!**/*.json
Files selected for processing (5)
- indexer/packages/postgres/tests/lib/protocol-translations.test.ts (1 hunks)
- indexer/packages/postgres/src/lib/protocol-translations.ts (1 hunks)
- indexer/packages/postgres/src/types/order-types.ts (1 hunks)
- indexer/services/comlink/public/api-documentation.md (5 hunks)
- indexer/services/comlink/public/websocket-documentation.md (12 hunks)
Files skipped from review due to trivial changes (1)
- indexer/packages/postgres/src/lib/protocol-translations.ts
Additional Context Used
LanguageTool (116)
indexer/services/comlink/public/api-documentation.md (114)
Near line 2676: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...id="schemaperpetualpositionstatus"> </a...
Near line 2677: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...d="schema_PerpetualPositionStatus"> <...
Near line 2702: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...onSide <a id="to...
Near line 2703: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ..."> <a id="tocsp...
Near line 2727: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...IsoString <a id="tocSi...
Near line 2728: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ing"> <a id="tocsisos...
Near line 2745: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...maperpetualpositionresponseobject"> <a id="schema_PerpetualPositionResponseObj...
Near line 2746: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...a_PerpetualPositionResponseObject"> <a id="tocSperpetualpositionresponseobject...
Near line 2795: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...a id="schemaperpetualpositionsmap"> ...
Near line 2796: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... id="schema_PerpetualPositionsMap"> <a ...
Near line 2850: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...schemaassetpositionresponseobject"> <a id="schema_AssetPositionResponseObject"...
Near line 2851: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...chema_AssetPositionResponseObject"> </...
Near line 2878: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...p <a i...
Near line 2879: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...> <a id="...
Near line 2911: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...d="schemasubaccountresponseobject"> </...
Near line 2912: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...="schema_SubaccountResponseObject"> ...
Near line 2997: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...nse <a id=...
Near line 2998: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: .../a> <a id="to...
Near line 3082: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...d="schemaparentsubaccountresponse"> </...
Near line 3083: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...="schema_ParentSubaccountResponse"> ...
Near line 3173: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...a id="schemaassetpositionresponse"> ...
Near line 3174: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... id="schema_AssetPositionResponse"> <a ...
Near line 3201: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...on <a id...
Near line 3202: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...a> <a id="t...
Near line 3231: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... <...
Near line 3232: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...a id="schema_CandleResponseObject"> <a i...
Near line 3273: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...onse <a id="...
Near line 3274: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... <a id="toc...
Near line 3308: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... <a ...
Near line 3309: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... <a id=...
Near line 3330: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...us <a id...
Near line 3331: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...a> <a id="t...
Near line 3358: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...on <a id...
Near line 3359: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...a> <a id="t...
Near line 3386: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... <...
Near line 3387: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...a id="schema_ComplianceV2Response"> <a i...
Near line 3410: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...OrderSide <a id="tocSo...
Near line 3411: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ide"> <a id="tocsorde...
Near line 3435: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...Liquidity <a id="tocSl...
Near line 3436: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ity"> <a id="tocsliqu...
Near line 3460: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...# FillType <a id="tocSfi...
Near line 3461: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...type"> <a id="tocsfillt...
Near line 3488: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...rketType <a id="tocS...
Near line 3489: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...pe"> <a id="tocsmar...
Near line 3513: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... <a ...
Near line 3514: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... <a id=...
Near line 3559: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...sponse <a id="to...
Near line 3560: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ..."> <a id="tocsf...
Near line 3602: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...onse <a id="...
Near line 3603: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... <a id="toc...
Near line 3624: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...chemahistoricalblocktradingreward"> <a id="schema_HistoricalBlockTradingReward...
Near line 3625: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...hema_HistoricalBlockTradingReward"> <...
Near line 3648: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...oricalblocktradingrewardsresponse"> <a id="schema_HistoricalBlockTradingReward...
Near line 3649: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...oricalBlockTradingRewardsResponse"> <a id="tocShistoricalblocktradingrewardsre...
Near line 3674: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...mahistoricalfundingresponseobject"> <a id="schema_HistoricalFundingResponseObj...
Near line 3675: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...a_HistoricalFundingResponseObject"> <a id="tocShistoricalfundingresponseobject...
Near line 3702: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...="schemahistoricalfundingresponse"> <...
Near line 3703: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ..."schema_HistoricalFundingResponse"> ...
Near line 3730: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... id="schemapnlticksresponseobject"> ...
Near line 3731: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...id="schema_PnlTicksResponseObject"> <a...
Near line 3764: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...a id="schemahistoricalpnlresponse"> ...
Near line 3765: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... id="schema_HistoricalPnlResponse"> <a ...
Near line 3801: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ematradingrewardaggregationperiod"> <a id="schema_TradingRewardAggregationPeri...
Near line 3802: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ma_TradingRewardAggregationPeriod"> <a id="tocStradingrewardaggregationperiod"...
Near line 3827: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...istoricaltradingrewardaggregation"> <a id="schema_HistoricalTradingRewardAggre...
Near line 3828: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...istoricalTradingRewardAggregation"> <a id="tocShistoricaltradingrewardaggregat...
Near line 3857: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...tradingrewardaggregationsresponse"> <a id="schema_HistoricalTradingRewardAggre...
Near line 3858: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...TradingRewardAggregationsResponse"> <a id="tocShistoricaltradingrewardaggregat...
Near line 3886: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...schemaorderbookresponsepricelevel"> <a id="schema_OrderbookResponsePriceLevel"...
Near line 3887: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...chema_OrderbookResponsePriceLevel"> </...
Near line 3908: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...id="schemaorderbookresponseobject"> </a...
Near line 3909: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...d="schema_OrderbookResponseObject"> <...
Near line 3940: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...orce <a id="...
Near line 3941: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... <a id="toc...
Near line 3966: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...rStatus <a id="toc...
Near line 3967: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...s"> <a id="tocsor...
Near line 3994: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... id="schemabesteffortopenedstatus"> ...
Near line 3995: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...id="schema_BestEffortOpenedStatus"> <a...
Near line 4018: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...atus <a id="...
Near line 4019: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... <a id="toc...
Near line 4044: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...OrderType <a id="tocSo...
Near line 4045: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ype"> <a id="tocsorde...
Near line 4074: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... <a...
Near line 4075: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... <a id...
Near line 4138: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...a id="schemaperpetualmarketstatus"> ...
Near line 4139: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... id="schema_PerpetualMarketStatus"> <a ...
Near line 4167: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... <a...
Near line 4168: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... <a id...
Near line 4192: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...hemaperpetualmarketresponseobject"> <a id="schema_PerpetualMarketResponseObjec...
Near line 4193: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ema_PerpetualMarketResponseObject"> ...
Near line 4252: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...id="schemaperpetualmarketresponse"> </a...
Near line 4253: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...d="schema_PerpetualMarketResponse"> <...
Near line 4320: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...="schemaperpetualpositionresponse"> <...
Near line 4321: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ..."schema_PerpetualPositionResponse"> ...
Near line 4359: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...id="schemasparklineresponseobject"> </a...
Near line 4360: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...d="schema_SparklineResponseObject"> <...
Near line 4384: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... <a...
Near line 4385: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... <a id...
Near line 4409: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...sponse <a id="to...
Near line 4410: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ..."> <a id="tocst...
Near line 4431: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...TradeType <a id="tocSt...
Near line 4432: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ype"> <a id="tocstrad...
Near line 4457: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... <a...
Near line 4458: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... <a id...
Near line 4489: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ponse <a id="t...
Near line 4490: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...> <a id="tocs...
Near line 4525: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...erType <a id="to...
Near line 4526: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ..."> <a id="tocst...
Near line 4552: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... id="schematransferresponseobject"> ...
Near line 4553: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...id="schema_TransferResponseObject"> <a...
Near line 4598: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...se <a id...
Near line 4599: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...a> <a id="t...
Near line 4642: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...aparentsubaccounttransferresponse"> <a id="schema_ParentSubaccountTransferResp...
Near line 4643: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ..._ParentSubaccountTransferResponse"> <a id="tocSparentsubaccounttransferrespons...indexer/services/comlink/public/websocket-documentation.md (2)
Near line 11: Possible missing comma found.
Context: ...all ### Connect Upon connecting to v4 Websockets you will receive an initial connection ...
Near line 31: Possible missing comma found.
Context: ...e Utilize the same message to subscribe but replace the type withunsubscribe. Fo...
Path-based Instructions (4)
indexer/packages/postgres/src/types/order-types.ts (1)
Pattern
**/**: Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.indexer/packages/postgres/__tests__/lib/protocol-translations.test.ts (1)
Pattern
**/**: Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.indexer/services/comlink/public/websocket-documentation.md (1)
Pattern
**/**: Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.indexer/services/comlink/public/api-documentation.md (1)
Pattern
**/**: Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.
Additional comments not posted (3)
indexer/packages/postgres/src/types/order-types.ts (1)
Line range hint
1-62: The removal of unused order types (HARD_TRADE,FAILED_HARD_TRADE,TRANSFER_PLACEHOLDER) appears to be cleanly executed with no residual references left in the file. This should help in maintaining the clarity and relevance of the type definitions.indexer/packages/postgres/__tests__/lib/protocol-translations.test.ts (1)
Line range hint
1-118: The updates to the test cases inprotocol-translations.test.tscorrectly reflect the removal of the unused order types. All references toHARD_TRADEandFAILED_HARD_TRADEhave been removed, ensuring that the tests remain relevant and focused on the existing functionalities.indexer/services/comlink/public/websocket-documentation.md (1)
Line range hint
1-908: The updates to the WebSocket documentation inwebsocket-documentation.mdcorrectly reflect the removal of the unused order types. This ensures that the documentation remains accurate and up-to-date with the current functionalities of the platform.
Changelist
Removes unused v3-legacy order types from documentation
Test Plan
Removal of dead code. Automated and unit tests.
Summary by CodeRabbit
Refactor
HARD_TRADE,FAILED_HARD_TRADE, andTRANSFER_PLACEHOLDERfrom various internal mappings and enums.Documentation
HARD_TRADE,FAILED_HARD_TRADE, andTRANSFER_PLACEHOLDERorder types.