docs(event_handler): improve routing rules syntax documentation #7094
Conversation
Addresses issue aws-powertools#2962 by adding detailed documentation for: - Dynamic path parameter syntax (<parameter_name>) - Supported characters in path parameters - Regex pattern conversion process - Advanced routing examples with complex parameters - Catch-all routes with regex patterns - Route matching priority and behavior The new documentation provides clear explanations of how routing rules work, the regex syntax supported, and examples of complex routing patterns that were previously undocumented.
|
Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need. |
boring-cyborg
bot
added
the
documentation
pull-request-size
bot
added
the
size/L
leandrodamascena
requested review from
leandrodamascena
and removed request for
anafalcao
leandrodamascena
changed the title
There was a problem hiding this comment.
Hey @dap0am thanks a lot for working in this PR! I left some comments before we move to the next round of review.
Please let me know if you have any question.
Thanks for the comment @leandrodamascena , will work on them as soon as possible. |
- Remove redundant routing rules syntax introduction section - Update header levels from h5 to h4 for better hierarchy - Move inline code examples to separate files in examples/event_handler_rest/src - Add proper Lambda handlers with Logger and Tracer utilities - Reorganize content by moving regex pattern table to Dynamic Path Parameters section - Update tip formatting to match project style - Simplify inline comments to follow project conventions
|
Hi @leandrodamascena all comments has been actioned, please review and let me know if there is anything that I missed. Thank you. |
|
There was a problem hiding this comment.
Hi @dap0am, thank you so much for working on this PR! I just made a few minor final changes to follow some documentation guidelines we have, but nothing you missed!
It was great working with you on this PR! I'm opening more issues that might be interesting to work on. I hope to see you again here.
APPROVED!
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #7094 +/- ##
========================================
Coverage 96.35% 96.35%
========================================
Files 275 275
Lines 12980 12980
Branches 965 965
========================================
Hits 12507 12507
Misses 366 366
Partials 107 107 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience! |
No worries @leandrodamascena , will keep an eye on the issues to see if I fancy anyone. |
Issue number: #2962
Fixes #2962
Summary
This PR addresses issue #2962 by adding comprehensive documentation for routing rules syntax in the Event Handler.
Changes
Added detailed "Routing Rules Syntax" section explaining:
<parameter_name>)-._~()'\\!*:@,;=+&$%<> \[]{}|^)Enhanced "Catch-all routes" section with:
User experience
Before: Developers had no documentation about routing rules syntax, leading to confusion about:
<parameter>syntax worksAfter: Developers now have comprehensive documentation with:
Checklist
If your change doesn't seem to apply, please leave them unchecked.
Is this a breaking change?
RFC issue number: N/A
This is a documentation-only change with no breaking changes.
Checklist:
Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.