Skip to content

Improved bundle documentation#27

Merged
stixx merged 1 commit into
mainfrom
docs-extension-points
May 9, 2026
Merged

Improved bundle documentation#27
stixx merged 1 commit into
mainfrom
docs-extension-points

Conversation

@stixx
Copy link
Copy Markdown
Owner

@stixx stixx commented May 9, 2026

Summary

Pre-1.0 documentation pass: name the bundle's public API surface in the README, add a single page covering each extension point with a worked example, and clarify the two validation layers up front in the validation guide.

Changes

  • README: new "Stability & supported API" section listing all 10 @api items, plus a "Two-Layer Validation" feature bullet that names both the OpenAPI schema layer and the Symfony Validator layer.
  • docs/extension-points.md (new): one example each for ValidatorInterface, ResponderInterface, StatusResolverInterface, ExceptionToApiProblemTransformerInterface, plus how to throw ApiProblemException directly. Includes an architectural note that ApiProblemException is HTTP-layer and shouldn't be thrown from handlers.
  • docs/validation.md: opening paragraph replaced with a table that disambiguates OpenAPI request validation vs Symfony Validator (what each validates, what drives it, when it runs).

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 9, 2026

Warning

Rate limit exceeded

@stixx has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 20 minutes and 20 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 7a8ce748-572d-4b27-914e-fc5203134870

📥 Commits

Reviewing files that changed from the base of the PR and between bd15297 and 503bba3.

📒 Files selected for processing (3)
  • README.md
  • docs/extension-points.md
  • docs/validation.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-extension-points

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.

@stixx stixx merged commit 8654804 into main May 9, 2026
6 checks passed
@stixx stixx deleted the docs-extension-points branch May 9, 2026 23:34
@stixx stixx added the documentation Improvements or additions to documentation label May 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant