@loopback/docs 5.0.0 → 5.1.2

package/site/apidocs/rest.httphandler.md

@@ -29,17 +29,17 @@ export declare class HttpHandler
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [\_openApiComponents](./rest.httphandler._openapicomponents.md) |  | ComponentsObject | Shared OpenAPI spec objects as <code>components</code> |
-|  [\_rootContext](./rest.httphandler._rootcontext.md) |  | [Context](./context.context.md) |  |
-|  [\_routes](./rest.httphandler._routes.md) |  | [RoutingTable](./rest.routingtable.md) |  |
-|  [\_serverConfig](./rest.httphandler._serverconfig.md) |  | [RestServerResolvedConfig](./rest.restserverresolvedconfig.md) |  |
+|  [\_openApiComponents](./rest.httphandler._openapicomponents.md) | <code>protected</code> | ComponentsObject | Shared OpenAPI spec objects as <code>components</code> |
+|  [\_rootContext](./rest.httphandler._rootcontext.md) | <p><code>protected</code></p><p><code>readonly</code></p> | [Context](./context.context.md) |  |
+|  [\_routes](./rest.httphandler._routes.md) | <p><code>protected</code></p><p><code>readonly</code></p> | [RoutingTable](./rest.routingtable.md) |  |
+|  [\_serverConfig](./rest.httphandler._serverconfig.md) | <p><code>protected</code></p><p><code>readonly</code></p> | [RestServerResolvedConfig](./rest.restserverresolvedconfig.md) |  |
 |  [handleRequest](./rest.httphandler.handlerequest.md) |  | (request: Request, response: Response) =&gt; Promise&lt;void&gt; |  |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [\_handleRequest(request, response)](./rest.httphandler._handlerequest.md) |  |  |
+|  [\_handleRequest(request, response)](./rest.httphandler._handlerequest.md) | <code>protected</code> |  |
 |  [describeApiPaths()](./rest.httphandler.describeapipaths.md) |  |  |
 |  [findRoute(request)](./rest.httphandler.findroute.md) |  |  |
 |  [getApiComponents()](./rest.httphandler.getapicomponents.md) |  |  |

package/site/apidocs/rest.httpserverlike.md

@@ -21,8 +21,8 @@ export interface HttpServerLike
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [requestHandler](./rest.httpserverlike.requesthandler.md) | [HttpRequestListener](./rest.httprequestlistener.md) |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [requestHandler](./rest.httpserverlike.requesthandler.md) |  | [HttpRequestListener](./rest.httprequestlistener.md) |  |
 
 

package/site/apidocs/rest.infospecenhancer.md

@@ -33,7 +33,7 @@ export declare class InfoSpecEnhancer implements OASEnhancer
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [name](./rest.infospecenhancer.name.md) |  | string |  |
-|  [pkg?](./rest.infospecenhancer.pkg.md) |  | [ApplicationMetadata](./core.applicationmetadata.md) \| undefined | <i>(Optional)</i> |
+|  [pkg?](./rest.infospecenhancer.pkg.md) | <code>readonly</code> | [ApplicationMetadata](./core.applicationmetadata.md) \| undefined | <i>(Optional)</i> |
 
 ## Methods
 

package/site/apidocs/rest.invokemethodmiddlewareprovider.md

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.rest.invokemethodmiddlewareprovider.html
 ```typescript
 export declare class InvokeMethodMiddlewareProvider 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.md

@@ -100,7 +100,7 @@ A REST server for LoopBack 4 application instances, complete with:
 |  [Node](./rest.node.md) | A Node in the trie |
 |  [OpenApiSpecForm](./rest.openapispecform.md) | The form of OpenAPI specs to be served |
 |  [OpenApiSpecOptions](./rest.openapispecoptions.md) | Options to customize how OpenAPI specs are served |
-|  [RequestBodyParserOptions](./rest.requestbodyparseroptions.md) | Options for request body parsing See https://github.com/expressjs/body-parser/\#options<!-- -->Built-in parsers retrieve their own options from the request body parser options. The parser specific properties override common ones. |
+|  [RequestBodyParserOptions](./rest.requestbodyparseroptions.md) | <p>Options for request body parsing See https://github.com/expressjs/body-parser/\#options</p><p>Built-in parsers retrieve their own options from the request body parser options. The parser specific properties override common ones.</p> |
 |  [RequestWithSession](./rest.requestwithsession.md) | extending express request type with a session field |
 |  [ResolvedNode](./rest.resolvednode.md) |  |
 |  [ResolvedRoute](./rest.resolvedroute.md) | A route with path parameters resolved |

package/site/apidocs/rest.middlewaresequence.md

@@ -33,13 +33,13 @@ export declare class MiddlewareSequence implements SequenceHandler
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [defaultOptions](./rest.middlewaresequence.defaultoptions.md) | <code>static</code> | [InvokeMiddlewareOptions](./express.invokemiddlewareoptions.md) |  |
-|  [invokeMiddleware](./rest.middlewaresequence.invokemiddleware.md) |  | [InvokeMiddleware](./express.invokemiddleware.md) |  |
-|  [options](./rest.middlewaresequence.options.md) |  | [InvokeMiddlewareOptions](./express.invokemiddlewareoptions.md) |  |
+|  [invokeMiddleware](./rest.middlewaresequence.invokemiddleware.md) | <code>readonly</code> | [InvokeMiddleware](./express.invokemiddleware.md) |  |
+|  [options](./rest.middlewaresequence.options.md) | <code>readonly</code> | [InvokeMiddlewareOptions](./express.invokemiddlewareoptions.md) |  |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [handle(context)](./rest.middlewaresequence.handle.md) |  | Runs the default sequence. Given a handler context (request and response), running the sequence will produce a response or an error.<!-- -->Default sequence executes these groups of middleware:<!-- -->- <code>cors</code>: Enforces <code>CORS</code> - <code>openApiSpec</code>: Serves OpenAPI specs - <code>findRoute</code>: Finds the appropriate controller method, swagger spec and args for invocation - <code>parseParams</code>: Parses HTTP request to get API argument list - <code>invokeMethod</code>: Invokes the API which is defined in the Application controller method<!-- -->In front of the groups above, we have a special middleware called <code>sendResponse</code>, which first invokes downstream middleware to get a result and handles the result or error respectively.<!-- -->- Writes the result from API into the HTTP response (if the HTTP response has not been produced yet by the middleware chain. - Catches error logs it using 'logError' if any of the above steps in the sequence fails with an error. |
+|  [handle(context)](./rest.middlewaresequence.handle.md) |  | <p>Runs the default sequence. Given a handler context (request and response), running the sequence will produce a response or an error.</p><p>Default sequence executes these groups of middleware:</p><p>- <code>cors</code>: Enforces <code>CORS</code> - <code>openApiSpec</code>: Serves OpenAPI specs - <code>findRoute</code>: Finds the appropriate controller method, swagger spec and args for invocation - <code>parseParams</code>: Parses HTTP request to get API argument list - <code>invokeMethod</code>: Invokes the API which is defined in the Application controller method</p><p>In front of the groups above, we have a special middleware called <code>sendResponse</code>, which first invokes downstream middleware to get a result and handles the result or error respectively.</p><p>- Writes the result from API into the HTTP response (if the HTTP response has not been produced yet by the middleware chain. - Catches error logs it using 'logError' if any of the above steps in the sequence fails with an error.</p> |
 
 

package/site/apidocs/rest.node.md

@@ -23,12 +23,12 @@ export interface Node<T>
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [children](./rest.node.children.md) | { \[key: string\]: [Node](./rest.node.md)<!-- -->&lt;T&gt;; } | Children of the node |
-|  [key](./rest.node.key.md) | string | Key of the node |
-|  [names?](./rest.node.names.md) | string\[\] | <i>(Optional)</i> Names of the node if it contains named parameters |
-|  [regexp?](./rest.node.regexp.md) | RegExp | <i>(Optional)</i> Regular expression for the template |
-|  [value?](./rest.node.value.md) | T | <i>(Optional)</i> Value of the node |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [children](./rest.node.children.md) | <code>readonly</code> | { \[key: string\]: [Node](./rest.node.md)<!-- -->&lt;T&gt;; } | Children of the node |
+|  [key](./rest.node.key.md) |  | string | Key of the node |
+|  [names?](./rest.node.names.md) |  | string\[\] | <i>(Optional)</i> Names of the node if it contains named parameters |
+|  [regexp?](./rest.node.regexp.md) |  | RegExp | <i>(Optional)</i> Regular expression for the template |
+|  [value?](./rest.node.value.md) |  | T | <i>(Optional)</i> Value of the node |
 
 

package/site/apidocs/rest.openapispecform.md

@@ -23,9 +23,9 @@ export interface OpenApiSpecForm
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [format?](./rest.openapispecform.format.md) | string | <i>(Optional)</i> |
-|  [version?](./rest.openapispecform.version.md) | string | <i>(Optional)</i> |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [format?](./rest.openapispecform.format.md) |  | string | <i>(Optional)</i> |
+|  [version?](./rest.openapispecform.version.md) |  | string | <i>(Optional)</i> |
 
 

package/site/apidocs/rest.openapispecoptions.md

@@ -23,12 +23,12 @@ export interface OpenApiSpecOptions
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [consolidate?](./rest.openapispecoptions.consolidate.md) | boolean | <i>(Optional)</i> Set this flag to <code>false</code> to disable OAS schema consolidation. If not set, the value defaults to <code>true</code>. |
-|  [disabled?](./rest.openapispecoptions.disabled.md) | true | <i>(Optional)</i> Set this flag to disable the endpoint for OpenAPI spec |
-|  [endpointMapping?](./rest.openapispecoptions.endpointmapping.md) | { \[key: string\]: [OpenApiSpecForm](./rest.openapispecform.md)<!-- -->; } | <i>(Optional)</i> Mapping of urls to spec forms, by default: <br> { <br> '/openapi.json': {<!-- -->version: '3.0.0', format: 'json'<!-- -->}<!-- -->, <br> '/openapi.yaml': {<!-- -->version: '3.0.0', format: 'yaml'<!-- -->}<!-- -->, <br> } |
-|  [servers?](./rest.openapispecoptions.servers.md) | ServerObject\[\] | <i>(Optional)</i> Configure servers for OpenAPI spec |
-|  [setServersFromRequest?](./rest.openapispecoptions.setserversfromrequest.md) | boolean | <i>(Optional)</i> A flag to force <code>servers</code> to be set from the http request for the OpenAPI spec |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [consolidate?](./rest.openapispecoptions.consolidate.md) |  | boolean | <i>(Optional)</i> Set this flag to <code>false</code> to disable OAS schema consolidation. If not set, the value defaults to <code>true</code>. |
+|  [disabled?](./rest.openapispecoptions.disabled.md) |  | true | <i>(Optional)</i> Set this flag to disable the endpoint for OpenAPI spec |
+|  [endpointMapping?](./rest.openapispecoptions.endpointmapping.md) |  | { \[key: string\]: [OpenApiSpecForm](./rest.openapispecform.md)<!-- -->; } | <i>(Optional)</i> Mapping of urls to spec forms, by default: <br> { <br> '/openapi.json': {<!-- -->version: '3.0.0', format: 'json'<!-- -->}<!-- -->, <br> '/openapi.yaml': {<!-- -->version: '3.0.0', format: 'yaml'<!-- -->}<!-- -->, <br> } |
+|  [servers?](./rest.openapispecoptions.servers.md) |  | ServerObject\[\] | <i>(Optional)</i> Configure servers for OpenAPI spec |
+|  [setServersFromRequest?](./rest.openapispecoptions.setserversfromrequest.md) |  | boolean | <i>(Optional)</i> A flag to force <code>servers</code> to be set from the http request for the OpenAPI spec |
 
 

package/site/apidocs/rest.parseparamsmiddlewareprovider.md

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.rest.parseparamsmiddlewareprovider.html
 ```typescript
 export declare class ParseParamsMiddlewareProvider 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.redirectroute.md

@@ -30,14 +30,14 @@ export declare class RedirectRoute implements RouteEntry, ResolvedRoute
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [path](./rest.redirectroute.path.md) |  | string |  |
-|  [pathParams](./rest.redirectroute.pathparams.md) |  | [PathParameterValues](./rest.pathparametervalues.md) |  |
-|  [schemas](./rest.redirectroute.schemas.md) |  | SchemasObject |  |
-|  [sourcePath](./rest.redirectroute.sourcepath.md) |  | string |  |
-|  [spec](./rest.redirectroute.spec.md) |  | OperationObject |  |
-|  [statusCode](./rest.redirectroute.statuscode.md) |  | number |  |
-|  [targetLocation](./rest.redirectroute.targetlocation.md) |  | string |  |
-|  [verb](./rest.redirectroute.verb.md) |  | string |  |
+|  [path](./rest.redirectroute.path.md) | <code>readonly</code> | string |  |
+|  [pathParams](./rest.redirectroute.pathparams.md) | <code>readonly</code> | [PathParameterValues](./rest.pathparametervalues.md) |  |
+|  [schemas](./rest.redirectroute.schemas.md) | <code>readonly</code> | SchemasObject |  |
+|  [sourcePath](./rest.redirectroute.sourcepath.md) | <code>readonly</code> | string |  |
+|  [spec](./rest.redirectroute.spec.md) | <code>readonly</code> | OperationObject |  |
+|  [statusCode](./rest.redirectroute.statuscode.md) | <code>readonly</code> | number |  |
+|  [targetLocation](./rest.redirectroute.targetlocation.md) | <code>readonly</code> | string |  |
+|  [verb](./rest.redirectroute.verb.md) | <code>readonly</code> | string |  |
 
 ## Methods
 

package/site/apidocs/rest.regexprouter.md

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

package/site/apidocs/rest.requestbodyparser.md

@@ -29,7 +29,7 @@ export declare class RequestBodyParser
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [parsers](./rest.requestbodyparser.parsers.md) |  | [BodyParser](./rest.bodyparser.md)<!-- -->\[\] |  |
+|  [parsers](./rest.requestbodyparser.parsers.md) | <code>readonly</code> | [BodyParser](./rest.bodyparser.md)<!-- -->\[\] |  |
 
 ## Methods
 

package/site/apidocs/rest.requestbodyparseroptions.md

@@ -26,12 +26,12 @@ export interface RequestBodyParserOptions extends Options
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [json?](./rest.requestbodyparseroptions.json.md) | OptionsJson | <i>(Optional)</i> Options for json parser |
-|  [raw?](./rest.requestbodyparseroptions.raw.md) | Options | <i>(Optional)</i> Options for raw parser |
-|  [text?](./rest.requestbodyparseroptions.text.md) | OptionsText | <i>(Optional)</i> Options for text parser |
-|  [urlencoded?](./rest.requestbodyparseroptions.urlencoded.md) | OptionsUrlencoded | <i>(Optional)</i> Options for urlencoded parser |
-|  [validation?](./rest.requestbodyparseroptions.validation.md) | [ValidationOptions](./rest.validationoptions.md) | <i>(Optional)</i> Validation options for AJV, see https://github.com/epoberezkin/ajv\#options This setting is global for all request body parsers and it cannot be overridden inside parser specific properties such as <code>json</code> or <code>text</code>. |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [json?](./rest.requestbodyparseroptions.json.md) |  | OptionsJson | <i>(Optional)</i> Options for json parser |
+|  [raw?](./rest.requestbodyparseroptions.raw.md) |  | Options | <i>(Optional)</i> Options for raw parser |
+|  [text?](./rest.requestbodyparseroptions.text.md) |  | OptionsText | <i>(Optional)</i> Options for text parser |
+|  [urlencoded?](./rest.requestbodyparseroptions.urlencoded.md) |  | OptionsUrlencoded | <i>(Optional)</i> Options for urlencoded parser |
+|  [validation?](./rest.requestbodyparseroptions.validation.md) |  | [ValidationOptions](./rest.validationoptions.md) | <i>(Optional)</i> Validation options for AJV, see https://github.com/epoberezkin/ajv\#options This setting is global for all request body parsers and it cannot be overridden inside parser specific properties such as <code>json</code> or <code>text</code>. |
 
 

