Skip to content

Conversation

dreamorosi
Copy link
Contributor

@dreamorosi dreamorosi commented Sep 24, 2025

Summary

Changes

Please provide a summary of what's being changed

This PR brings general updates to the doc page for Event Handler HTTP, namely:

  • Update relevant code snippets to match new middleware signature
  • Update relevant code snippets to match new route handler signature
  • Update relevant code snippets to match new error handler return type
  • Update "Route Prefixes" section to reflect that the feature is now available
  • Add a callout about always awaiting the next() call in custom middleware functions
  • Add a callout about throwing errors anywhere
  • Line highlighting mismatches in code snippets

Please add the issue number below, if no issue is present the PR might get blocked and not be reviewed

Issue number: closes #4541


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.

@dreamorosi dreamorosi self-assigned this Sep 24, 2025
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Sep 24, 2025
@pull-request-size pull-request-size bot added the size/L PRs between 100-499 LOC label Sep 24, 2025
@dreamorosi dreamorosi marked this pull request as ready for review September 24, 2025 08:09
@sdangol
Copy link
Contributor

sdangol commented Sep 24, 2025

On the Middleware section, we have the params as the argument there as well. Same on the mermaid diagrams

@sdangol
Copy link
Contributor

sdangol commented Sep 24, 2025

Missed a .request in here as well

@dreamorosi
Copy link
Contributor Author

Good spots, I fixed both issues and also update the mermaid diagrams to use await next() instead of next().

Copy link

@dreamorosi dreamorosi merged commit 72cf1cd into main Sep 24, 2025
37 checks passed
@dreamorosi dreamorosi deleted the docs/update_apis branch September 24, 2025 08:52
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 size/L PRs between 100-499 LOC

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: update Event Handler docs with new APIs and types

2 participants