@loopback/docs 5.1.1 → 5.1.2

package/site/apidocs/rest.resthttperrors.validationerrordetails.md

@@ -23,11 +23,11 @@ interface ValidationErrorDetails
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [code](./rest.resthttperrors.validationerrordetails.code.md) | string | A single word code represents the error's type. |
-|  [info](./rest.resthttperrors.validationerrordetails.info.md) | object | Some additional details that the 3 attributes above don't cover. |
-|  [message](./rest.resthttperrors.validationerrordetails.message.md) | string | A human readable description of the error. |
-|  [path](./rest.resthttperrors.validationerrordetails.path.md) | string | A path to the invalid field. |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [code](./rest.resthttperrors.validationerrordetails.code.md) |  | string | A single word code represents the error's type. |
+|  [info](./rest.resthttperrors.validationerrordetails.info.md) |  | object | Some additional details that the 3 attributes above don't cover. |
+|  [message](./rest.resthttperrors.validationerrordetails.message.md) |  | string | A human readable description of the error. |
+|  [path](./rest.resthttperrors.validationerrordetails.path.md) |  | string | A path to the invalid field. |
 
 

package/site/apidocs/rest.restserver.md

@@ -54,38 +54,38 @@ const server = await app.get('servers.foo');
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [\_expressApp?](./rest.restserver._expressapp.md) |  | express.Application | <i>(Optional)</i> |
-|  [\_httpHandler](./rest.restserver._httphandler.md) |  | [HttpHandler](./rest.httphandler.md) |  |
-|  [\_httpServer](./rest.restserver._httpserver.md) |  | [HttpServer](./http-server.httpserver.md) \| undefined |  |
-|  [\_requestHandler](./rest.restserver._requesthandler.md) |  | [HttpRequestListener](./rest.httprequestlistener.md) |  |
-|  [config](./rest.restserver.config.md) |  | [RestServerResolvedConfig](./rest.restserverresolvedconfig.md) |  |
-|  [httpHandler](./rest.restserver.httphandler.md) |  | [HttpHandler](./rest.httphandler.md) |  |
-|  [httpServer](./rest.restserver.httpserver.md) |  | [HttpServer](./http-server.httpserver.md) \| undefined |  |
-|  [listening](./rest.restserver.listening.md) |  | boolean |  |
-|  [OASEnhancer](./rest.restserver.oasenhancer.md) |  | [OASEnhancerService](./openapi-v3.oasenhancerservice.md) |  |
-|  [oasEnhancerService](./rest.restserver.oasenhancerservice.md) |  | [OASEnhancerService](./openapi-v3.oasenhancerservice.md) | Handle incoming HTTP(S) request by invoking the corresponding Controller method via the configured Sequence. |
-|  [requestHandler](./rest.restserver.requesthandler.md) |  | [HttpRequestListener](./rest.httprequestlistener.md) |  |
-|  [rootUrl](./rest.restserver.rooturl.md) |  | string \| undefined | The root url for the server without the basePath. For example, the value will be 'http://localhost:3000' regardless of the <code>basePath</code>. |
-|  [url](./rest.restserver.url.md) |  | string \| undefined | The base url for the server, including the basePath if set. For example, the value will be 'http://localhost:3000/api' if <code>basePath</code> is set to '/api'. |
+|  [\_expressApp?](./rest.restserver._expressapp.md) | <code>protected</code> | express.Application | <i>(Optional)</i> |
+|  [\_httpHandler](./rest.restserver._httphandler.md) | <code>protected</code> | [HttpHandler](./rest.httphandler.md) |  |
+|  [\_httpServer](./rest.restserver._httpserver.md) | <code>protected</code> | [HttpServer](./http-server.httpserver.md) \| undefined |  |
+|  [\_requestHandler](./rest.restserver._requesthandler.md) | <code>protected</code> | [HttpRequestListener](./rest.httprequestlistener.md) |  |
+|  [config](./rest.restserver.config.md) | <code>readonly</code> | [RestServerResolvedConfig](./rest.restserverresolvedconfig.md) |  |
+|  [httpHandler](./rest.restserver.httphandler.md) | <p><code>protected</code></p><p><code>readonly</code></p> | [HttpHandler](./rest.httphandler.md) |  |
+|  [httpServer](./rest.restserver.httpserver.md) | <code>readonly</code> | [HttpServer](./http-server.httpserver.md) \| undefined |  |
+|  [listening](./rest.restserver.listening.md) | <code>readonly</code> | boolean |  |
+|  [OASEnhancer](./rest.restserver.oasenhancer.md) | <code>readonly</code> | [OASEnhancerService](./openapi-v3.oasenhancerservice.md) |  |
+|  [oasEnhancerService](./rest.restserver.oasenhancerservice.md) | <code>protected</code> | [OASEnhancerService](./openapi-v3.oasenhancerservice.md) | Handle incoming HTTP(S) request by invoking the corresponding Controller method via the configured Sequence. |
+|  [requestHandler](./rest.restserver.requesthandler.md) | <code>readonly</code> | [HttpRequestListener](./rest.httprequestlistener.md) |  |
+|  [rootUrl](./rest.restserver.rooturl.md) | <code>readonly</code> | string \| undefined | The root url for the server without the basePath. For example, the value will be 'http://localhost:3000' regardless of the <code>basePath</code>. |
+|  [url](./rest.restserver.url.md) | <code>readonly</code> | string \| undefined | The base url for the server, including the basePath if set. For example, the value will be 'http://localhost:3000/api' if <code>basePath</code> is set to '/api'. |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [\_applyExpressSettings()](./rest.restserver._applyexpresssettings.md) |  | Apply express settings. |
-|  [\_handleHttpRequest(request, response)](./rest.restserver._handlehttprequest.md) |  |  |
-|  [\_setupHandlerIfNeeded()](./rest.restserver._setuphandlerifneeded.md) |  |  |
-|  [\_setupOASEnhancerIfNeeded()](./rest.restserver._setupoasenhancerifneeded.md) |  |  |
-|  [\_setupOpenApiSpecEndpoints()](./rest.restserver._setupopenapispecendpoints.md) |  | Mount /openapi.json, /openapi.yaml for specs and /swagger-ui, /explorer to redirect to externally hosted API explorer |
-|  [\_setupRequestHandlerIfNeeded()](./rest.restserver._setuprequesthandlerifneeded.md) |  |  |
-|  [\_unexpectedErrorHandler()](./rest.restserver._unexpectederrorhandler.md) |  | Get an Express handler for unexpected errors |
+|  [\_applyExpressSettings()](./rest.restserver._applyexpresssettings.md) | <code>protected</code> | Apply express settings. |
+|  [\_handleHttpRequest(request, response)](./rest.restserver._handlehttprequest.md) | <code>protected</code> |  |
+|  [\_setupHandlerIfNeeded()](./rest.restserver._setuphandlerifneeded.md) | <code>protected</code> |  |
+|  [\_setupOASEnhancerIfNeeded()](./rest.restserver._setupoasenhancerifneeded.md) | <code>protected</code> |  |
+|  [\_setupOpenApiSpecEndpoints()](./rest.restserver._setupopenapispecendpoints.md) | <code>protected</code> | Mount /openapi.json, /openapi.yaml for specs and /swagger-ui, /explorer to redirect to externally hosted API explorer |
+|  [\_setupRequestHandlerIfNeeded()](./rest.restserver._setuprequesthandlerifneeded.md) | <code>protected</code> |  |
+|  [\_unexpectedErrorHandler()](./rest.restserver._unexpectederrorhandler.md) | <code>protected</code> | Get an Express handler for unexpected errors |
 |  [addOpenApiSpecEndpoint(path, form, router)](./rest.restserver.addopenapispecendpoint.md) |  | Add a new non-controller endpoint hosting a form of the OpenAPI spec. |
