Skip to content

docs: add ResponseEntity and positional param injection documentation#110

Merged
usernane merged 1 commit intomainfrom
dev
May 5, 2026
Merged

docs: add ResponseEntity and positional param injection documentation#110
usernane merged 1 commit intomainfrom
dev

Conversation

@usernane
Copy link
Copy Markdown
Member

@usernane usernane commented May 5, 2026

Summary

Add documentation for the new ResponseEntity class and positional parameter injection feature.

Motivation

The features from #106 and #107 were merged but lacked user-facing documentation and examples.

Changes

  • Added "Positional Parameter Injection" subsection to README explaining how #[RequestParam] attributes map to method parameters by position
  • Added "Dynamic Status Codes with ResponseEntity" section to README with usage examples and factory method table
  • Updated README table of contents
  • Created examples/03-annotations/01-rest-controller/ with a complete TaskService example demonstrating both features

How to Test / Verify

Documentation only — no code changes to library source.

Breaking Changes and Migration Steps

None.

Checklist

  • I reviewed my own diff before requesting review
  • My commits follow Conventional Commits
  • The title of the pull request follows Conventional Commits
  • I added/updated tests (or explained why not)
  • I updated docs (if needed)
  • I ran lint/cs-fixer (if applicable)
  • I considered backward compatibility
  • I considered security

Related issues

Related to #106, #107

- Add 'Dynamic Status Codes with ResponseEntity' section to README
- Add 'Positional Parameter Injection' section to README
- Update table of contents in README
- Create annotations example (03-annotations/01-rest-controller) with
  TaskService demonstrating ResponseEntity and hyphenated params
@usernane usernane merged commit fa077cd into main May 5, 2026
6 checks passed
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented May 5, 2026

@codecov
Copy link
Copy Markdown

codecov Bot commented May 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.34%. Comparing base (09162ce) to head (b9ce95e).
⚠️ Report is 7 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##               main     #110   +/-   ##
=========================================
  Coverage     92.34%   92.34%           
  Complexity     1302     1302           
=========================================
  Files            39       39           
  Lines          3147     3147           
=========================================
  Hits           2906     2906           
  Misses          241      241           
Flag Coverage Δ
php-8.1 92.11% <ø> (ø)
php-8.2 92.18% <ø> (ø)
php-8.3 92.18% <ø> (ø)
php-8.4 92.18% <ø> (ø)
php-8.5 92.18% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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