Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Api Clean up, Documentation and Standarization part five #8016

Merged

Conversation

Marinovsky
Copy link
Collaborator

Description

  • Clean up to some classes
  • Standardization to camel case in the request and response classes to the API
  • Improvement of unit tests
  • Addition of API class responses for live/portfolio/read and live/insights/read
  • Renaming in the endpoints backtests/orders/read, live/list, live/orders/read, live/logs/read
  • Update to some API class responses

Related Issue

Closes #7893

Motivation and Context

With theses changes, the C# API response class of some endpoints will be updated

Requires Documentation Change

N/A (Already done)

How Has This Been Tested?

There were already unit tests in the classes ProjectTests.cs, OptimizationTests.cs and LiveTradingTests.cs that asserted the behavior of these endpoints. Those tests were updated and expanded to assert new scenarios.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • Refactor (non-breaking change which improves implementation)
  • Performance (non-breaking change which improves performance. Please add associated performance test and results)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Non-functional change (xml comments/documentation/etc)

Checklist:

  • My code follows the code style of this project.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • My branch follows the naming convention bug-<issue#>-<description> or feature-<issue#>-<description>

@Marinovsky Marinovsky force-pushed the bug-7893-APIRefreshPartFive branch from 94c9fd8 to 5cbfd3a Compare May 13, 2024 15:31
Copy link
Member

@Martin-Molinero Martin-Molinero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! 🚀

@Martin-Molinero Martin-Molinero merged commit b147c7c into QuantConnect:master May 13, 2024
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants