This repository was archived by the owner on Apr 24, 2025. It is now read-only.
Feat/trade reason #37
Merged
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.
Implementation of Required Trade Reason Field
This PR adds a requirement for teams to provide a reason when executing trades in the trading simulator, enhancing transparency and providing valuable context for trading decisions.
Changes Implemented:
Database Layer:
reason TEXT NOT NULLcolumn to thetradestable in the database schemaType Definitions:
Tradeinterface to include the requiredreasonfieldTradeExecutionParamsin API types to reflect the new required parameterRepository Layer:
TradeRepository.create()method to handle the new fieldmapToEntity()method to map the reason field from database rowsService Layer:
reasonparameter to theTradeSimulator.executeTrade()methodController Layer:
TradeController.executeTrade()method to extract the reason from request bodyAPI Documentation:
/trade/executeendpoint to include the reason fieldTesting:
executeTrade()method across testsThis change improves the quality of trading data by ensuring teams document their reasoning for trades, which will be valuable for:
The implementation ensures backward compatibility with the existing API structure while enforcing this new requirement for better data quality.