package/site/apidocs/rest.requestcontext.md

@@ -34,17 +34,17 @@ export declare class RequestContext extends MiddlewareContext implements Handler
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [basePath](./rest.requestcontext.basepath.md) |  | string | Get the effective base path of the incoming request. This base path combines <code>baseUrl</code> provided by Express when LB4 handler is mounted on a non-root path, with the <code>basePath</code> value configured at LB4 side. |
-|  [request](./rest.requestcontext.request.md) |  | Request |  |
-|  [requestedBaseUrl](./rest.requestcontext.requestedbaseurl.md) |  | string | Get the base URL used by the client to make the request. This URL contains the protocol, hostname, port and base path. The path of the invoked route and query string is not included.<!-- -->Please note these values may be different from what we are observing at HTTP/TCP level, because reverse proxies like nginx are rewriting them. |
-|  [requestedProtocol](./rest.requestcontext.requestedprotocol.md) |  | string | Get the protocol used by the client to make the request. Please note this protocol may be different from what we are observing at HTTP/TCP level, because reverse proxies like nginx or sidecars like Envoy are switching between protocols. |
-|  [response](./rest.requestcontext.response.md) |  | Response |  |
-|  [serverConfig](./rest.requestcontext.serverconfig.md) |  | [RestServerResolvedConfig](./rest.restserverresolvedconfig.md) |  |
+|  [basePath](./rest.requestcontext.basepath.md) | <code>readonly</code> | string | Get the effective base path of the incoming request. This base path combines <code>baseUrl</code> provided by Express when LB4 handler is mounted on a non-root path, with the <code>basePath</code> value configured at LB4 side. |
+|  [request](./rest.requestcontext.request.md) | <code>readonly</code> | Request |  |
+|  [requestedBaseUrl](./rest.requestcontext.requestedbaseurl.md) | <code>readonly</code> | string | <p>Get the base URL used by the client to make the request. This URL contains the protocol, hostname, port and base path. The path of the invoked route and query string is not included.</p><p>Please note these values may be different from what we are observing at HTTP/TCP level, because reverse proxies like nginx are rewriting them.</p> |
+|  [requestedProtocol](./rest.requestcontext.requestedprotocol.md) | <code>readonly</code> | string | Get the protocol used by the client to make the request. Please note this protocol may be different from what we are observing at HTTP/TCP level, because reverse proxies like nginx or sidecars like Envoy are switching between protocols. |
+|  [response](./rest.requestcontext.response.md) | <code>readonly</code> | Response |  |
+|  [serverConfig](./rest.requestcontext.serverconfig.md) | <code>readonly</code> | [RestServerResolvedConfig](./rest.restserverresolvedconfig.md) |  |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [setupBindings()](./rest.requestcontext.setupbindings.md) |  |  |
+|  [setupBindings()](./rest.requestcontext.setupbindings.md) | <code>protected</code> |  |
 
 

package/site/apidocs/rest.requestwithsession.md

@@ -24,8 +24,8 @@ export interface RequestWithSession extends Request
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [session](./rest.requestwithsession.session.md) | [Session](./rest.session.md) |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [session](./rest.requestwithsession.session.md) |  | [Session](./rest.session.md) |  |
 
 

package/site/apidocs/rest.resolvednode.md

@@ -21,9 +21,9 @@ export interface ResolvedNode<T>
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [node](./rest.resolvednode.node.md) | [Node](./rest.node.md)<!-- -->&lt;T&gt; |  |
-|  [params?](./rest.resolvednode.params.md) | [PathParameterValues](./rest.pathparametervalues.md) | <i>(Optional)</i> |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [node](./rest.resolvednode.node.md) |  | [Node](./rest.node.md)<!-- -->&lt;T&gt; |  |
+|  [params?](./rest.resolvednode.params.md) |  | [PathParameterValues](./rest.pathparametervalues.md) | <i>(Optional)</i> |
 
 

package/site/apidocs/rest.resolvedroute.md

@@ -24,9 +24,9 @@ export interface ResolvedRoute extends RouteEntry
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [pathParams](./rest.resolvedroute.pathparams.md) | [PathParameterValues](./rest.pathparametervalues.md) |  |
-|  [schemas](./rest.resolvedroute.schemas.md) | SchemasObject | Server/application wide schemas shared by multiple routes, e.g. model schemas. This is a temporary workaround for missing support for $ref references, see https://github.com/loopbackio/loopback-next/issues/435 |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [pathParams](./rest.resolvedroute.pathparams.md) | <code>readonly</code> | [PathParameterValues](./rest.pathparametervalues.md) |  |
+|  [schemas](./rest.resolvedroute.schemas.md) | <code>readonly</code> | SchemasObject | Server/application wide schemas shared by multiple routes, e.g. model schemas. This is a temporary workaround for missing support for $ref references, see https://github.com/loopbackio/loopback-next/issues/435 |
 
 

package/site/apidocs/rest.restapplication.md

@@ -35,14 +35,14 @@ export declare class RestApplication extends Application implements HttpServerLi
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [requestHandler](./rest.restapplication.requesthandler.md) |  | [HttpRequestListener](./rest.httprequestlistener.md) | Handle incoming HTTP(S) request by invoking the corresponding Controller method via the configured Sequence. |
-|  [restServer](./rest.restapplication.restserver.md) |  | [RestServer](./rest.restserver.md) | The main REST server instance providing REST API for this application. |
+|  [requestHandler](./rest.restapplication.requesthandler.md) | <code>readonly</code> | [HttpRequestListener](./rest.httprequestlistener.md) | Handle incoming HTTP(S) request by invoking the corresponding Controller method via the configured Sequence. |
+|  [restServer](./rest.restapplication.restserver.md) | <code>readonly</code> | [RestServer](./rest.restserver.md) | The main REST server instance providing REST API for this application. |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [api(spec)](./rest.restapplication.api.md) |  | Set the OpenAPI specification that defines the REST API schema for this application. 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.restapplication.api.md) |  | <p>Set the OpenAPI specification that defines the REST API schema for this application. 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.restapplication.basepath.md) |  | Configure the <code>basePath</code> for the rest server |
 |  [bodyParser(bodyParserClass, address)](./rest.restapplication.bodyparser.md) |  | Bind a body parser to the server context |
 |  [exportOpenApiSpec(outFile, log)](./rest.restapplication.exportopenapispec.md) |  | Export the OpenAPI spec to the given json or yaml file |

package/site/apidocs/rest.restbindings.md

@@ -37,7 +37,7 @@ export declare namespace RestBindings
 |  [API\_SPEC](./rest.restbindings.api_spec.md) | Binding key for setting and injecting an OpenAPI spec |
 |  [BASE\_PATH](./rest.restbindings.base_path.md) | Internal binding key for basePath |
 |  [CONFIG](./rest.restbindings.config.md) | Binding key for setting and injecting RestComponentConfig |
-|  [ERROR\_WRITER\_OPTIONS](./rest.restbindings.error_writer_options.md) | Binding key for setting and injecting Reject action's error handling options.<!-- -->See https://github.com/loopbackio/strong-error-handler\#options for the list of available options. Please note that the flag <code>log</code> is not used by <code>@loopback/rest</code>. |
+|  [ERROR\_WRITER\_OPTIONS](./rest.restbindings.error_writer_options.md) | <p>Binding key for setting and injecting Reject action's error handling options.</p><p>See https://github.com/loopbackio/strong-error-handler\#options for the list of available options. Please note that the flag <code>log</code> is not used by <code>@loopback/rest</code>.</p> |
 |  [HANDLER](./rest.restbindings.handler.md) | Internal binding key for http-handler |
 |  [HOST](./rest.restbindings.host.md) | Binding key for setting and injecting the host name of RestServer |
 |  [HTTPS\_OPTIONS](./rest.restbindings.https_options.md) | Binding key for HTTPS options |

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> |  |