From 06586fa07c80dcbb84cde95845dd4c868566b335 Mon Sep 17 00:00:00 2001 From: KZ06891 Date: Tue, 12 Jun 2018 16:33:16 -0500 Subject: [PATCH] fixes link to swagger-ui params --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 69a9c9d..12558df 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,11 @@ npm install hapi-swaggered-ui@next * `path`: string, optional path where the docs should be located at (e.g. '/docs', defaults to: null) * `basePath`: string, optional url base path (e.g. used to fix reverse proxy routes) * `swaggerEndpoint`: Override the auto-detection of [hapi-swaggered](https://github.com/z0mt3c/hapi-swaggered) with a specific URL. (not recommended in use with hapi-swaggered; optional) -* `swaggerOptions`: object (according to [swagger-ui](https://github.com/swagger-api/swagger-ui#parameters)) +* `swaggerOptions`: object (according to [swagger-ui](https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#parameters)) * `operationsSorter`: Apply a sort to the operation list of each API. It can be 'alpha' (sort by paths alphanumerically), 'method' (sort by HTTP method), null (server side sorting) or a custom function (see link above). * `docExpansion`: Controls how the API listing is displayed. It can be set to 'none' (default), 'list' (shows operations for each resource), or 'full' (fully expanded: shows operations and their details). * `validatorUrl`: By default, Swagger-UI attempts to validate specs against swagger.io's online validator (disabled for localhost). You can use this parameter to set a different validator URL, for example for locally deployed validators (Validator Badge). Setting it to false will disable validation. This parameter is relevant for Swagger 2.0 specs only. - * In addition the following options are supported: `oauth2RedirectUrl`, `configUrl`, `displayOperationId`, `displayRequestDuration`, `filter`, `deepLinking`, `maxDisplayedTags`, `tagsSorter`, `parameterMacro`, `modelPropertyMacro` - have a look at [swagger-ui](https://github.com/swagger-api/swagger-ui#parameters) + * In addition the following options are supported: `oauth2RedirectUrl`, `configUrl`, `displayOperationId`, `displayRequestDuration`, `filter`, `deepLinking`, `maxDisplayedTags`, `tagsSorter`, `parameterMacro`, `modelPropertyMacro` - have a look at [swagger-ui](https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md#parameters) * `authorization`: object - can be null or false to disable authorization through swagger-ui (e.g. in case of public apis without auth) * `scope`: string, 'query' or 'header' * `field`: string, name of the field