-|  [api(spec)](./rest.restserver.api.md) |  | Set the OpenAPI specification that defines the REST API schema for this server. All routes, parameter definitions and return types will be defined in this way.<!-- -->Note that this will override any routes defined via decorators at the controller level (this function takes precedent). |
+|  [api(spec)](./rest.restserver.api.md) |  | <p>Set the OpenAPI specification that defines the REST API schema for this server. All routes, parameter definitions and return types will be defined in this way.</p><p>Note that this will override any routes defined via decorators at the controller level (this function takes precedent).</p> |
 |  [basePath(path)](./rest.restserver.basepath.md) |  | Configure the <code>basePath</code> for the rest server |
 |  [bodyParser(bodyParserClass, address)](./rest.restserver.bodyparser.md) |  | Bind a body parser to the server context |
 |  [controller(controllerCtor)](./rest.restserver.controller.md) |  | Register a controller class with this server. |
 |  [exportOpenApiSpec(outFile, log)](./rest.restserver.exportopenapispec.md) |  | Export the OpenAPI spec to the given json or yaml file |
-|  [getApiSpec(requestContext)](./rest.restserver.getapispec.md) |  | Get the OpenAPI specification describing the REST API provided by this application.<!-- -->This method merges operations (HTTP endpoints) from the following sources: - <code>app.api(spec)</code> - <code>app.controller(MyController)</code> - <code>app.route(route)</code> - <code>app.route('get', '/greet', operationSpec, MyController, 'greet')</code>If the optional <code>requestContext</code> is provided, then the <code>servers</code> list in the returned spec will be updated to work in that context. Specifically: 1. if <code>config.openApi.setServersFromRequest</code> is enabled, the servers list will be replaced with the context base url 2. Any <code>servers</code> entries with a path of <code>/</code> will have that path replaced with <code>requestContext.basePath</code> |
+|  [getApiSpec(requestContext)](./rest.restserver.getapispec.md) |  | <p>Get the OpenAPI specification describing the REST API provided by this application.</p><p>This method merges operations (HTTP endpoints) from the following sources: - <code>app.api(spec)</code> - <code>app.controller(MyController)</code> - <code>app.route(route)</code> - <code>app.route('get', '/greet', operationSpec, MyController, 'greet')</code></p><p>If the optional <code>requestContext</code> is provided, then the <code>servers</code> list in the returned spec will be updated to work in that context. Specifically: 1. if <code>config.openApi.setServersFromRequest</code> is enabled, the servers list will be replaced with the context base url 2. Any <code>servers</code> entries with a path of <code>/</code> will have that path replaced with <code>requestContext.basePath</code></p> |
 |  [handler(handlerFn)](./rest.restserver.handler.md) |  | Configure a custom sequence function for handling incoming requests. |
 |  [mountExpressRouter(basePath, router, spec)](./rest.restserver.mountexpressrouter.md) |  | Mount an Express router to expose additional REST endpoints handled via legacy Express-based stack. |
 |  [redirect(fromPath, toPathOrUrl, statusCode)](./rest.restserver.redirect.md) |  | Register a route redirecting callers to a different URL. |

