## OpenAPI Lint Errors The `vacuum` linter found errors in `QuantConnect-Platform-2.0.0.yaml`. | Category | Errors | Warnings | Info | | ------------ | ------ | -------- | ---- | | Operations | 0 | 8 | 0 | | Tags | 0 | 269 | 0 | | Schemas | 54 | 173 | 2 | | Descriptions | 0 | 37 | 322 | | Examples | 0 | 166 | 0 | **Run:** https://github.com/QuantConnect/Documentation/actions/runs/24205466213 ## Steps to fix 1. Install vacuum locally: - **Linux/macOS:** `curl -fsSL https://quobix.com/scripts/install_vacuum.sh | sh` - **Windows:** download the latest release from https://github.com/daveshanley/vacuum/releases (e.g. `vacuum_*_windows_x86_64.tar.gz`), extract, and add to PATH. 2. Run vacuum to get the detailed error report: ``` vacuum lint QuantConnect-Platform-2.0.0.yaml --fail-severity error ``` 3. Fix each error in `QuantConnect-Platform-2.0.0.yaml`. Common issues: - `oas3-schema`: Using `nullable: true` (OpenAPI 3.0 style) instead of `type: [string, "null"]` (OpenAPI 3.1 style). - `oas-schema-check`: Fields listed in `required` that don't exist in `properties`, or invalid type values (e.g. `type: int` instead of `type: integer`). 4. Re-run vacuum to confirm no errors remain: ``` vacuum lint QuantConnect-Platform-2.0.0.yaml --fail-severity error ``` 5. Regenerate the API reference pages: ``` python code-generators/API-Reference-Code-Generator.py ```
OpenAPI Lint Errors
The
vacuumlinter found errors inQuantConnect-Platform-2.0.0.yaml.Run: https://github.com/QuantConnect/Documentation/actions/runs/24205466213
Steps to fix
curl -fsSL https://quobix.com/scripts/install_vacuum.sh | shvacuum_*_windows_x86_64.tar.gz), extract, and add to PATH.QuantConnect-Platform-2.0.0.yaml. Common issues:oas3-schema: Usingnullable: true(OpenAPI 3.0 style) instead oftype: [string, "null"](OpenAPI 3.1 style).oas-schema-check: Fields listed inrequiredthat don't exist inproperties, or invalid type values (e.g.type: intinstead oftype: integer).