Skip to content

Regenerate API spec during docs build#551

Merged
shayancoin merged 1 commit intomainfrom
codex/update-build-docs.sh-for-openapi-generation
Oct 22, 2025
Merged

Regenerate API spec during docs build#551
shayancoin merged 1 commit intomainfrom
codex/update-build-docs.sh-for-openapi-generation

Conversation

@shayancoin
Copy link
Owner

@shayancoin shayancoin commented Oct 22, 2025

Summary

  • expand backend API schemas and routes to support comprehensive OpenAPI generation
  • regenerate docs/API_SPEC.md from the backend app each time build-docs.sh runs
  • clean up frontend configuration and types so the docs build and Next.js checks succeed

Testing

  • ./build-docs.sh

https://chatgpt.com/codex/tasks/task_e_68f859a299c48330b9233c6990da9e6b

Summary by CodeRabbit

Release Notes

  • New Features

    • Added payment tracking fields for orders including provider, reference, status, and transaction details.
    • Added design information fields for orders including URLs for designs and previews.
  • Improvements

    • Enhanced authentication and session management for improved security handling.
    • Improved API documentation generation for better developer reference.
    • Refined performance metrics tracking for better monitoring.

@vercel
Copy link

vercel bot commented Oct 22, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
paform Ready Ready Preview Comment Oct 22, 2025 5:42am

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 22, 2025

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

📥 Commits

Reviewing files that changed from the base of the PR and between bdda657 and fdb38a1.

📒 Files selected for processing (18)
  • backend/api/exports.py (1 hunks)
  • backend/api/routes_orders.py (1 hunks)
  • backend/api/schemas.py (3 hunks)
  • backend/models/order.py (1 hunks)
  • backend/scripts/generate_openapi.py (1 hunks)
  • build-docs.sh (1 hunks)
  • frontend/next.config.mjs (0 hunks)
  • frontend/src/app/configurator/quote/complete/page.tsx (3 hunks)
  • frontend/src/app/dealer/actions.ts (6 hunks)
  • frontend/src/app/kitchen-configurator/[sku]/page.tsx (2 hunks)
  • frontend/src/app/reportWebVitals.ts (2 hunks)
  • frontend/src/app/server-actions/dealerQuotes.ts (3 hunks)
  • frontend/src/app/stores/configurator-store.ts (1 hunks)
  • frontend/src/app/web-vitals.ts (7 hunks)
  • frontend/src/lib/auth.ts (3 hunks)
  • frontend/tests/e2e/perf/perf-budget-loader.ts (1 hunks)
  • frontend/tests/e2e/utils/wasm-decoder-polyfill.ts (1 hunks)
  • playwright.config.ts (2 hunks)
 _________________________________________________
< Code Wars Episode II: Attack of the Git Clones. >
 -------------------------------------------------
  \
   \   \
        \ /\
        ( )
      .( o ).
✨ Finishing touches
  • 📝 Docstrings were successfully generated.
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch codex/update-build-docs.sh-for-openapi-generation

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

@shayancoin shayancoin merged commit ad729ee into main Oct 22, 2025
5 of 13 checks passed
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 22, 2025

Note

Docstrings generation - SUCCESS
Generated docstrings for this pull request at #554

coderabbitai bot added a commit that referenced this pull request Oct 22, 2025
Docstrings generation was requested by @shayancoin.

* #551 (comment)

The following files were modified:

* `frontend/src/app/configurator/quote/complete/page.tsx`
* `frontend/src/app/dealer/actions.ts`
* `frontend/src/app/kitchen-configurator/[sku]/page.tsx`
* `frontend/src/app/server-actions/dealerQuotes.ts`
* `frontend/src/app/web-vitals.ts`
* `frontend/src/lib/auth.ts`
* `frontend/tests/e2e/perf/perf-budget-loader.ts`
* `frontend/tests/e2e/utils/wasm-decoder-polyfill.ts`
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines 26 to +27
from backend.services.storage import StorageClient, StoredObject
from services.cnc_service import CNCService
from backend.services.cnc_service import CNCService

Choose a reason for hiding this comment

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

P0 Badge Fix CNC service import path

The new import from backend.services.cnc_service import CNCService assumes the project root is on PYTHONPATH so backend is a package. The backend Dockerfile (and most local runs) execute uvicorn api.main:app with the working directory set to backend/, where only modules like api and services are importable. Under that setup the process raises ModuleNotFoundError: No module named 'backend' at startup, preventing any API routes—including the docs OpenAPI generation—from loading. The previous relative import from services.cnc_service import CNCService worked regardless of working directory. Revert to a relative import or adjust the runtime path so the server can start.

Useful? React with 👍 / 👎.

shayancoin pushed a commit that referenced this pull request Oct 22, 2025
…n` (#554)

Docstrings generation was requested by @shayancoin.

* #551 (comment)

The following files were modified:

* `frontend/src/app/configurator/quote/complete/page.tsx`
* `frontend/src/app/dealer/actions.ts`
* `frontend/src/app/kitchen-configurator/[sku]/page.tsx`
* `frontend/src/app/server-actions/dealerQuotes.ts`
* `frontend/src/app/web-vitals.ts`
* `frontend/src/lib/auth.ts`
* `frontend/tests/e2e/perf/perf-budget-loader.ts`
* `frontend/tests/e2e/utils/wasm-decoder-polyfill.ts`

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant