@loopback/docs 5.1.1 → 5.1.2

package/site/apidocs/filter.inclusion.md

@@ -27,10 +27,10 @@ export interface Inclusion
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [relation](./filter.inclusion.relation.md) | string |  |
-|  [scope?](./filter.inclusion.scope.md) | [Filter](./filter.filter.md)<!-- -->&lt;AnyObject&gt; &amp; { totalLimit?: number; } | <i>(Optional)</i> |
-|  [targetType?](./filter.inclusion.targettype.md) | string | <i>(Optional)</i> |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [relation](./filter.inclusion.relation.md) |  | string |  |
+|  [scope?](./filter.inclusion.scope.md) |  | [Filter](./filter.filter.md)<!-- -->&lt;AnyObject&gt; &amp; { totalLimit?: number; } | <i>(Optional)</i> |
+|  [targetType?](./filter.inclusion.targettype.md) |  | string | <i>(Optional)</i> |
 
 

package/site/apidocs/filter.md

@@ -39,7 +39,7 @@ This lightweight module provides strongly-typed typings and filter builders to i
 |  --- | --- |
 |  [AndClause](./filter.andclause.md) | And clause |
 |  [Filter](./filter.filter.md) | Query filter object |
-|  [Inclusion](./filter.inclusion.md) | Inclusion of related items<!-- -->Note: scope means filter on related items<!-- -->Example: <code>{relation: 'aRelationName', scope: {&lt;AFilterObject&gt;}}</code> |
+|  [Inclusion](./filter.inclusion.md) | <p>Inclusion of related items</p><p>Note: scope means filter on related items</p><p>Example: <code>{relation: 'aRelationName', scope: {&lt;AFilterObject&gt;}}</code></p> |
 |  [OrClause](./filter.orclause.md) | Or clause |
 
 ## Type Aliases
@@ -48,12 +48,12 @@ This lightweight module provides strongly-typed typings and filter builders to i
 |  --- | --- |
 |  [Condition](./filter.condition.md) | Condition clause |
 |  [Direction](./filter.direction.md) | Order by direction |
-|  [Fields](./filter.fields.md) | Selection of fields<!-- -->Example: <code>{afieldname: true}</code> |
+|  [Fields](./filter.fields.md) | <p>Selection of fields</p><p>Example: <code>{afieldname: true}</code></p> |
 |  [FilterExcludingWhere](./filter.filterexcludingwhere.md) | Filter without <code>where</code> property |
 |  [InclusionFilter](./filter.inclusionfilter.md) | Inclusion filter type e.g. 'property', {<!-- -->relation: 'property'<!-- -->} |
 |  [KeyOf](./filter.keyof.md) | Key types of a given model, excluding operators |
 |  [Operators](./filter.operators.md) | Operators for where clauses |
-|  [Order](./filter.order.md) | Order by<!-- -->Example: <code>{afieldname: 'ASC'}</code> |
+|  [Order](./filter.order.md) | <p>Order by</p><p>Example: <code>{afieldname: 'ASC'}</code></p> |
 |  [PredicateComparison](./filter.predicatecomparison.md) | Matching predicate comparison |
 |  [ShortHandEqualType](./filter.shorthandequaltype.md) | Value types for <code>{propertyName: value}</code> |
 |  [Where](./filter.where.md) | Where clause |

package/site/apidocs/filter.orclause.md

@@ -32,8 +32,8 @@ export interface OrClause<MT extends object>
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [or](./filter.orclause.or.md) | [Where](./filter.where.md)<!-- -->&lt;MT&gt;\[\] |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [or](./filter.orclause.or.md) |  | [Where](./filter.where.md)<!-- -->&lt;MT&gt;\[\] |  |
 
 

package/site/apidocs/graphql.graphqlresolutioncontext.md

@@ -32,7 +32,7 @@ export declare class GraphQLResolutionContext extends Context
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [resolverClass](./graphql.graphqlresolutioncontext.resolverclass.md) |  | [Constructor](./context.constructor.md)<!-- -->&lt;unknown&gt; |  |
-|  [resolverData](./graphql.graphqlresolutioncontext.resolverdata.md) |  | ResolverData&lt;unknown&gt; |  |
+|  [resolverClass](./graphql.graphqlresolutioncontext.resolverclass.md) | <code>readonly</code> | [Constructor](./context.constructor.md)<!-- -->&lt;unknown&gt; |  |
+|  [resolverData](./graphql.graphqlresolutioncontext.resolverdata.md) | <code>readonly</code> | ResolverData&lt;unknown&gt; |  |
 
 

package/site/apidocs/graphql.graphqlserver.md

@@ -34,9 +34,9 @@ export declare class GraphQLServer extends Context implements Server
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [expressApp](./graphql.graphqlserver.expressapp.md) |  | express.Application |  |
-|  [httpServer?](./graphql.graphqlserver.httpserver.md) |  | [HttpServer](./http-server.httpserver.md) | <i>(Optional)</i> |
-|  [listening](./graphql.graphqlserver.listening.md) |  | boolean | Is the GraphQL listening |
+|  [expressApp](./graphql.graphqlserver.expressapp.md) | <code>readonly</code> | express.Application |  |
+|  [httpServer?](./graphql.graphqlserver.httpserver.md) | <code>readonly</code> | [HttpServer](./http-server.httpserver.md) | <i>(Optional)</i> |
+|  [listening](./graphql.graphqlserver.listening.md) | <code>readonly</code> | boolean | Is the GraphQL listening |
 
 ## Methods
 

package/site/apidocs/graphql.graphqlserveroptions.md