package/site/apidocs/rest.restserverresolvedoptions.md

@@ -21,18 +21,18 @@ export interface RestServerResolvedOptions
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [apiExplorer](./rest.restserverresolvedoptions.apiexplorer.md) | [ApiExplorerOptions](./rest.apiexploreroptions.md) |  |
-|  [basePath?](./rest.restserverresolvedoptions.basepath.md) | string | <i>(Optional)</i> Base path for API/static routes |
-|  [cors](./rest.restserverresolvedoptions.cors.md) | cors.CorsOptions |  |
-|  [expressSettings](./rest.restserverresolvedoptions.expresssettings.md) | { \[name: string\]: any; } |  |
-|  [listenOnStart?](./rest.restserverresolvedoptions.listenonstart.md) | boolean | <i>(Optional)</i> Set this flag to <code>false</code> to not listen on connections when the REST server is started. It's useful to mount a LoopBack REST server as a route to the facade Express application. If not set, the value is default to <code>true</code>. |
-|  [openApiSpec](./rest.restserverresolvedoptions.openapispec.md) | [OpenApiSpecOptions](./rest.openapispecoptions.md) |  |
-|  [path?](./rest.restserverresolvedoptions.path.md) | string | <i>(Optional)</i> |
-|  [port](./rest.restserverresolvedoptions.port.md) | number |  |
-|  [requestBodyParser?](./rest.restserverresolvedoptions.requestbodyparser.md) | [RequestBodyParserOptions](./rest.requestbodyparseroptions.md) | <i>(Optional)</i> |
-|  [router](./rest.restserverresolvedoptions.router.md) | [RestRouterOptions](./rest.restrouteroptions.md) |  |
-|  [sequence?](./rest.restserverresolvedoptions.sequence.md) | [Constructor](./context.constructor.md)<!-- -->&lt;[SequenceHandler](./rest.sequencehandler.md)<!-- -->&gt; | <i>(Optional)</i> |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [apiExplorer](./rest.restserverresolvedoptions.apiexplorer.md) |  | [ApiExplorerOptions](./rest.apiexploreroptions.md) |  |
+|  [basePath?](./rest.restserverresolvedoptions.basepath.md) |  | string | <i>(Optional)</i> Base path for API/static routes |
+|  [cors](./rest.restserverresolvedoptions.cors.md) |  | cors.CorsOptions |  |
+|  [expressSettings](./rest.restserverresolvedoptions.expresssettings.md) |  | { \[name: string\]: any; } |  |
+|  [listenOnStart?](./rest.restserverresolvedoptions.listenonstart.md) |  | boolean | <i>(Optional)</i> Set this flag to <code>false</code> to not listen on connections when the REST server is started. It's useful to mount a LoopBack REST server as a route to the facade Express application. If not set, the value is default to <code>true</code>. |
+|  [openApiSpec](./rest.restserverresolvedoptions.openapispec.md) |  | [OpenApiSpecOptions](./rest.openapispecoptions.md) |  |
+|  [path?](./rest.restserverresolvedoptions.path.md) |  | string | <i>(Optional)</i> |
+|  [port](./rest.restserverresolvedoptions.port.md) |  | number |  |
+|  [requestBodyParser?](./rest.restserverresolvedoptions.requestbodyparser.md) |  | [RequestBodyParserOptions](./rest.requestbodyparseroptions.md) | <i>(Optional)</i> |
+|  [router](./rest.restserverresolvedoptions.router.md) |  | [RestRouterOptions](./rest.restrouteroptions.md) |  |
+|  [sequence?](./rest.restserverresolvedoptions.sequence.md) |  | [Constructor](./context.constructor.md)<!-- -->&lt;[SequenceHandler](./rest.sequencehandler.md)<!-- -->&gt; | <i>(Optional)</i> |
 
 

package/site/apidocs/rest.route.md

@@ -30,8 +30,8 @@ export declare class Route extends BaseRoute
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [\_handler](./rest.route._handler.md) |  | Function |  |
-|  [spec](./rest.route.spec.md) |  | OperationObject |  |
+|  [\_handler](./rest.route._handler.md) | <p><code>protected</code></p><p><code>readonly</code></p> | Function |  |
+|  [spec](./rest.route.spec.md) | <code>readonly</code> | OperationObject |  |
 
 ## Methods
 

package/site/apidocs/rest.routeentry.md

@@ -23,11 +23,11 @@ export interface RouteEntry
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [path](./rest.routeentry.path.md) | string | http path |
-|  [spec](./rest.routeentry.spec.md) | OperationObject | OpenAPI operation spec |
-|  [verb](./rest.routeentry.verb.md) | string | http verb |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [path](./rest.routeentry.path.md) | <code>readonly</code> | string | http path |
+|  [spec](./rest.routeentry.spec.md) | <code>readonly</code> | OperationObject | OpenAPI operation spec |
+|  [verb](./rest.routeentry.verb.md) | <code>readonly</code> | string | http verb |
 
 ## Methods
 

package/site/apidocs/rest.routesource.md

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.rest.routesource.html
 ```typescript
 export declare class RouteSource implements InvocationSource<RouteEntry> 
 ```
-<b>Implements:</b> [InvocationSource](./context.invocationsource.md)<!-- -->&lt;[RouteEntry](./rest.routeentry.md)
+<b>Implements:</b> [InvocationSource](./context.invocationsource.md)<!-- -->&lt;[RouteEntry](./rest.routeentry.md)<!-- -->&gt;
 
 ## Constructors
 
