LCORE-1494: Disable openapi.md generation#1343
Merged
tisnik merged 1 commit intolightspeed-core:mainfrom Mar 18, 2026
Merged
Conversation
Contributor
WalkthroughThe Makefile's OpenAPI documentation generation target has been modified to write formatted output to a different file path. The build step continues to remove the intermediate output.md file, with a comment now documenting the rationale for this adjustment. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
Makefile (1)
60-61: Consider cleanup foropenapi2.md.The new output file
openapi2.mdis generated in the repository root but is not cleaned up (unlikeoutput.md). If this file should not be committed, consider:
- Adding
openapi2.mdto.gitignore, or- Removing it after generation if it's only a temporary artifact
If
openapi2.mdis intentionally kept for some purpose, this can be disregarded.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@Makefile` around lines 60 - 61, The Makefile target currently leaves a temporary file openapi2.md in the repo root after running "python3 scripts/fix_openapi_doc.py < output.md > openapi2.md"; either add openapi2.md to .gitignore if you intend to keep it, or modify the Makefile rule that produces openapi2.md to remove it after generation (e.g., append an rm openapi2.md step) so it isn't left committed; update the Makefile target that contains the "python3 scripts/fix_openapi_doc.py < output.md > openapi2.md" line accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@Makefile`:
- Around line 59-60: The Makefile comment and command reference the wrong file:
update the command "python3 scripts/fix_openapi_doc.py < output.md >
openapi2.md" and its preceding comment so it uses and preserves docs/openapi.md
(not docs/output.md), e.g. read from docs/openapi.md or change the comment to
refer to output.md consistently; ensure the intermediate output.md is not being
removed later (or switch the input to docs/openapi.md) so the intended
docs/openapi.md is preserved and the produced openapi2.md remains consistent
with the PR goal.
---
Nitpick comments:
In `@Makefile`:
- Around line 60-61: The Makefile target currently leaves a temporary file
openapi2.md in the repo root after running "python3 scripts/fix_openapi_doc.py <
output.md > openapi2.md"; either add openapi2.md to .gitignore if you intend to
keep it, or modify the Makefile rule that produces openapi2.md to remove it
after generation (e.g., append an rm openapi2.md step) so it isn't left
committed; update the Makefile target that contains the "python3
scripts/fix_openapi_doc.py < output.md > openapi2.md" line accordingly.
Comment on lines
+59
to
+60
| # LCORE-1494: don't overwrite the original docs/output.md for now | ||
| python3 scripts/fix_openapi_doc.py < output.md > openapi2.md |
Contributor
There was a problem hiding this comment.
Comment references incorrect filename.
The comment mentions docs/output.md, but based on the PR objective ("Disable openapi.md generation") and context, the file being preserved is docs/openapi.md. The intermediate output.md file is still being removed on line 61.
Proposed fix
- # LCORE-1494: don't overwrite the original docs/output.md for now
+ # LCORE-1494: don't overwrite the original docs/openapi.md for now🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@Makefile` around lines 59 - 60, The Makefile comment and command reference
the wrong file: update the command "python3 scripts/fix_openapi_doc.py <
output.md > openapi2.md" and its preceding comment so it uses and preserves
docs/openapi.md (not docs/output.md), e.g. read from docs/openapi.md or change
the comment to refer to output.md consistently; ensure the intermediate
output.md is not being removed later (or switch the input to docs/openapi.md) so
the intended docs/openapi.md is preserved and the produced openapi2.md remains
consistent with the PR goal.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
LCORE-1494: Disable
openapi.mdgenerationType of change
Tools used to create PR
Related Tickets & Documents
Summary by CodeRabbit