Skip to content

Fix OpenAPI 3.1 schema errors in API spec#2298

Merged
AlexCatarino merged 1 commit intoQuantConnect:masterfrom
AlexCatarino:bug-2297-openapi-lint-errors
Apr 9, 2026
Merged

Fix OpenAPI 3.1 schema errors in API spec#2298
AlexCatarino merged 1 commit intoQuantConnect:masterfrom
AlexCatarino:bug-2297-openapi-lint-errors

Conversation

@AlexCatarino
Copy link
Copy Markdown
Member

@AlexCatarino AlexCatarino commented Apr 9, 2026

Summary

  • Convert 46 nullable: true usages to OpenAPI 3.1 syntax (type: [T, "null"] for typed properties, oneOf with type: "null" for allOf/$ref properties)
  • Fix type: int to type: integer in Project.maxFileSize
  • Add 5 missing properties (created, psr, sharpeRatio, trades, cloneId) to Optimization schema and remove 2 non-existent fields (apiProviders, source) from its required array
  • Regenerate API reference pages

Resolves #2297

Test plan

  • Run vacuum lint QuantConnect-Platform-2.0.0.yaml --fail-severity error and confirm zero schema errors
  • Verify API reference pages render correctly on quantconnect.com/docs
  • Confirm generated pages match the updated YAML spec

@AlexCatarino AlexCatarino merged commit 5ea152b into QuantConnect:master Apr 9, 2026
1 check passed
@AlexCatarino AlexCatarino deleted the bug-2297-openapi-lint-errors branch April 9, 2026 18:41
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.

OpenAPI spec lint errors detected

1 participant