@@ -31,7 +31,7 @@ export declare class RouteSource implements InvocationSource<RouteEntry>
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [type](./rest.routesource.type.md) |  | string |  |
-|  [value](./rest.routesource.value.md) |  | [RouteEntry](./rest.routeentry.md) |  |
+|  [value](./rest.routesource.value.md) | <code>readonly</code> | [RouteEntry](./rest.routeentry.md) |  |
 
 ## Methods
 

package/site/apidocs/rest.sendresponsemiddlewareprovider.md

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.rest.sendresponsemiddlewareprovider.html
 ```typescript
 export declare class SendResponseMiddlewareProvider implements Provider<Middleware> 
 ```
-<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[Middleware](./express.middleware.md)
+<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[Middleware](./express.middleware.md)<!-- -->&gt;
 
 ## Methods
 

package/site/apidocs/rest.session.md

@@ -23,8 +23,8 @@ export interface Session
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [profile](./rest.session.profile.md) | [SessionUserProfile](./rest.sessionuserprofile.md) |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [profile](./rest.session.profile.md) |  | [SessionUserProfile](./rest.sessionuserprofile.md) |  |
 
 

package/site/apidocs/rest.sessionuserprofile.md

@@ -23,10 +23,10 @@ export interface SessionUserProfile
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [email](./rest.sessionuserprofile.email.md) | string |  |
-|  [provider](./rest.sessionuserprofile.provider.md) | string |  |
-|  [token](./rest.sessionuserprofile.token.md) | string |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [email](./rest.sessionuserprofile.email.md) |  | string |  |
+|  [provider](./rest.sessionuserprofile.provider.md) |  | string |  |
+|  [token](./rest.sessionuserprofile.token.md) |  | string |  |
 
 

package/site/apidocs/rest.trie.md

@@ -25,7 +25,7 @@ export declare class Trie<T>
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [root](./rest.trie.root.md) |  | [Node](./rest.node.md)<!-- -->&lt;T&gt; |  |
+|  [root](./rest.trie.root.md) | <code>readonly</code> | [Node](./rest.node.md)<!-- -->&lt;T&gt; |  |
 
 ## Methods
 

package/site/apidocs/rest.trierouter.md

@@ -32,8 +32,8 @@ export declare class TrieRouter extends BaseRouter
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [addRouteWithPathVars(route)](./rest.trierouter.addroutewithpathvars.md) |  |  |
-|  [findRouteWithPathVars(verb, path)](./rest.trierouter.findroutewithpathvars.md) |  |  |
-|  [listRoutesWithPathVars()](./rest.trierouter.listrouteswithpathvars.md) |  |  |
+|  [addRouteWithPathVars(route)](./rest.trierouter.addroutewithpathvars.md) | <code>protected</code> |  |
+|  [findRouteWithPathVars(verb, path)](./rest.trierouter.findroutewithpathvars.md) | <code>protected</code> |  |
+|  [listRoutesWithPathVars()](./rest.trierouter.listrouteswithpathvars.md) | <code>protected</code> |  |
 
 

package/site/apidocs/rest.validationoptions.md

@@ -24,13 +24,13 @@ export interface ValidationOptions extends AjvOptions
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [ajvErrors?](./rest.validationoptions.ajverrors.md) | [AjvErrorOptions](./rest.ajverroroptions.md) | <i>(Optional)</i> Enable custom error messages in JSON-Schema for AJV validator from https://github.com/epoberezkin/ajv-errors - <code>true</code>: Enable <code>ajv-errors</code> - <code>AjvErrorOptions</code>: Enable <code>ajv-errors</code> with options |
-|  [ajvErrorTransformer?](./rest.validationoptions.ajverrortransformer.md) | (errors: ErrorObject\[\]) =&gt; ErrorObject\[\] | <i>(Optional)</i> A function that transform the <code>ErrorObject</code>s reported by AJV. This could be used for error messages customization, localization, etc. |
-|  [ajvFactory?](./rest.validationoptions.ajvfactory.md) | (options: AjvOptions) =&gt; Ajv | <i>(Optional)</i> A factory to create Ajv instance |
-|  [ajvKeywords?](./rest.validationoptions.ajvkeywords.md) | string\[\] | <i>(Optional)</i> Enable additional AJV keywords from https://github.com/epoberezkin/ajv-keywords - <code>string[]</code>: Add an array of keywords from <code>ajv-keywords</code> |
-|  [compiledSchemaCache?](./rest.validationoptions.compiledschemacache.md) | [SchemaValidatorCache](./rest.schemavalidatorcache.md) | <i>(Optional)</i> Custom cache for compiled schemas by AJV. This setting makes it possible to skip the default cache. |
-|  [prohibitedKeys?](./rest.validationoptions.prohibitedkeys.md) | string\[\] | <i>(Optional)</i> An array of keys to be rejected, such as <code>__proto__</code>. |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [ajvErrors?](./rest.validationoptions.ajverrors.md) |  | [AjvErrorOptions](./rest.ajverroroptions.md) | <i>(Optional)</i> Enable custom error messages in JSON-Schema for AJV validator from https://github.com/epoberezkin/ajv-errors - <code>true</code>: Enable <code>ajv-errors</code> - <code>AjvErrorOptions</code>: Enable <code>ajv-errors</code> with options |
+|  [ajvErrorTransformer?](./rest.validationoptions.ajverrortransformer.md) |  | (errors: ErrorObject\[\]) =&gt; ErrorObject\[\] | <i>(Optional)</i> A function that transform the <code>ErrorObject</code>s reported by AJV. This could be used for error messages customization, localization, etc. |
+|  [ajvFactory?](./rest.validationoptions.ajvfactory.md) |  | (options: AjvOptions) =&gt; Ajv | <i>(Optional)</i> A factory to create Ajv instance |
+|  [ajvKeywords?](./rest.validationoptions.ajvkeywords.md) |  | string\[\] | <i>(Optional)</i> Enable additional AJV keywords from https://github.com/epoberezkin/ajv-keywords - <code>string[]</code>: Add an array of keywords from <code>ajv-keywords</code> |
+|  [compiledSchemaCache?](./rest.validationoptions.compiledschemacache.md) |  | [SchemaValidatorCache](./rest.schemavalidatorcache.md) | <i>(Optional)</i> Custom cache for compiled schemas by AJV. This setting makes it possible to skip the default cache. |
+|  [prohibitedKeys?](./rest.validationoptions.prohibitedkeys.md) |  | string\[\] | <i>(Optional)</i> An array of keys to be rejected, such as <code>__proto__</code>. |
 
 

