10.0.0 Release Notes

[robmcguinness]

Summary

Breaking Changes

• swagger-ui upgraded to 3.x. Please see their release notes for breaking changes.
• hapi-swagger no longer includes json editor option. This feature was removed due to the ui upgrade to swagger-ui@3.x that does not support a json editor. @see "Try it out" doesn't prompt with form when parameters are a schema swagger-api/swagger-ui#2771 or more details.
• lang ui option removed since swagger-ui@3.x does not support languages. @see [improvement] Translation: automatic and manual language selection swagger-api/swagger-ui#2488 for more details.
• sortTags option valid value is now alpha.
• sortEndpoints options valid values are now alpha, method, ordered
• ...

Known Issues

• Examples are not displaying on UI for Joi any.example() is broken in `swagger-ui@3.x. The feature seems be close to getting resolved. @see Examples are not showing swagger-api/swagger-ui#2651 for more details.

Features

• any.meta({swaggerLabel: '<value>'}) can now be used to label alternative schemas like any.alternatives() or any.when(). joi >14.x forwards labels alternatives to underlying schemas in order to fix Need to override twice the key name for error messages hapijs/joi#1364 . This fix broke functionality in hapi-swagger that allowed labels to be appropriately applied to refs for alternatives. any.labels() still works for alternatives in joi <14.x.
• templates option added which allows the directory path to be changed that is used by hapi-swagger and @hapi/vision to resolve and load the templates to render swagger-ui interface. The directory must contain index.html and debug.html templates. Default is templates directory in this package.
• Typescript support typescript definition support #588, Closes Typings #510
• ...

Updated dependencies

• All hapi packages updated to use scoped version @hapi
• hapi-swagger-ui upgraded to v3.x
• Joi upgraded from v13.x to v15.x
• handlebars upgraded to v4.x
• swagger-ui upgraded to 3.x
• ...

[robmcguinness]

hapi-swagger v10.0.0-alpha.0 has been released for preview:

npm i hapi-swagger@next -S

[robmcguinness]

hapi-swagger v10.0.0-alpha.1 has been released for preview:

npm i hapi-swagger@next -S

fixed: templates not published

[robmcguinness]

hapi-swagger v10.0.0-alpha.2 has been released for preview:

npm i hapi-swagger@next -S

fixed: swagger-ui-dist files must be served relative to confine setting for inert

[robmcguinness]

hapi-swagger v10.0.0-alpha.3 has been released for preview:

npm i hapi-swagger@next

fixed: docExpansion, apiSorter, operationsSorter are working again
fixed: add back support for auth bearer token strategy in swagger-ui

[robmcguinness]

hapi-swagger v10.0.0-alpha.4 has been released for preview:

npm i hapi-swagger@next

fixed: missing accessToken in default template

[robmcguinness]

hapi-swagger v10.0.0-alpha.5 has been released for preview:

npm i hapi-swagger@next

feature: added templates option

[robmcguinness]

Closed with release of v10.0.0