@@ -24,11 +24,11 @@ export interface GraphQLServerOptions extends HttpOptions
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [apollo?](./graphql.graphqlserveroptions.apollo.md) | ApolloServerExpressConfig | <i>(Optional)</i> ApolloServerExpress related configuration |
-|  [asMiddlewareOnly?](./graphql.graphqlserveroptions.asmiddlewareonly.md) | boolean | <i>(Optional)</i> Use as a middleware for RestServer instead of a standalone server |
-|  [expressSettings?](./graphql.graphqlserveroptions.expresssettings.md) | Record&lt;string, unknown&gt; | <i>(Optional)</i> Express settings |
-|  [middlewareOptions?](./graphql.graphqlserveroptions.middlewareoptions.md) | GetMiddlewareOptions | <i>(Optional)</i> Middleware options for GraphQL |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [apollo?](./graphql.graphqlserveroptions.apollo.md) |  | ApolloServerExpressConfig | <i>(Optional)</i> ApolloServerExpress related configuration |
+|  [asMiddlewareOnly?](./graphql.graphqlserveroptions.asmiddlewareonly.md) |  | boolean | <i>(Optional)</i> Use as a middleware for RestServer instead of a standalone server |
+|  [expressSettings?](./graphql.graphqlserveroptions.expresssettings.md) |  | Record&lt;string, unknown&gt; | <i>(Optional)</i> Express settings |
+|  [middlewareOptions?](./graphql.graphqlserveroptions.middlewareoptions.md) |  | GetMiddlewareOptions | <i>(Optional)</i> Middleware options for GraphQL |
 
 

package/site/apidocs/graphql.loopbackcontainer.md

@@ -32,7 +32,7 @@ export declare class LoopBackContainer implements ContainerType
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [ctx](./graphql.loopbackcontainer.ctx.md) |  | [Context](./context.context.md) |  |
+|  [ctx](./graphql.loopbackcontainer.ctx.md) | <code>readonly</code> | [Context](./context.context.md) |  |
 
 ## Methods
 

package/site/apidocs/http-caching-proxy.proxyoptions.md

@@ -21,12 +21,12 @@ export interface ProxyOptions
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [cachePath](./http-caching-proxy.proxyoptions.cachepath.md) | string | Directory where to keep the cached snapshots. |
-|  [logError?](./http-caching-proxy.proxyoptions.logerror.md) | boolean | <i>(Optional)</i> A flag if the error should be logged |
-|  [port?](./http-caching-proxy.proxyoptions.port.md) | number | <i>(Optional)</i> The port where the HTTP proxy should listen at. Default: 0 (let the system pick a free port) |
-|  [timeout?](./http-caching-proxy.proxyoptions.timeout.md) | number | <i>(Optional)</i> Timeout to connect to the target service |
-|  [ttl?](./http-caching-proxy.proxyoptions.ttl.md) | number | <i>(Optional)</i> How long to keep snapshots before making a new request to the backend. The value is in milliseconds.<!-- -->Default: one day |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [cachePath](./http-caching-proxy.proxyoptions.cachepath.md) |  | string | Directory where to keep the cached snapshots. |
+|  [logError?](./http-caching-proxy.proxyoptions.logerror.md) |  | boolean | <i>(Optional)</i> A flag if the error should be logged |
+|  [port?](./http-caching-proxy.proxyoptions.port.md) |  | number | <i>(Optional)</i> The port where the HTTP proxy should listen at. Default: 0 (let the system pick a free port) |
+|  [timeout?](./http-caching-proxy.proxyoptions.timeout.md) |  | number | <i>(Optional)</i> Timeout to connect to the target service |
+|  [ttl?](./http-caching-proxy.proxyoptions.ttl.md) |  | number | <p><i>(Optional)</i> How long to keep snapshots before making a new request to the backend. The value is in milliseconds.</p><p>Default: one day</p> |
 
 

package/site/apidocs/http-server.basehttpoptions.md

@@ -20,12 +20,12 @@ Base options that are common to http and https servers
 ```typescript
 export interface BaseHttpOptions extends ListenOptions, Partial<HttpServerProperties> 
 ```
