`openapi spec lint --fix` drops node-level fixes and can duplicate paths
Maintainers usually reply within 1 day
A pull request for this has already been merged.
- #281 by @RaphaelFakhri — merged
Assessment
- Difficulty
- 4/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
Research direction
Start with fix.Engine and the CLI path that writes openapi spec lint --fix output through marshaller.Marshal; compare that sync step with the direct yaml.Marshal used in openapi/linter/rules integration tests. Trace how ApplyNode changes are reconciled with the model, especially renamed path keys. Done means the reproduced fixes survive writing without duplicate paths; linked pull request #281 is already open.
Written by the indexing model from the issue text.
Description
openapi spec lint --fix reports fixes as applied, but fixes that edit the YAML node tree directly (the validation.NodeFix implementations) are lost when the document is written. Fixes affected include owasp-security-hosts-https-oas3, style-oas3-host-trailing-slash, style-path-trailing-slash, and semantic-duplicated-enum.
For style-path-trailing-slash, the output contains both the fixed path and the original path, so the written document has a duplicated operation.
Steps to reproduce
-
Save this document as
spec.yaml:openapi: 3.1.0 info: title: Test version: 1.0.0 servers: - url: http://api.example.com/ paths: /pets/: get: responses: "200": description: ok components: schemas: E: type: string enum: [a, b, a] -
Run
openapi spec lint --fix spec.yaml.
Expected result
The written file has url: https://api.example.com, a single /pets path, and enum: [a, b].
Actual result
The command prints Applied 8 fix(es), including the HTTPS upgrade, both trailing-slash fixes, and the duplicate enum fix. The written file still has url: http://api.example.com/ and enum: [a, b, a], and contains both /pets and /pets/. Fixes that edit the model, such as the added error responses, are kept and appear under both paths.
Cause
fix.Engine calls ApplyNode on the document root node. The CLI then writes the document with marshaller.Marshal, which syncs the high-level model back over the nodes. The model still holds the original values, so value edits are reverted, and the original path key is added back next to the renamed key node.
The fix integration tests in openapi/linter/rules encode the root node with yaml.Marshal directly, so they do not run the sync step that the CLI uses.
- Dominant language
- Go
- Stars
- 276
- Forks
- 21
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 23
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
schema-drift
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
stefanhoth/paperless-ngx-cli#61 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
slavakurilyak/awesome-ai-agents#888 ·
Maintainers usually reply within 1 day
-
enhancement nav-pilot
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
kind/enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
Maintainers usually reply within 1 day