package/site/apidocs/rest.valuevalidationoptions.md

@@ -24,9 +24,9 @@ export interface ValueValidationOptions extends ValidationOptions
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [name?](./rest.valuevalidationoptions.name.md) | string | <i>(Optional)</i> Parameter name, as provided in <code>ParameterObject#name</code> property. |
-|  [source?](./rest.valuevalidationoptions.source.md) | string | <i>(Optional)</i> Where the data comes from. It can be 'body', 'path', 'header', 'query', 'cookie', etc... |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [name?](./rest.valuevalidationoptions.name.md) |  | string | <i>(Optional)</i> Parameter name, as provided in <code>ParameterObject#name</code> property. |
+|  [source?](./rest.valuevalidationoptions.source.md) |  | string | <i>(Optional)</i> Where the data comes from. It can be 'body', 'path', 'header', 'query', 'cookie', etc... |
 
 

package/site/apidocs/security.defaultsubject.md

@@ -26,10 +26,10 @@ export declare class DefaultSubject implements Subject
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [authorities](./security.defaultsubject.authorities.md) |  | Set&lt;[Permission](./security.permission.md)<!-- -->&gt; |  |
-|  [credentials](./security.defaultsubject.credentials.md) |  | Set&lt;[Credential](./security.credential.md)<!-- -->&gt; |  |
-|  [principals](./security.defaultsubject.principals.md) |  | Set&lt;[TypedPrincipal](./security.typedprincipal.md)<!-- -->&gt; |  |
-|  [user](./security.defaultsubject.user.md) |  | [UserProfile](./security.userprofile.md) \| undefined |  |
+|  [authorities](./security.defaultsubject.authorities.md) | <code>readonly</code> | Set&lt;[Permission](./security.permission.md)<!-- -->&gt; |  |
+|  [credentials](./security.defaultsubject.credentials.md) | <code>readonly</code> | Set&lt;[Credential](./security.credential.md)<!-- -->&gt; |  |
+|  [principals](./security.defaultsubject.principals.md) | <code>readonly</code> | Set&lt;[TypedPrincipal](./security.typedprincipal.md)<!-- -->&gt; |  |
+|  [user](./security.defaultsubject.user.md) | <code>readonly</code> | [UserProfile](./security.userprofile.md) \| undefined |  |
 
 ## Methods
 

package/site/apidocs/security.md

@@ -24,7 +24,7 @@ Common types/interfaces for LoopBack 4 security including authentication and aut
 |  Class | Description |
 |  --- | --- |
 |  [DefaultSubject](./security.defaultsubject.md) | Default implementation of <code>Subject</code> |
-|  [Permission](./security.permission.md) | <code>Permission</code> defines an action/access against a protected resource. It's the <code>what</code> for security.<!-- -->There are three levels of permissions<!-- -->- Resource level (Order, User) - Instance level (Order-0001, User-1001) - Property level (User-0001.email) |
+|  [Permission](./security.permission.md) | <p><code>Permission</code> defines an action/access against a protected resource. It's the <code>what</code> for security.</p><p>There are three levels of permissions</p><p>- Resource level (Order, User) - Instance level (Order-0001, User-1001) - Property level (User-0001.email)</p> |
 |  [TypedPrincipal](./security.typedprincipal.md) |  |
 
 ## Interfaces
@@ -37,7 +37,7 @@ Common types/interfaces for LoopBack 4 security including authentication and aut
 |  [Principal](./security.principal.md) | Represent a user, an application, or a device |
 |  [Role](./security.role.md) |  |
 |  [Scope](./security.scope.md) | oAuth 2.0 scope |
-|  [Subject](./security.subject.md) | <code>Subject</code> represents both security state and operations for a single request. It's the <code>who</code> for security.<!-- -->Such operations include: - authentication (login) - authorization (access control) - session access - logout |
+|  [Subject](./security.subject.md) | <p><code>Subject</code> represents both security state and operations for a single request. It's the <code>who</code> for security.</p><p>Such operations include: - authentication (login) - authorization (access control) - session access - logout</p> |
 |  [Team](./security.team.md) |  |
 |  [UserProfile](./security.userprofile.md) | The minimum set of attributes that describe a user. |
 