-<b>Extends:</b> ListenOptions, Partial&lt;[HttpServerProperties](./http-server.httpserverproperties.md)
+<b>Extends:</b> ListenOptions, Partial&lt;[HttpServerProperties](./http-server.httpserverproperties.md)<!-- -->&gt;
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [gracePeriodForClose?](./http-server.basehttpoptions.graceperiodforclose.md) | number | <i>(Optional)</i> The <code>gracePeriodForClose</code> property controls how to stop the server gracefully. Its value is the number of milliseconds to wait before in-flight requests finish when the server is being stopped. With this setting, we also reject new requests from existing keep-alive connections in addition to stopping accepting new connections.<!-- -->Defaults to Infinity (don't force-close). If you want to immediately destroy all sockets set its value to <code>0</code>.<!-- -->See [stoppable](https://www.npmjs.com/package/stoppable) |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [gracePeriodForClose?](./http-server.basehttpoptions.graceperiodforclose.md) |  | number | <p><i>(Optional)</i> The <code>gracePeriodForClose</code> property controls how to stop the server gracefully. Its value is the number of milliseconds to wait before in-flight requests finish when the server is being stopped. With this setting, we also reject new requests from existing keep-alive connections in addition to stopping accepting new connections.</p><p>Defaults to Infinity (don't force-close). If you want to immediately destroy all sockets set its value to <code>0</code>.</p><p>See [stoppable](https://www.npmjs.com/package/stoppable)</p> |
 
 

package/site/apidocs/http-server.httpoptions.md

@@ -24,8 +24,8 @@ export interface HttpOptions extends BaseHttpOptions
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [protocol?](./http-server.httpoptions.protocol.md) | 'http' | <i>(Optional)</i> |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [protocol?](./http-server.httpoptions.protocol.md) |  | 'http' | <i>(Optional)</i> |
 
 

package/site/apidocs/http-server.httpserver.md

@@ -31,14 +31,14 @@ export declare class HttpServer
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [address](./http-server.httpserver.address.md) |  | string \| AddressInfo \| undefined | Address of the HTTP / HTTPS server |
-|  [host](./http-server.httpserver.host.md) |  | string \| undefined | Host of the HTTP / HTTPS server |
-|  [listening](./http-server.httpserver.listening.md) |  | boolean | State of the HTTP / HTTPS server |
-|  [port](./http-server.httpserver.port.md) |  | number | Port number of the HTTP / HTTPS server |
-|  [protocol](./http-server.httpserver.protocol.md) |  | [HttpProtocol](./http-server.httpprotocol.md) | Protocol of the HTTP / HTTPS server |
-|  [server](./http-server.httpserver.server.md) |  | http.Server \| https.Server |  |
-|  [serverOptions](./http-server.httpserver.serveroptions.md) |  | [HttpServerOptions](./http-server.httpserveroptions.md) |  |
-|  [url](./http-server.httpserver.url.md) |  | string | URL of the HTTP / HTTPS server |
+|  [address](./http-server.httpserver.address.md) | <code>readonly</code> | string \| AddressInfo \| undefined | Address of the HTTP / HTTPS server |
+|  [host](./http-server.httpserver.host.md) | <code>readonly</code> | string \| undefined | Host of the HTTP / HTTPS server |
+|  [listening](./http-server.httpserver.listening.md) | <code>readonly</code> | boolean | State of the HTTP / HTTPS server |
+|  [port](./http-server.httpserver.port.md) | <code>readonly</code> | number | Port number of the HTTP / HTTPS server |
+|  [protocol](./http-server.httpserver.protocol.md) | <code>readonly</code> | [HttpProtocol](./http-server.httpprotocol.md) | Protocol of the HTTP / HTTPS server |
+|  [server](./http-server.httpserver.server.md) | <code>readonly</code> | http.Server \| https.Server |  |
+|  [serverOptions](./http-server.httpserver.serveroptions.md) | <code>readonly</code> | [HttpServerOptions](./http-server.httpserveroptions.md) |  |
+|  [url](./http-server.httpserver.url.md) | <code>readonly</code> | string | URL of the HTTP / HTTPS server |
 
 ## Methods
 

package/site/apidocs/http-server.httpsoptions.md

@@ -24,8 +24,8 @@ export interface HttpsOptions extends BaseHttpOptions, https.ServerOptions
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [protocol](./http-server.httpsoptions.protocol.md) | 'https' |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [protocol](./http-server.httpsoptions.protocol.md) |  | 'https' |  |
 
 

package/site/apidocs/index.md

@@ -42,7 +42,7 @@ permalink: /doc/en/lb4/apidocs.index.html
 |  [@loopback/openapi-spec-builder](./openapi-spec-builder.md) | A package to simplify creating OpenAPI specification documents in your tests using the builder pattern. |
 |  [@loopback/openapi-v3](./openapi-v3.md) | Decorators that describe LoopBack artifacts as OpenAPI 3.0.0 metadata and utilities that transfer LoopBack metadata to OpenAPI 3.0.0 specifications. |
 |  [@loopback/pooling](./pooling.md) |  |
-|  [@loopback/repository](./repository.md) | A common set of interfaces for interacting with databases.<!-- -->This module provides data access facilities to various databases and services as well as the constructs for modeling and accessing those data. |
+|  [@loopback/repository](./repository.md) | <p>A common set of interfaces for interacting with databases.</p><p>This module provides data access facilities to various databases and services as well as the constructs for modeling and accessing those data.</p> |
 |  [@loopback/repository-json-schema](./repository-json-schema.md) | Convert a TypeScript class/model to a JSON Schema for users, leveraging LoopBack4's decorators, metadata, and reflection system. |
 |  [@loopback/repository-tests](./repository-tests.md) | A test suite verifying functionality of <code>@loopback/repository</code> in a connector -independent way. |
 |  [@loopback/rest](./rest.md) | The REST API package for loopback-next. |

package/site/apidocs/logging.winstonloggerprovider.md

@@ -20,7 +20,7 @@ A provider class that creates WinstonLogger instances
 ```typescript
 export declare class WinstonLoggerProvider implements Provider<Logger> 
 ```
-<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;Logger
+<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;Logger&gt;
 
 ## Constructors
 

package/site/apidocs/metadata.classdecoratorfactory.md

@@ -20,7 +20,7 @@ Factory for class decorators
 ```typescript
 export declare class ClassDecoratorFactory<T> extends DecoratorFactory<T, T, ClassDecorator> 
 ```
-<b>Extends:</b> [DecoratorFactory](./metadata.decoratorfactory.md)<!-- -->&lt;T, T, ClassDecorator
+<b>Extends:</b> [DecoratorFactory](./metadata.decoratorfactory.md)<!-- -->&lt;T, T, ClassDecorator&gt;
 
 ## Methods
 
@@ -28,7 +28,7 @@ export declare class ClassDecoratorFactory<T> extends DecoratorFactory<T, T, Cla
 |  --- | --- | --- |
 |  [create()](./metadata.classdecoratorfactory.create.md) |  |  |
 |  [createDecorator(key, spec, options)](./metadata.classdecoratorfactory.createdecorator.md) | <code>static</code> | Create a class decorator function |
-|  [mergeWithInherited(inheritedMetadata, target, member, descriptorOrIndex)](./metadata.classdecoratorfactory.mergewithinherited.md) |  |  |
-|  [mergeWithOwn(ownMetadata, target, member, descriptorOrIndex)](./metadata.classdecoratorfactory.mergewithown.md) |  |  |
+|  [mergeWithInherited(inheritedMetadata, target, member, descriptorOrIndex)](./metadata.classdecoratorfactory.mergewithinherited.md) | <code>protected</code> |  |
+|  [mergeWithOwn(ownMetadata, target, member, descriptorOrIndex)](./metadata.classdecoratorfactory.mergewithown.md) | <code>protected</code> |  |
 
 

package/site/apidocs/metadata.decoratorfactory.md

@@ -56,28 +56,28 @@ class MyController {}
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [decoratorName](./metadata.decoratorfactory.decoratorname.md) |  | string |  |
-|  [key](./metadata.decoratorfactory.key.md) |  | string |  |
-|  [options](./metadata.decoratorfactory.options.md) |  | [DecoratorOptions](./metadata.decoratoroptions.md) |  |
-|  [spec](./metadata.decoratorfactory.spec.md) |  | T |  |
+|  [decoratorName](./metadata.decoratorfactory.decoratorname.md) | <code>protected</code> | string |  |
+|  [key](./metadata.decoratorfactory.key.md) | <code>protected</code> | string |  |
+|  [options](./metadata.decoratorfactory.options.md) | <code>protected</code> | [DecoratorOptions](./metadata.decoratoroptions.md) |  |
+|  [spec](./metadata.decoratorfactory.spec.md) | <code>protected</code> | T |  |
 |  [TARGET](./metadata.decoratorfactory.target.md) | <code>static</code> | string | A constant to reference the target of a decoration |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [\_createDecorator(key, spec, options)](./metadata.decoratorfactory._createdecorator.md) | <code>static</code> | Create a decorator function |
-|  [allowInheritance()](./metadata.decoratorfactory.allowinheritance.md) |  |  |
+|  [\_createDecorator(key, spec, options)](./metadata.decoratorfactory._createdecorator.md) | <p><code>protected</code></p><p><code>static</code></p> | Create a decorator function |
+|  [allowInheritance()](./metadata.decoratorfactory.allowinheritance.md) | <code>protected</code> |  |
 |  [cloneDeep(val)](./metadata.decoratorfactory.clonedeep.md) | <code>static</code> |  |
 |  [create()](./metadata.decoratorfactory.create.md) |  | Create a decorator function of the given type. Each sub class MUST implement this method. |
-|  [decorate(target, member, descriptorOrIndex)](./metadata.decoratorfactory.decorate.md) |  | Base implementation of the decorator function |
-|  [duplicateDecorationError(target, member, descriptorOrIndex)](./metadata.decoratorfactory.duplicatedecorationerror.md) |  | Create an error to report if the decorator is applied to the target more than once |
+|  [decorate(target, member, descriptorOrIndex)](./metadata.decoratorfactory.decorate.md) | <code>protected</code> | Base implementation of the decorator function |
+|  [duplicateDecorationError(target, member, descriptorOrIndex)](./metadata.decoratorfactory.duplicatedecorationerror.md) | <code>protected</code> | Create an error to report if the decorator is applied to the target more than once |
 |  [getNumberOfParameters(target, member)](./metadata.decoratorfactory.getnumberofparameters.md) | <code>static</code> | Get the number of parameters for a given constructor or method |
 |  [getTarget(spec)](./metadata.decoratorfactory.gettarget.md) |  | Get the optional decoration target of a given spec |
 |  [getTargetName(target, member, descriptorOrIndex)](./metadata.decoratorfactory.gettargetname.md) | <code>static</code> | Get the qualified name of a decoration target. |
-|  [inherit(inheritedMetadata)](./metadata.decoratorfactory.inherit.md) |  | Inherit metadata from base classes. By default, this method merges base metadata into the spec if <code>allowInheritance</code> is set to <code>true</code>. To customize the behavior, this method can be overridden by sub classes. |
-|  [mergeWithInherited(inheritedMetadata, target, member, descriptorOrIndex)](./metadata.decoratorfactory.mergewithinherited.md) |  | This method is called by the default implementation of the decorator function to merge the spec argument from the decoration with the inherited metadata for a class, all properties, all methods, or all method parameters that are decorated by this decorator.<!-- -->It MUST be overridden by subclasses to process inherited metadata. |
-|  [mergeWithOwn(ownMetadata, target, member, descriptorOrIndex)](./metadata.decoratorfactory.mergewithown.md) |  | This method is called by the default implementation of the decorator function to merge the spec argument from the decoration with the own metadata for a class, all properties, all methods, or all method parameters that are decorated by this decorator.<!-- -->It MUST be overridden by subclasses to process own metadata. |
+|  [inherit(inheritedMetadata)](./metadata.decoratorfactory.inherit.md) | <code>protected</code> | Inherit metadata from base classes. By default, this method merges base metadata into the spec if <code>allowInheritance</code> is set to <code>true</code>. To customize the behavior, this method can be overridden by sub classes. |
+|  [mergeWithInherited(inheritedMetadata, target, member, descriptorOrIndex)](./metadata.decoratorfactory.mergewithinherited.md) | <code>protected</code> | <p>This method is called by the default implementation of the decorator function to merge the spec argument from the decoration with the inherited metadata for a class, all properties, all methods, or all method parameters that are decorated by this decorator.</p><p>It MUST be overridden by subclasses to process inherited metadata.</p> |
+|  [mergeWithOwn(ownMetadata, target, member, descriptorOrIndex)](./metadata.decoratorfactory.mergewithown.md) | <code>protected</code> | <p>This method is called by the default implementation of the decorator function to merge the spec argument from the decoration with the own metadata for a class, all properties, all methods, or all method parameters that are decorated by this decorator.</p><p>It MUST be overridden by subclasses to process own metadata.</p> |
 |  [withTarget(spec, target)](./metadata.decoratorfactory.withtarget.md) |  | Set a reference to the target class or prototype for a given spec if it's an object |
 
 

package/site/apidocs/metadata.decoratoroptions.md

@@ -23,10 +23,10 @@ export interface DecoratorOptions
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [allowInheritance?](./metadata.decoratoroptions.allowinheritance.md) | boolean | <i>(Optional)</i> Controls if inherited metadata will be honored. Default to <code>true</code>. |
-|  [cloneInputSpec?](./metadata.decoratoroptions.cloneinputspec.md) | boolean | <i>(Optional)</i> Controls if the value of <code>spec</code> argument will be cloned. Sometimes we use shared spec for the decoration, but the decorator function might need to mutate the object. Cloning the input spec makes it safe to use the same spec (<code>template</code>) to decorate different members.<!-- -->Default to <code>true</code>. |
-|  [decoratorName?](./metadata.decoratoroptions.decoratorname.md) | string | <i>(Optional)</i> Name of the decorator for debugging purpose, such as <code>@inject</code> |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [allowInheritance?](./metadata.decoratoroptions.allowinheritance.md) |  | boolean | <i>(Optional)</i> Controls if inherited metadata will be honored. Default to <code>true</code>. |
+|  [cloneInputSpec?](./metadata.decoratoroptions.cloneinputspec.md) |  | boolean | <p><i>(Optional)</i> Controls if the value of <code>spec</code> argument will be cloned. Sometimes we use shared spec for the decoration, but the decorator function might need to mutate the object. Cloning the input spec makes it safe to use the same spec (<code>template</code>) to decorate different members.</p><p>Default to <code>true</code>.</p> |
+|  [decoratorName?](./metadata.decoratoroptions.decoratorname.md) |  | string | <i>(Optional)</i> Name of the decorator for debugging purpose, such as <code>@inject</code> |
 
 

package/site/apidocs/metadata.designtimemethodmetadata.md

@@ -45,10 +45,10 @@ The `myMethod` above has design-time metadata as follows:
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [parameterTypes](./metadata.designtimemethodmetadata.parametertypes.md) | Function\[\] | An array of parameter types. |
-|  [returnType](./metadata.designtimemethodmetadata.returntype.md) | Function \| undefined | Return type, may be <code>undefined</code> (e.g. for constructors). |
-|  [type](./metadata.designtimemethodmetadata.type.md) | Function \| undefined | Type of the method itself. It is <code>Function</code> for methods, <code>undefined</code> for the constructor. |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [parameterTypes](./metadata.designtimemethodmetadata.parametertypes.md) |  | Function\[\] | An array of parameter types. |
+|  [returnType](./metadata.designtimemethodmetadata.returntype.md) |  | Function \| undefined | Return type, may be <code>undefined</code> (e.g. for constructors). |
+|  [type](./metadata.designtimemethodmetadata.type.md) |  | Function \| undefined | Type of the method itself. It is <code>Function</code> for methods, <code>undefined</code> for the constructor. |
 
 

package/site/apidocs/metadata.inspectionoptions.md

@@ -23,8 +23,8 @@ export interface InspectionOptions
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [ownMetadataOnly?](./metadata.inspectionoptions.ownmetadataonly.md) | boolean | <i>(Optional)</i> Only inspect own metadata of a given target. The prototype chain will not be checked. The implementation uses <code>Reflect.getOwnMetadata()</code> if the flag is set to <code>true</code>. Otherwise, it uses <code>Reflect.getMetadata()</code>.<!-- -->The flag is <code>false</code> by default for <code>MetadataInspector</code>. |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [ownMetadataOnly?](./metadata.inspectionoptions.ownmetadataonly.md) |  | boolean | <p><i>(Optional)</i> Only inspect own metadata of a given target. The prototype chain will not be checked. The implementation uses <code>Reflect.getOwnMetadata()</code> if the flag is set to <code>true</code>. Otherwise, it uses <code>Reflect.getMetadata()</code>.</p><p>The flag is <code>false</code> by default for <code>MetadataInspector</code>.</p> |
 
 

package/site/apidocs/metadata.metadataaccessor.md

@@ -25,7 +25,7 @@ export declare class MetadataAccessor<T, D extends DecoratorType = DecoratorType
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [key](./metadata.metadataaccessor.key.md) |  | string |  |
+|  [key](./metadata.metadataaccessor.key.md) | <code>readonly</code> | string |  |
 
 ## Methods
 

package/site/apidocs/metadata.metadatainspector.md

@@ -25,8 +25,8 @@ export declare class MetadataInspector
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [DesignTimeReflector](./metadata.metadatainspector.designtimereflector.md) | <code>static</code> | [NamespacedReflect](./metadata.namespacedreflect.md) | Expose the reflector for TypeScript design-time metadata |
-|  [Reflector](./metadata.metadatainspector.reflector.md) | <code>static</code> | [NamespacedReflect](./metadata.namespacedreflect.md) | Expose Reflector, which is a wrapper of <code>Reflect</code> and it uses <code>loopback</code> as the namespace prefix for all metadata keys |
+|  [DesignTimeReflector](./metadata.metadatainspector.designtimereflector.md) | <p><code>readonly</code></p><p><code>static</code></p> | [NamespacedReflect](./metadata.namespacedreflect.md) | Expose the reflector for TypeScript design-time metadata |
+|  [Reflector](./metadata.metadatainspector.reflector.md) | <p><code>readonly</code></p><p><code>static</code></p> | [NamespacedReflect](./metadata.namespacedreflect.md) | Expose Reflector, which is a wrapper of <code>Reflect</code> and it uses <code>loopback</code> as the namespace prefix for all metadata keys |
 
 ## Methods
 

package/site/apidocs/metadata.methoddecoratorfactory.md

@@ -20,7 +20,7 @@ Factory for method decorators
 ```typescript
 export declare class MethodDecoratorFactory<T> extends DecoratorFactory<T, MetadataMap<T>, MethodDecorator> 
 ```
-<b>Extends:</b> [DecoratorFactory](./metadata.decoratorfactory.md)<!-- -->&lt;T, [MetadataMap](./metadata.metadatamap.md)<!-- -->&lt;T&gt;, MethodDecorator
+<b>Extends:</b> [DecoratorFactory](./metadata.decoratorfactory.md)<!-- -->&lt;T, [MetadataMap](./metadata.metadatamap.md)<!-- -->&lt;T&gt;, MethodDecorator&gt;
 
 ## Methods
 
@@ -28,7 +28,7 @@ export declare class MethodDecoratorFactory<T> extends DecoratorFactory<T, Metad
 |  --- | --- | --- |
 |  [create()](./metadata.methoddecoratorfactory.create.md) |  |  |
 |  [createDecorator(key, spec, options)](./metadata.methoddecoratorfactory.createdecorator.md) | <code>static</code> | Create a method decorator function |
-|  [mergeWithInherited(inheritedMetadata, target, methodName, methodDescriptor)](./metadata.methoddecoratorfactory.mergewithinherited.md) |  |  |
-|  [mergeWithOwn(ownMetadata, target, methodName, methodDescriptor)](./metadata.methoddecoratorfactory.mergewithown.md) |  |  |
+|  [mergeWithInherited(inheritedMetadata, target, methodName, methodDescriptor)](./metadata.methoddecoratorfactory.mergewithinherited.md) | <code>protected</code> |  |
+|  [mergeWithOwn(ownMetadata, target, methodName, methodDescriptor)](./metadata.methoddecoratorfactory.mergewithown.md) | <code>protected</code> |  |
 
 

package/site/apidocs/metadata.methodmultidecoratorfactory.md

@@ -20,7 +20,7 @@ Factory for an append-array of method-level decorators The `@response` metadata
 ```typescript
 export declare class MethodMultiDecoratorFactory<T> extends MethodDecoratorFactory<T[]> 
 ```
-<b>Extends:</b> [MethodDecoratorFactory](./metadata.methoddecoratorfactory.md)
+<b>Extends:</b> [MethodDecoratorFactory](./metadata.methoddecoratorfactory.md)<!-- -->&lt;T\[\]&gt;
 
 ## Example
 
@@ -43,7 +43,7 @@ The factory creates and updates an array of items T\[\], and the getter provides
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [mergeWithInherited(inheritedMetadata, target, methodName)](./metadata.methodmultidecoratorfactory.mergewithinherited.md) |  |  |
-|  [mergeWithOwn(ownMetadata, target, methodName, methodDescriptor)](./metadata.methodmultidecoratorfactory.mergewithown.md) |  |  |
+|  [mergeWithInherited(inheritedMetadata, target, methodName)](./metadata.methodmultidecoratorfactory.mergewithinherited.md) | <code>protected</code> |  |
+|  [mergeWithOwn(ownMetadata, target, methodName, methodDescriptor)](./metadata.methodmultidecoratorfactory.mergewithown.md) | <code>protected</code> |  |
 
 

package/site/apidocs/metadata.methodparameterdecoratorfactory.md

@@ -20,7 +20,7 @@ Factory for method level parameter decorator.
 ```typescript
 export declare class MethodParameterDecoratorFactory<T> extends DecoratorFactory<T, MetadataMap<T[]>, MethodDecorator> 
 ```
-<b>Extends:</b> [DecoratorFactory](./metadata.decoratorfactory.md)<!-- -->&lt;T, [MetadataMap](./metadata.metadatamap.md)<!-- -->&lt;T\[\]&gt;, MethodDecorator
+<b>Extends:</b> [DecoratorFactory](./metadata.decoratorfactory.md)<!-- -->&lt;T, [MetadataMap](./metadata.metadatamap.md)<!-- -->&lt;T\[\]&gt;, MethodDecorator&gt;
 
 ## Example
 
@@ -40,7 +40,7 @@ class MyController {
 |  --- | --- | --- |
 |  [create()](./metadata.methodparameterdecoratorfactory.create.md) |  |  |
 |  [createDecorator(key, spec, options)](./metadata.methodparameterdecoratorfactory.createdecorator.md) | <code>static</code> | Create a method decorator function |
-|  [mergeWithInherited(inheritedMetadata, target, methodName, methodDescriptor)](./metadata.methodparameterdecoratorfactory.mergewithinherited.md) |  |  |
-|  [mergeWithOwn(ownMetadata, target, methodName, methodDescriptor)](./metadata.methodparameterdecoratorfactory.mergewithown.md) |  |  |
+|  [mergeWithInherited(inheritedMetadata, target, methodName, methodDescriptor)](./metadata.methodparameterdecoratorfactory.mergewithinherited.md) | <code>protected</code> |  |
+|  [mergeWithOwn(ownMetadata, target, methodName, methodDescriptor)](./metadata.methodparameterdecoratorfactory.mergewithown.md) | <code>protected</code> |  |
 
 

package/site/apidocs/metadata.parameterdecoratorfactory.md

@@ -20,7 +20,7 @@ Factory for parameter decorators
 ```typescript
 export declare class ParameterDecoratorFactory<T> extends DecoratorFactory<T, MetadataMap<T[]>, ParameterDecorator> 
 ```
-<b>Extends:</b> [DecoratorFactory](./metadata.decoratorfactory.md)<!-- -->&lt;T, [MetadataMap](./metadata.metadatamap.md)<!-- -->&lt;T\[\]&gt;, ParameterDecorator
+<b>Extends:</b> [DecoratorFactory](./metadata.decoratorfactory.md)<!-- -->&lt;T, [MetadataMap](./metadata.metadatamap.md)<!-- -->&lt;T\[\]&gt;, ParameterDecorator&gt;
 
 ## Methods
 
@@ -28,7 +28,7 @@ export declare class ParameterDecoratorFactory<T> extends DecoratorFactory<T, Me
 |  --- | --- | --- |
 |  [create()](./metadata.parameterdecoratorfactory.create.md) |  |  |
 |  [createDecorator(key, spec, options)](./metadata.parameterdecoratorfactory.createdecorator.md) | <code>static</code> | Create a parameter decorator function |
-|  [mergeWithInherited(inheritedMetadata, target, methodName, parameterIndex)](./metadata.parameterdecoratorfactory.mergewithinherited.md) |  |  |
-|  [mergeWithOwn(ownMetadata, target, methodName, parameterIndex)](./metadata.parameterdecoratorfactory.mergewithown.md) |  |  |
+|  [mergeWithInherited(inheritedMetadata, target, methodName, parameterIndex)](./metadata.parameterdecoratorfactory.mergewithinherited.md) | <code>protected</code> |  |
+|  [mergeWithOwn(ownMetadata, target, methodName, parameterIndex)](./metadata.parameterdecoratorfactory.mergewithown.md) | <code>protected</code> |  |
 
 

package/site/apidocs/metadata.propertydecoratorfactory.md

@@ -20,7 +20,7 @@ Factory for property decorators
 ```typescript
 export declare class PropertyDecoratorFactory<T> extends DecoratorFactory<T, MetadataMap<T>, PropertyDecorator> 
 ```
-<b>Extends:</b> [DecoratorFactory](./metadata.decoratorfactory.md)<!-- -->&lt;T, [MetadataMap](./metadata.metadatamap.md)<!-- -->&lt;T&gt;, PropertyDecorator
+<b>Extends:</b> [DecoratorFactory](./metadata.decoratorfactory.md)<!-- -->&lt;T, [MetadataMap](./metadata.metadatamap.md)<!-- -->&lt;T&gt;, PropertyDecorator&gt;
 
 ## Methods
 
@@ -28,7 +28,7 @@ export declare class PropertyDecoratorFactory<T> extends DecoratorFactory<T, Met
 |  --- | --- | --- |
 |  [create()](./metadata.propertydecoratorfactory.create.md) |  |  |
 |  [createDecorator(key, spec, options)](./metadata.propertydecoratorfactory.createdecorator.md) | <code>static</code> | Create a property decorator function |
-|  [mergeWithInherited(inheritedMetadata, target, propertyName, descriptorOrIndex)](./metadata.propertydecoratorfactory.mergewithinherited.md) |  |  |
-|  [mergeWithOwn(ownMetadata, target, propertyName, descriptorOrParameterIndex)](./metadata.propertydecoratorfactory.mergewithown.md) |  |  |
+|  [mergeWithInherited(inheritedMetadata, target, propertyName, descriptorOrIndex)](./metadata.propertydecoratorfactory.mergewithinherited.md) | <code>protected</code> |  |
+|  [mergeWithOwn(ownMetadata, target, propertyName, descriptorOrParameterIndex)](./metadata.propertydecoratorfactory.mergewithown.md) | <code>protected</code> |  |
 
 

package/site/apidocs/metrics.metricsoptions.md

@@ -23,12 +23,12 @@ export interface MetricsOptions
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [defaultLabels?](./metrics.metricsoptions.defaultlabels.md) | { \[labelName: string\]: string; } | <i>(Optional)</i> |
-|  [defaultMetrics?](./metrics.metricsoptions.defaultmetrics.md) | { disabled?: boolean; } &amp; DefaultMetricsCollectorConfiguration | <i>(Optional)</i> |
-|  [endpoint?](./metrics.metricsoptions.endpoint.md) | { disabled?: boolean; basePath?: string; } | <i>(Optional)</i> |
-|  [openApiSpec?](./metrics.metricsoptions.openapispec.md) | boolean | <i>(Optional)</i> |
-|  [pushGateway?](./metrics.metricsoptions.pushgateway.md) | { disabled?: boolean; url: string; interval?: number; jobName?: string; groupingKey?: { \[key: string\]: string; }; replaceAll?: boolean; } | <i>(Optional)</i> |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [defaultLabels?](./metrics.metricsoptions.defaultlabels.md) |  | { \[labelName: string\]: string; } | <i>(Optional)</i> |
+|  [defaultMetrics?](./metrics.metricsoptions.defaultmetrics.md) |  | { disabled?: boolean; } &amp; DefaultMetricsCollectorConfiguration | <i>(Optional)</i> |
+|  [endpoint?](./metrics.metricsoptions.endpoint.md) |  | { disabled?: boolean; basePath?: string; } | <i>(Optional)</i> |
+|  [openApiSpec?](./metrics.metricsoptions.openapispec.md) |  | boolean | <i>(Optional)</i> |
+|  [pushGateway?](./metrics.metricsoptions.pushgateway.md) |  | { disabled?: boolean; url: string; interval?: number; jobName?: string; groupingKey?: { \[key: string\]: string; }; replaceAll?: boolean; } | <i>(Optional)</i> |
 
 

package/site/apidocs/mock-oauth2-provider.myuser.md

@@ -23,15 +23,15 @@ export interface MyUser
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [email?](./mock-oauth2-provider.myuser.email.md) | string | <i>(Optional)</i> |
-|  [firstName?](./mock-oauth2-provider.myuser.firstname.md) | string | <i>(Optional)</i> |
-|  [id](./mock-oauth2-provider.myuser.id.md) | string |  |
-|  [lastName?](./mock-oauth2-provider.myuser.lastname.md) | string | <i>(Optional)</i> |
-|  [password?](./mock-oauth2-provider.myuser.password.md) | string | <i>(Optional)</i> |
-|  [signingKey](./mock-oauth2-provider.myuser.signingkey.md) | string |  |
-|  [token?](./mock-oauth2-provider.myuser.token.md) | string | <i>(Optional)</i> |
-|  [username?](./mock-oauth2-provider.myuser.username.md) | string | <i>(Optional)</i> |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [email?](./mock-oauth2-provider.myuser.email.md) |  | string | <i>(Optional)</i> |
+|  [firstName?](./mock-oauth2-provider.myuser.firstname.md) |  | string | <i>(Optional)</i> |
+|  [id](./mock-oauth2-provider.myuser.id.md) |  | string |  |
+|  [lastName?](./mock-oauth2-provider.myuser.lastname.md) |  | string | <i>(Optional)</i> |
+|  [password?](./mock-oauth2-provider.myuser.password.md) |  | string | <i>(Optional)</i> |
+|  [signingKey](./mock-oauth2-provider.myuser.signingkey.md) |  | string |  |
+|  [token?](./mock-oauth2-provider.myuser.token.md) |  | string | <i>(Optional)</i> |
+|  [username?](./mock-oauth2-provider.myuser.username.md) |  | string | <i>(Optional)</i> |
 
 

package/site/apidocs/model-api-builder.modelapibuilder.md

@@ -23,9 +23,9 @@ export interface ModelApiBuilder
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [pattern](./model-api-builder.modelapibuilder.pattern.md) | string |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [pattern](./model-api-builder.modelapibuilder.pattern.md) | <code>readonly</code> | string |  |
 
 ## Methods
 

package/site/apidocs/openapi-spec-builder.builderbase.md

@@ -29,7 +29,7 @@ export declare class BuilderBase<T extends ISpecificationExtension>
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [\_spec](./openapi-spec-builder.builderbase._spec.md) |  | T |  |
+|  [\_spec](./openapi-spec-builder.builderbase._spec.md) | <code>protected</code> | T |  |
 
 ## Methods
 

package/site/apidocs/openapi-spec-builder.componentsspecbuilder.md

@@ -20,7 +20,7 @@ A builder for creating ComponentsObject specifications.
 ```typescript
 export declare class ComponentsSpecBuilder extends BuilderBase<ComponentsObject> 
 ```
-<b>Extends:</b> [BuilderBase](./openapi-spec-builder.builderbase.md)<!-- -->&lt;ComponentsObject
+<b>Extends:</b> [BuilderBase](./openapi-spec-builder.builderbase.md)<!-- -->&lt;ComponentsObject&gt;
 
 ## Constructors
 

package/site/apidocs/openapi-spec-builder.openapispecbuilder.md

@@ -20,7 +20,7 @@ A builder for creating OpenApiSpec documents.
 ```typescript
 export declare class OpenApiSpecBuilder extends BuilderBase<OpenAPIObject> 
 ```
-<b>Extends:</b> [BuilderBase](./openapi-spec-builder.builderbase.md)<!-- -->&lt;OpenAPIObject
+<b>Extends:</b> [BuilderBase](./openapi-spec-builder.builderbase.md)<!-- -->&lt;OpenAPIObject&gt;
 
 ## Constructors
 

package/site/apidocs/openapi-spec-builder.operationspecbuilder.md

@@ -20,7 +20,7 @@ A builder for creating OperationObject specifications.
 ```typescript
 export declare class OperationSpecBuilder extends BuilderBase<OperationObject> 
 ```
-<b>Extends:</b> [BuilderBase](./openapi-spec-builder.builderbase.md)<!-- -->&lt;OperationObject
+<b>Extends:</b> [BuilderBase](./openapi-spec-builder.builderbase.md)<!-- -->&lt;OperationObject&gt;
 
 ## Constructors
 

package/site/apidocs/openapi-v3.controllerspec.md

@@ -21,10 +21,10 @@ export interface ControllerSpec
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [basePath?](./openapi-v3.controllerspec.basepath.md) | string | <i>(Optional)</i> The base path on which the Controller API is served. If it is not included, the API is served directly under the host. The value MUST start with a leading slash (/). |
-|  [components?](./openapi-v3.controllerspec.components.md) | ComponentsObject | <i>(Optional)</i> OpenAPI components.schemas generated from model metadata |
-|  [paths](./openapi-v3.controllerspec.paths.md) | PathObject | The available paths and operations for the API. |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [basePath?](./openapi-v3.controllerspec.basepath.md) |  | string | <i>(Optional)</i> The base path on which the Controller API is served. If it is not included, the API is served directly under the host. The value MUST start with a leading slash (/). |
+|  [components?](./openapi-v3.controllerspec.components.md) |  | ComponentsObject | <i>(Optional)</i> OpenAPI components.schemas generated from model metadata |
+|  [paths](./openapi-v3.controllerspec.paths.md) |  | PathObject | The available paths and operations for the API. |