Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Migration-Guide-V4.md #4091

Merged
merged 5 commits into from Jun 28, 2022
Merged

Update Migration-Guide-V4.md #4091

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
82e34ba
Update Migration-Guide-V4.md
denes-fekeshazy Jun 27, 2022
18b3e11
Update docs/Guides/Migration-Guide-V4.md
denes-fekeshazy Jun 28, 2022
b806051
Update Migration-Guide-V4.md
denes-fekeshazy Jun 28, 2022
c4829fc
Update Migration-Guide-V4.md
denes-fekeshazy Jun 28, 2022
af104de
Fix doc linting
denes-fekeshazy Jun 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/Guides/Migration-Guide-V4.md
View file
Open in desktop
Expand Up @@ -65,6 +65,14 @@ Starting from v4, all the `GET` routes will create a sibling `HEAD` route.
You can revert this behaviour by setting the server's option `exposeHeadRoutes`
to `false`.

### Synchronous route definitions

The route registration has been made syncrounes from v4. This change was done to provide
denes-fekeshazy marked this conversation as resolved.
Show resolved Hide resolved
better error reporting for route definition. As a result if you specify an `onRoute` hook
in a plugin you should either:
* wrap your routes in a plugin (recommended)
* use `await register(...)`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add the code example to let the user understand better the implications:
any onRoute hooks will not be executed when a plugin adds them if it is not awaited or the routes are wrapped in a plugin

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added the code example used in the linked issue before and after refactoring. Could you have a look please if that was what you had in mind?


## Non Breaking Changes

### Change of schema for multiple types
Expand Down