package/site/apidocs/security.permission.md

@@ -33,7 +33,7 @@ export declare class Permission
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [\[securityId\]](./security.permission._securityid_.md) |  | string |  |
+|  [\[securityId\]](./security.permission._securityid_.md) | <code>readonly</code> | string |  |
 |  [action](./security.permission.action.md) |  | string | Action or access of a protected resources, such as <code>read</code>, <code>create</code>, <code>update</code>, or <code>delete</code> |
 |  [resourceId?](./security.permission.resourceid.md) |  | string | <i>(Optional)</i> Identity of a protected resource instance, such as <code>order-0001</code> or <code>customer-101</code> |
 |  [resourceProperty?](./security.permission.resourceproperty.md) |  | string | <i>(Optional)</i> Property of a protected resource type/instance, such as <code>email</code> |

package/site/apidocs/security.principal.md

@@ -23,8 +23,8 @@ export interface Principal
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [\[securityId\]](./security.principal._securityid_.md) | string | Name/id |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [\[securityId\]](./security.principal._securityid_.md) |  | string | Name/id |
 
 

package/site/apidocs/security.role.md

@@ -22,8 +22,8 @@ export interface Role extends Principal
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [name](./security.role.name.md) | string |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [name](./security.role.name.md) |  | string |  |
 
 

package/site/apidocs/security.scope.md

@@ -24,8 +24,8 @@ export interface Scope extends Permission
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [name](./security.scope.name.md) | string |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [name](./security.scope.name.md) |  | string |  |
 
 

package/site/apidocs/security.subject.md

