Skip to content

LCORE-1494: Disable openapi.md generation #1343

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.

Sign up for GitHub

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

Merged
tisnik merged 1 commit into from
Mar 18, 2026
Merged

LCORE-1494: Disable openapi.md generation #1343

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ schema: ## Generate OpenAPI schema file

openapi-doc: docs/openapi.json scripts/fix_openapi_doc.py ## Generate OpenAPI documentation
openapi-to-markdown --input_file docs/openapi.json --output_file output.md
python3 scripts/fix_openapi_doc.py < output.md > docs/openapi.md
# LCORE-1494: don't overwrite the original docs/output.md for now
python3 scripts/fix_openapi_doc.py < output.md > openapi2.md
Comment on lines +59 to +60

@coderabbitai coderabbitai Bot Mar 18, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

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.

rm output.md

generate-documentation: ## Generate documentation
Expand Down
Loading