Skip to content

Conversation

@tisnik
Copy link
Contributor

@tisnik tisnik commented Dec 9, 2025

Description

LCORE-1105: Fixed OpenAPI schema target

Type of change

  • Refactor
  • New feature
  • Bug fix
  • CVE fix
  • Optimization
  • Documentation Update
  • Configuration Update
  • Bump-up service version
  • Bump-up dependent library
  • Bump-up library or tool used for development (does not change the final image)
  • CI configuration change
  • Konflux configuration change
  • Unit tests improvement
  • Integration tests improvement
  • End to end tests improvement

Tools used to create PR

Identify any AI code assistants used in this PR (for transparency and review context)

  • Assisted-by: N/A
  • Generated by: N/A

Related Tickets & Documents

  • Related Issue #LCORE-1105

Summary by CodeRabbit

  • Chores
    • Consolidated OpenAPI documentation build process by removing redundant steps and updating the documentation output location.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 9, 2025

Walkthrough

The PR consolidates the Makefile's OpenAPI documentation generation by removing the duplicate openapi-doc target that output to docs/output.md and updating the remaining target to output to docs/openapi.md instead.

Changes

Cohort / File(s) Change Summary
Makefile consolidation
Makefile
Updated OpenAPI documentation post-processing output path from docs/output.md to docs/openapi.md; removed duplicate openapi-doc target block

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly references the specific fix related to the OpenAPI schema target, which aligns with the changeset's consolidation and correction of OpenAPI documentation paths.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
Makefile (1)

46-46: Use uv run python instead of python3 for consistency.

Throughout the Makefile, Python invocations use uv run python (e.g., lines 12, 42). Line 46 breaks this pattern by calling python3 directly. This could cause issues in environments where python3 is not in the PATH or differs from the uv-managed Python version.

Apply this diff to align with the established pattern:

-	python3 scripts/fix_openapi_doc.py <  output.md > docs/openapi.md
+	uv run python scripts/fix_openapi_doc.py <  output.md > docs/openapi.md
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e897ab0 and 30be9e0.

📒 Files selected for processing (1)
  • Makefile (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
  • GitHub Check: build-pr
  • GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-on-pull-request
  • GitHub Check: E2E: library mode / ci
  • GitHub Check: E2E: library mode / azure
  • GitHub Check: E2E: server mode / ci
  • GitHub Check: E2E: server mode / azure
🔇 Additional comments (1)
Makefile (1)

44-47: OpenAPI documentation consolidation is correct.

The fix properly consolidates the OpenAPI documentation workflow by:

  • Removing the duplicate target that wrote to docs/output.md
  • Unifying to a single target that outputs to the semantically appropriate docs/openapi.md
  • Maintaining correct dependencies and cleanup logic

The output filename aligns well with the schema target's docs/openapi.json output.

@tisnik tisnik merged commit 668d09c into lightspeed-core:main Dec 9, 2025
21 of 25 checks passed
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.

1 participant