@@ -25,10 +25,10 @@ export interface Subject
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [authorities](./security.subject.authorities.md) | Set&lt;[Permission](./security.permission.md)<!-- -->&gt; | An array of authorities granted by the user to the client application. One example is {@<!-- -->link https://tools.ietf.org/html/rfc6749\#section-3.3 \| oAuth2 scopes). |
-|  [credentials](./security.subject.credentials.md) | Set&lt;[Credential](./security.credential.md)<!-- -->&gt; | An array of credentials, such as password, access token, or private/public keys. |
-|  [principals](./security.subject.principals.md) | Set&lt;[TypedPrincipal](./security.typedprincipal.md)<!-- -->&gt; | An array of principals. It can include information about the current user, the client application, and granted authorities.<code>Subject</code> represents both security state and operations for a single application user.<!-- -->Such operations include: - authentication (login) - authorization (access control) - session access - logout |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [authorities](./security.subject.authorities.md) |  | Set&lt;[Permission](./security.permission.md)<!-- -->&gt; | An array of authorities granted by the user to the client application. One example is {@<!-- -->link https://tools.ietf.org/html/rfc6749\#section-3.3 \| oAuth2 scopes). |
+|  [credentials](./security.subject.credentials.md) |  | Set&lt;[Credential](./security.credential.md)<!-- -->&gt; | An array of credentials, such as password, access token, or private/public keys. |
+|  [principals](./security.subject.principals.md) |  | Set&lt;[TypedPrincipal](./security.typedprincipal.md)<!-- -->&gt; | <p>An array of principals. It can include information about the current user, the client application, and granted authorities.</p><p><code>Subject</code> represents both security state and operations for a single application user.</p><p>Such operations include: - authentication (login) - authorization (access control) - session access - logout</p> |
 
 

package/site/apidocs/security.typedprincipal.md

@@ -30,8 +30,8 @@ export declare class TypedPrincipal implements Principal
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [\[securityId\]](./security.typedprincipal._securityid_.md) |  | string |  |
-|  [principal](./security.typedprincipal.principal.md) |  | [Principal](./security.principal.md) |  |
-|  [type](./security.typedprincipal.type.md) |  | string |  |
+|  [\[securityId\]](./security.typedprincipal._securityid_.md) | <code>readonly</code> | string |  |
+|  [principal](./security.typedprincipal.principal.md) | <code>readonly</code> | [Principal](./security.principal.md) |  |
+|  [type](./security.typedprincipal.type.md) | <code>readonly</code> | string |  |
 
 

package/site/apidocs/security.userprofile.md

@@ -24,9 +24,9 @@ export interface UserProfile extends Principal
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [email?](./security.userprofile.email.md) | string | <i>(Optional)</i> |
-|  [name?](./security.userprofile.name.md) | string | <i>(Optional)</i> |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [email?](./security.userprofile.email.md) |  | string | <i>(Optional)</i> |
+|  [name?](./security.userprofile.name.md) |  | string | <i>(Optional)</i> |
 
 

package/site/apidocs/service-proxy.md

@@ -19,7 +19,7 @@ A common set of interfaces for interacting with service oriented backends such a
 
 |  Class | Description |
 |  --- | --- |
-|  [ServiceMixinDoc](./service-proxy.servicemixindoc.md) | A dummy class created to generate the tsdoc for the members in service mixin. Please don't use it.<!-- -->The members are implemented in function <a href="#ServiceMixin">ServiceMixin</a> |
+|  [ServiceMixinDoc](./service-proxy.servicemixindoc.md) | <p>A dummy class created to generate the tsdoc for the members in service mixin. Please don't use it.</p><p>The members are implemented in function <a href="#ServiceMixin">ServiceMixin</a></p> |
 |  [ServiceProxyMetadata](./service-proxy.serviceproxymetadata.md) | Metadata for a service proxy |
 
 ## Functions

package/site/apidocs/socketio.defaultsocketiosequence.md

@@ -30,11 +30,11 @@ export declare class DefaultSocketIoSequence implements SocketIoSequence
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [context](./socketio.defaultsocketiosequence.context.md) |  | [Context](./context.context.md) |  |
-|  [controller](./socketio.defaultsocketiosequence.controller.md) |  | [ControllerClass](./core.controllerclass.md) |  |
-|  [invoke](./socketio.defaultsocketiosequence.invoke.md) |  | [SocketIoInvokeMethod](./socketio.socketioinvokemethod.md) |  |
-|  [reject](./socketio.defaultsocketiosequence.reject.md) |  | [SocketIoRejectMethod](./socketio.socketiorejectmethod.md) |  |
-|  [send](./socketio.defaultsocketiosequence.send.md) |  | [SocketIoSendMethod](./socketio.socketiosendmethod.md) |  |
+|  [context](./socketio.defaultsocketiosequence.context.md) | <code>protected</code> | [Context](./context.context.md) |  |
+|  [controller](./socketio.defaultsocketiosequence.controller.md) | <code>protected</code> | [ControllerClass](./core.controllerclass.md) |  |
+|  [invoke](./socketio.defaultsocketiosequence.invoke.md) | <code>protected</code> | [SocketIoInvokeMethod](./socketio.socketioinvokemethod.md) |  |
+|  [reject](./socketio.defaultsocketiosequence.reject.md) | <code>protected</code> | [SocketIoRejectMethod](./socketio.socketiorejectmethod.md) |  |
+|  [send](./socketio.defaultsocketiosequence.send.md) | <code>protected</code> | [SocketIoSendMethod](./socketio.socketiosendmethod.md) |  |
 
 ## Methods
 

package/site/apidocs/socketio.httpserverresolvedoptions.md

@@ -23,12 +23,12 @@ export interface HttpServerResolvedOptions
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [basePath?](./socketio.httpserverresolvedoptions.basepath.md) | string | <i>(Optional)</i> |
-|  [cors](./socketio.httpserverresolvedoptions.cors.md) | cors.CorsOptions |  |
-|  [host?](./socketio.httpserverresolvedoptions.host.md) | string | <i>(Optional)</i> |
-|  [path?](./socketio.httpserverresolvedoptions.path.md) | string | <i>(Optional)</i> |
-|  [port](./socketio.httpserverresolvedoptions.port.md) | number |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [basePath?](./socketio.httpserverresolvedoptions.basepath.md) |  | string | <i>(Optional)</i> |
+|  [cors](./socketio.httpserverresolvedoptions.cors.md) |  | cors.CorsOptions |  |
+|  [host?](./socketio.httpserverresolvedoptions.host.md) |  | string | <i>(Optional)</i> |
+|  [path?](./socketio.httpserverresolvedoptions.path.md) |  | string | <i>(Optional)</i> |
+|  [port](./socketio.httpserverresolvedoptions.port.md) |  | number |  |
 
 

package/site/apidocs/socketio.socketio.md

@@ -28,7 +28,7 @@ export declare namespace socketio
 |  [io()](./socketio.socketio.io.md) |  |
 |  [namespace(name)](./socketio.socketio.namespace.md) |  |
 |  [socket()](./socketio.socketio.socket.md) |  |
-|  [subscribe(messageTypes)](./socketio.socketio.subscribe.md) | Decorate a method to subscribe to socketio events. For example,
+|  [subscribe(messageTypes)](./socketio.socketio.subscribe.md) | <p>Decorate a method to subscribe to socketio events. For example,</p>
 ```ts
 @socketio.subscribe('chat message')
 async function onChat(msg: string) {

package/site/apidocs/socketio.socketioapplication.md

@@ -30,7 +30,7 @@ export declare class SocketIoApplication extends Application
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [socketServer](./socketio.socketioapplication.socketserver.md) |  | [SocketIoServer](./socketio.socketioserver.md) | The main Socket server instance providing Socket connections for this application. |
+|  [socketServer](./socketio.socketioapplication.socketserver.md) | <code>readonly</code> | [SocketIoServer](./socketio.socketioserver.md) | The main Socket server instance providing Socket connections for this application. |
 
 ## Methods
 

package/site/apidocs/socketio.socketiobooter.md

@@ -40,7 +40,7 @@ Supported phases: `configure`<!-- -->, `discover`<!-- -->, `load`
 |  --- | --- | --- | --- |
 |  [app](./socketio.socketiobooter.app.md) |  | [Application](./core.application.md) |  |
 |  [socketioControllerConfig](./socketio.socketiobooter.socketiocontrollerconfig.md) |  | [ArtifactOptions](./boot.artifactoptions.md) |  |
-|  [socketioServer](./socketio.socketiobooter.socketioserver.md) |  | [SocketIoServer](./socketio.socketioserver.md) |  |
+|  [socketioServer](./socketio.socketiobooter.socketioserver.md) | <code>protected</code> | [SocketIoServer](./socketio.socketioserver.md) |  |
 
 ## Methods
 

package/site/apidocs/socketio.socketioconnectioncontext.md

@@ -32,6 +32,6 @@ export declare class SocketIoConnectionContext extends Context
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [socket](./socketio.socketioconnectioncontext.socket.md) |  | Socket |  |
+|  [socket](./socketio.socketioconnectioncontext.socket.md) | <code>readonly</code> | Socket |  |
 
 

package/site/apidocs/socketio.socketiocontrollerfactory.md

@@ -31,7 +31,7 @@ export declare class SocketIoControllerFactory
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [connCtx](./socketio.socketiocontrollerfactory.connctx.md) |  | [SocketIoConnectionContext](./socketio.socketioconnectioncontext.md) |  |
+|  [connCtx](./socketio.socketiocontrollerfactory.connctx.md) | <code>readonly</code> | [SocketIoConnectionContext](./socketio.socketioconnectioncontext.md) |  |
 
 ## Methods
 
@@ -39,12 +39,12 @@ export declare class SocketIoControllerFactory
 |  --- | --- | --- |
 |  [connect()](./socketio.socketiocontrollerfactory.connect.md) |  |  |
 |  [create()](./socketio.socketiocontrollerfactory.create.md) |  |  |
-|  [getAllMethodMetadataForKey(metadataAccessor)](./socketio.socketiocontrollerfactory.getallmethodmetadataforkey.md) |  |  |
+|  [getAllMethodMetadataForKey(metadataAccessor)](./socketio.socketiocontrollerfactory.getallmethodmetadataforkey.md) | <code>protected</code> |  |
 |  [getCallback(methodName)](./socketio.socketiocontrollerfactory.getcallback.md) |  |  |
 |  [getDecoratedMethodsForConnect()](./socketio.socketiocontrollerfactory.getdecoratedmethodsforconnect.md) |  |  |
-|  [getDecorateSubscribeMethods()](./socketio.socketiocontrollerfactory.getdecoratesubscribemethods.md) |  |  |
+|  [getDecorateSubscribeMethods()](./socketio.socketiocontrollerfactory.getdecoratesubscribemethods.md) | <code>protected</code> |  |
 |  [getDecorateSubscribeMethodsByEventName()](./socketio.socketiocontrollerfactory.getdecoratesubscribemethodsbyeventname.md) |  |  |
-|  [registerSubscribeMethods()](./socketio.socketiocontrollerfactory.registersubscribemethods.md) |  |  |
+|  [registerSubscribeMethods()](./socketio.socketiocontrollerfactory.registersubscribemethods.md) | <code>protected</code> |  |
 |  [setup()](./socketio.socketiocontrollerfactory.setup.md) |  | Set up the controller for the given socket |
 
 

package/site/apidocs/socketio.socketioinvokemethodprovider.md

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.socketio.socketioinvokemethodprovider.html
 ```typescript
 export declare class SocketIoInvokeMethodProvider implements Provider<SocketIoInvokeMethod> 
 ```
-<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[SocketIoInvokeMethod](./socketio.socketioinvokemethod.md)
+<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[SocketIoInvokeMethod](./socketio.socketioinvokemethod.md)<!-- -->&gt;
 
 ## Constructors
 

package/site/apidocs/socketio.socketiometadata.md

@@ -23,9 +23,9 @@ export interface SocketIoMetadata
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [name?](./socketio.socketiometadata.name.md) | string | <i>(Optional)</i> |
-|  [namespace?](./socketio.socketiometadata.namespace.md) | string \| RegExp | <i>(Optional)</i> |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [name?](./socketio.socketiometadata.name.md) |  | string | <i>(Optional)</i> |
+|  [namespace?](./socketio.socketiometadata.namespace.md) |  | string \| RegExp | <i>(Optional)</i> |
 
 

package/site/apidocs/socketio.socketiorejectprovider.md

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.socketio.socketiorejectprovider.html
 ```typescript
 export declare class SocketIoRejectProvider implements Provider<SocketIoRejectMethod> 
 ```
-<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[SocketIoRejectMethod](./socketio.socketiorejectmethod.md)
+<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[SocketIoRejectMethod](./socketio.socketiorejectmethod.md)<!-- -->&gt;
 
 ## Methods
 

package/site/apidocs/socketio.socketiosendprovider.md

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.socketio.socketiosendprovider.html
 ```typescript
 export declare class SocketIoSendProvider implements Provider<SocketIoSendMethod> 
 ```
-<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[SocketIoSendMethod](./socketio.socketiosendmethod.md)
+<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[SocketIoSendMethod](./socketio.socketiosendmethod.md)<!-- -->&gt;
 
 ## Methods
 

package/site/apidocs/socketio.socketioserver.md

@@ -33,10 +33,10 @@ export declare class SocketIoServer extends Context
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [app](./socketio.socketioserver.app.md) |  | [Application](./core.application.md) |  |
-|  [config](./socketio.socketioserver.config.md) |  | [HttpServerResolvedOptions](./socketio.httpserverresolvedoptions.md) |  |
-|  [listening](./socketio.socketioserver.listening.md) |  | boolean |  |
-|  [options](./socketio.socketioserver.options.md) |  | [SocketIoServerOptions](./socketio.socketioserveroptions.md) |  |
-|  [url](./socketio.socketioserver.url.md) |  | string |  |
+|  [config](./socketio.socketioserver.config.md) | <code>readonly</code> | [HttpServerResolvedOptions](./socketio.httpserverresolvedoptions.md) |  |
+|  [listening](./socketio.socketioserver.listening.md) | <code>readonly</code> | boolean |  |
+|  [options](./socketio.socketioserver.options.md) | <code>protected</code> | [SocketIoServerOptions](./socketio.socketioserveroptions.md) |  |
+|  [url](./socketio.socketioserver.url.md) | <code>readonly</code> | string |  |
 
 ## Methods