Skip to content

CONV-328: Add API examples and curl snippets#289

Merged
menvil merged 1 commit into
developfrom
feature/CONV-328-add-api-examples-and-curl-snippets
Jun 3, 2026
Merged

CONV-328: Add API examples and curl snippets#289
menvil merged 1 commit into
developfrom
feature/CONV-328-add-api-examples-and-curl-snippets

Conversation

@menvil

@menvil menvil commented Jun 3, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds 6 executable curl examples covering the full happy path
  • Examples use /api/v1, Authorization: Bearer, and no real secrets
  • Covers: upload, list targets, estimate, create, poll, download

Test plan

  • Test written first — fails before examples added
  • composer test passes (617 tests)

🤖 Generated with Claude Code


Summary by cubic

Fulfills CONV-328 by adding six runnable curl examples to the API docs that show the end-to-end v1 conversion flow: upload, list targets, estimate, create, poll, and download. Uses /api/v1 and Authorization: Bearer, and adds a feature test to ensure the snippets render on /docs/api.

Written for commit 072657a. Summary will update on new commits.

Review in cubic

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@menvil menvil merged commit d9ba6da into develop Jun 3, 2026
@menvil menvil deleted the feature/CONV-328-add-api-examples-and-curl-snippets branch June 3, 2026 17:59
@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: 48f23640-9882-4b92-9340-efc622635ff6

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-328-add-api-examples-and-curl-snippets

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.

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