diff --git a/docs/guide/migration.mdx b/docs/guide/migration.mdx new file mode 100644 index 0000000..c5443dc --- /dev/null +++ b/docs/guide/migration.mdx @@ -0,0 +1,38 @@ +--- +id: migration +title: Migration Guide +--- + +Here are some updates that require special consideration regarding frourio and frourio-express. + +For changes not listed here, please refer to the [Changelog](/changelog). + +## v0.31.0 - Consolidate into `defineController()` {#v0.31.0-define-controller} + +

+ frourio + frourio-express +

+ +`defineHooks()` and `defineResponseSchema()` at controller-level are now deprecated. +Please refer to the [Routing page](/docs/reference/routing) to consolidate them into `defineController()`. + +:::note + +To avoid confusion, the old "controller" has renamed to "handler". + +::: + +## v0.31.0 - Support Fastify v4 {#v0.31.0-support-fastify-v4} + +

+ frourio + frourio-express +

+ +Fastify v4 is now supported at `frourio@0.31.0`. +Later versions of `frourio` require `fastify@4`. + +`frourio-express` is not affected by this change. + +See also: [Fastify V4 Migration Guide - Fastify](https://www.fastify.io/docs/latest/Guides/Migration-Guide-V4/) diff --git a/sidebars.js b/sidebars.js index 67550b4..5c8fd1b 100644 --- a/sidebars.js +++ b/sidebars.js @@ -32,6 +32,7 @@ module.exports = { collapsed: false, link: { type: 'doc', id: 'guide/index' }, items: [ + 'guide/migration', 'guide/entrypoint', 'guide/authentication', 'guide/cors-helmet',