Skip to content

CONV-326: Add API documentation page#287

Merged
menvil merged 1 commit into
developfrom
feature/CONV-326-add-api-documentation-page
Jun 3, 2026
Merged

CONV-326: Add API documentation page#287
menvil merged 1 commit into
developfrom
feature/CONV-326-add-api-documentation-page

Conversation

@menvil

@menvil menvil commented Jun 3, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds public /docs/api route that renders Redoc UI (no auth required)
  • Adds /docs/api/openapi.yaml route to serve the spec file
  • Creates resources/views/docs/api.blade.php with Redoc via CDN
  • Adds tests/Feature/Docs/ApiDocumentationPageTest.php

Test plan

  • Test written first — 404 before route/view added
  • composer test passes (615 tests)
  • npm run build passes

🤖 Generated with Claude Code


Summary by cubic

Adds a public API docs page at /docs/api using Redoc, and serves the OpenAPI spec at /docs/api/openapi.yaml. Makes the API docs accessible without auth and meets CONV-326 requirements.

  • New Features
    • Public /docs/api route renders Redoc UI from resources/views/docs/api.blade.php.
    • /docs/api/openapi.yaml route serves the spec with application/yaml content type.
    • Feature test verifies the page renders and shows “File Converter API”.

Written for commit eeabf18. Summary will update on new commits.

Review in cubic

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@menvil menvil merged commit 5c31f26 into develop Jun 3, 2026
1 check was pending
@coderabbitai

coderabbitai Bot commented Jun 3, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are limited based on label configuration.

🏷️ Required labels (at least one) (1)
  • release

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 1f0cada4-bbf9-4c00-90ae-16162eb5be05

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/CONV-326-add-api-documentation-page

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.

@menvil menvil deleted the feature/CONV-326-add-api-documentation-page branch June 3, 2026 17:57
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