@loopback/docs 5.0.0 → 5.1.2

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

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

@@ -20,7 +20,7 @@ You can optionally mark all controllers in a class as deprecated, but use `@depr
 <b>Signature:</b>
 
 ```typescript
-export declare function deprecated(isDeprecated?: boolean): (target: any, method?: string | undefined, methodDescriptor?: TypedPropertyDescriptor<any> | undefined) => any;
+export declare function deprecated(isDeprecated?: boolean): (target: any, method?: string, methodDescriptor?: TypedPropertyDescriptor<any>) => any;
 ```
 
 ## Parameters
@@ -31,7 +31,7 @@ export declare function deprecated(isDeprecated?: boolean): (target: any, method
 
 <b>Returns:</b>
 
-(target: any, method?: string \| undefined, methodDescriptor?: TypedPropertyDescriptor&lt;any&gt; \| undefined) =&gt; any
+(target: any, method?: string, methodDescriptor?: TypedPropertyDescriptor&lt;any&gt;) =&gt; any
 
 ## Example
 

package/site/apidocs/openapi-v3.md

@@ -25,7 +25,7 @@ Functions for more artifacts will be added when needed.
 
 |  Class | Description |
 |  --- | --- |
-|  [OASEnhancerService](./openapi-v3.oasenhancerservice.md) | An extension point for OpenAPI Spec enhancement This service is used for enhancing an OpenAPI spec by loading and applying one or more registered enhancers.<!-- -->A typical use of it would be generating the OpenAPI spec for the endpoints on a server in the <code>@loopback/rest</code> module. |
+|  [OASEnhancerService](./openapi-v3.oasenhancerservice.md) | <p>An extension point for OpenAPI Spec enhancement This service is used for enhancing an OpenAPI spec by loading and applying one or more registered enhancers.</p><p>A typical use of it would be generating the OpenAPI spec for the endpoints on a server in the <code>@loopback/rest</code> module.</p> |
 
 ## Enumerations
 
@@ -37,28 +37,28 @@ Functions for more artifacts will be added when needed.
 
 |  Function | Description |
 |  --- | --- |
-|  [api(spec)](./openapi-v3.api.md) | Decorate the given Controller constructor with metadata describing the HTTP/REST API the Controller implements/provides.<code>@api</code> can be applied to controller classes. |
+|  [api(spec)](./openapi-v3.api.md) | <p>Decorate the given Controller constructor with metadata describing the HTTP/REST API the Controller implements/provides.</p><p><code>@api</code> can be applied to controller classes.</p> |
 |  [createEmptyApiSpec()](./openapi-v3.createemptyapispec.md) | Create an empty OpenApiSpec object that's still a valid openapi document. |
 |  [del(path, spec)](./openapi-v3.del.md) | Expose a Controller method as a REST API operation mapped to <code>DELETE</code> request method. |
-|  [deprecated(isDeprecated)](./openapi-v3.deprecated.md) | Marks an api path as deprecated. When applied to a class, this decorator marks all paths as deprecated.<!-- -->You can optionally mark all controllers in a class as deprecated, but use <code>@deprecated(false)</code> on a specific method to ensure it is not marked as deprecated in the specification. |
+|  [deprecated(isDeprecated)](./openapi-v3.deprecated.md) | <p>Marks an api path as deprecated. When applied to a class, this decorator marks all paths as deprecated.</p><p>You can optionally mark all controllers in a class as deprecated, but use <code>@deprecated(false)</code> on a specific method to ensure it is not marked as deprecated in the specification.</p> |
 |  [get(path, spec)](./openapi-v3.get.md) | Expose a Controller method as a REST API operation mapped to <code>GET</code> request method. |
 |  [getControllerSpec(constructor)](./openapi-v3.getcontrollerspec.md) | Get the controller spec for the given class |
-|  [getFilterSchemaFor(modelCtor, options)](./openapi-v3.getfilterschemafor.md) | Build an OpenAPI schema describing the format of the "filter" object used to query model instances.<!-- -->Note we don't take the model properties into account yet and return a generic json schema allowing any "where" condition. |
+|  [getFilterSchemaFor(modelCtor, options)](./openapi-v3.getfilterschemafor.md) | <p>Build an OpenAPI schema describing the format of the "filter" object used to query model instances.</p><p>Note we don't take the model properties into account yet and return a generic json schema allowing any "where" condition.</p> |
 |  [getModelSchemaRef(modelCtor, options)](./openapi-v3.getmodelschemaref.md) | Describe the provided Model as a reference to a definition shared by multiple endpoints. The definition is included in the returned schema. |
-|  [getWhereSchemaFor(modelCtor)](./openapi-v3.getwhereschemafor.md) | Build a OpenAPI schema describing the format of the "where" object used to filter model instances to query, update or delete.<!-- -->Note we don't take the model properties into account yet and return a generic json schema allowing any "where" condition. |
+|  [getWhereSchemaFor(modelCtor)](./openapi-v3.getwhereschemafor.md) | <p>Build a OpenAPI schema describing the format of the "where" object used to filter model instances to query, update or delete.</p><p>Note we don't take the model properties into account yet and return a generic json schema allowing any "where" condition.</p> |
 |  [jsonOrBooleanToJSON(jsonOrBool)](./openapi-v3.jsonorbooleantojson.md) | Helper function used to interpret boolean values as JSON Schemas. See http://json-schema.org/draft-06/json-schema-release-notes.html |
 |  [jsonToSchemaObject(json, visited)](./openapi-v3.jsontoschemaobject.md) | Converts JSON Schemas into a SchemaObject |
-|  [mergeOpenAPISpec(currentSpec, patchSpec)](./openapi-v3.mergeopenapispec.md) | The default merge function to patch the current OpenAPI spec. It leverages module <code>json-merge-patch</code>'s merge API to merge two json objects. It returns a new merged object without modifying the original one.<!-- -->A list of merging rules can be found in test file: https://github.com/pierreinglebert/json-merge-patch/blob/master/test/lib/merge.js |
+|  [mergeOpenAPISpec(currentSpec, patchSpec)](./openapi-v3.mergeopenapispec.md) | <p>The default merge function to patch the current OpenAPI spec. It leverages module <code>json-merge-patch</code>'s merge API to merge two json objects. It returns a new merged object without modifying the original one.</p><p>A list of merging rules can be found in test file: https://github.com/pierreinglebert/json-merge-patch/blob/master/test/lib/merge.js</p> |
 |  [mergeSecuritySchemeToSpec(spec, schemeName, schemeSpec)](./openapi-v3.mergesecurityschemetospec.md) | Security scheme merge helper function to patch the current OpenAPI spec. It provides a direct route to add a security schema to the specs components. It returns a new merged object without modifying the original one. |
 |  [operation(verb, path, spec)](./openapi-v3.operation.md) | Expose a Controller method as a REST API operation. |
-|  [param(paramSpec)](./openapi-v3.param.md) | Describe an input parameter of a Controller method.<code>@param</code> must be applied to parameters. |
+|  [param(paramSpec)](./openapi-v3.param.md) | <p>Describe an input parameter of a Controller method.</p><p><code>@param</code> must be applied to parameters.</p> |
 |  [patch(path, spec)](./openapi-v3.patch.md) | Expose a Controller method as a REST API operation mapped to <code>PATCH</code> request method. |
 |  [post(path, spec)](./openapi-v3.post.md) | Expose a Controller method as a REST API operation mapped to <code>POST</code> request method. |
 |  [put(path, spec)](./openapi-v3.put.md) | Expose a Controller method as a REST API operation mapped to <code>PUT</code> request method. |
-|  [requestBody(requestBodySpec)](./openapi-v3.requestbody.md) | Describe the request body of a Controller method parameter.<!-- -->A typical OpenAPI requestBody spec contains property: - <code>description</code> - <code>required</code> - <code>content</code>. |
+|  [requestBody(requestBodySpec)](./openapi-v3.requestbody.md) | <p>Describe the request body of a Controller method parameter.</p><p>A typical OpenAPI requestBody spec contains property: - <code>description</code> - <code>required</code> - <code>content</code>.</p> |
 |  [response(responseCode, responseModelOrSpec)](./openapi-v3.response.md) | Add response object to a path spec. |
 |  [tags(tagNames)](./openapi-v3.tags.md) | Add tags for an endpoint. When applied to a class, this decorator adds the tags to all endpoints. |
-|  [visibility(visibilityType)](./openapi-v3.visibility.md) | Marks an api path with the specfied visibility. When applied to a class, this decorator marks all paths with the specified visibility.<!-- -->You can optionally mark all controllers in a class with <code>@visibility('undocumented')</code>, but use <code>@visibility('documented')</code> on a specific method to ensure it is not marked as <code>undocumented</code>. |
+|  [visibility(visibilityType)](./openapi-v3.visibility.md) | <p>Marks an api path with the specfied visibility. When applied to a class, this decorator marks all paths with the specified visibility.</p><p>You can optionally mark all controllers in a class with <code>@visibility('undocumented')</code>, but use <code>@visibility('documented')</code> on a specific method to ensure it is not marked as <code>undocumented</code>.</p> |
 
 ## Interfaces
 

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

@@ -23,9 +23,9 @@ export interface OASEnhancer
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [name](./openapi-v3.oasenhancer.name.md) | string |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [name](./openapi-v3.oasenhancer.name.md) |  | string |  |
 
 ## Methods
 

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

@@ -33,7 +33,7 @@ export declare class OASEnhancerService
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [options?](./openapi-v3.oasenhancerservice.options.md) |  | [OASEnhancerServiceOptions](./openapi-v3.oasenhancerserviceoptions.md) \| undefined | <i>(Optional)</i> An extension point should be able to receive its options via dependency injection. |
+|  [options?](./openapi-v3.oasenhancerservice.options.md) | <code>readonly</code> | [OASEnhancerServiceOptions](./openapi-v3.oasenhancerserviceoptions.md) \| undefined | <i>(Optional)</i> An extension point should be able to receive its options via dependency injection. |
 |  [spec](./openapi-v3.oasenhancerservice.spec.md) |  | [OpenApiSpec](./openapi-v3.openapispec.md) | Getter for <code>_spec</code> |
 
 ## Methods

package/site/apidocs/openapi-v3.param.query.md

@@ -31,7 +31,7 @@ query: {
         date: (name: string, spec?: Partial<ParameterObject> | undefined) => (target: object, member: string, index: number) => void;
         dateTime: (name: string, spec?: Partial<ParameterObject> | undefined) => (target: object, member: string, index: number) => void;
         password: (name: string, spec?: Partial<ParameterObject> | undefined) => (target: object, member: string, index: number) => void;
-        object: (name: string, schema?: SchemaObject | ReferenceObject, spec?: Partial<ParameterObject> | undefined) => (target: object, member: string, index: number) => void;
+        object: (name: string, schema?: SchemaObject | ReferenceObject, spec?: Partial<ParameterObject>) => (target: object, member: string, index: number) => void;
     }
 ```
 

package/site/apidocs/openapi-v3.requestbody.array.md

@@ -19,9 +19,9 @@ Define a requestBody of `array` type.
 
 ```typescript
 array: (itemSpec: SchemaObject | ReferenceObject, properties?: {
-        description?: string | undefined;
-        required?: boolean | undefined;
-    } | undefined) => (target: object, member: string, index: number) => void
+        description?: string;
+        required?: boolean;
+    }) => (target: object, member: string, index: number) => void
 ```
 
 ## Example

package/site/apidocs/openapi-v3.requestbody.file.md

@@ -21,9 +21,9 @@ Define a requestBody of `file` type. This is used to support multipart/form-data
 
 ```typescript
 file: (properties?: {
-        description?: string | undefined;
-        required?: boolean | undefined;
-    } | undefined) => (target: object, member: string, index: number) => void
+        description?: string;
+        required?: boolean;
+    }) => (target: object, member: string, index: number) => void
 ```
 
 ## Example

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

@@ -24,6 +24,6 @@ export declare namespace requestBody
 |  Variable | Description |
 |  --- | --- |
 |  [array](./openapi-v3.requestbody.array.md) | Define a requestBody of <code>array</code> type. |
-|  [file](./openapi-v3.requestbody.file.md) | Define a requestBody of <code>file</code> type. This is used to support multipart/form-data based file upload. Use <code>@requestBody</code> for other content types.[OpenAPI file upload](https://swagger.io/docs/specification/describing-request-body/file-upload) |
+|  [file](./openapi-v3.requestbody.file.md) | <p>Define a requestBody of <code>file</code> type. This is used to support multipart/form-data based file upload. Use <code>@requestBody</code> for other content types.</p><p>[OpenAPI file upload](https://swagger.io/docs/specification/describing-request-body/file-upload)</p> |
 
 

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

@@ -21,11 +21,11 @@ export interface ResponseDecoratorMetadataItem
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [contentType](./openapi-v3.responsedecoratormetadataitem.contenttype.md) | string |  |
-|  [description](./openapi-v3.responsedecoratormetadataitem.description.md) | string |  |
-|  [responseCode](./openapi-v3.responsedecoratormetadataitem.responsecode.md) | number |  |
-|  [responseModelOrSpec](./openapi-v3.responsedecoratormetadataitem.responsemodelorspec.md) | [ResponseModelOrSpec](./openapi-v3.responsemodelorspec.md) |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [contentType](./openapi-v3.responsedecoratormetadataitem.contenttype.md) |  | string |  |
+|  [description](./openapi-v3.responsedecoratormetadataitem.description.md) |  | string |  |
+|  [responseCode](./openapi-v3.responsedecoratormetadataitem.responsecode.md) |  | number |  |
+|  [responseModelOrSpec](./openapi-v3.responsedecoratormetadataitem.responsemodelorspec.md) |  | [ResponseModelOrSpec](./openapi-v3.responsemodelorspec.md) |  |
 
 

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

@@ -23,10 +23,10 @@ export interface RestEndpoint
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [path](./openapi-v3.restendpoint.path.md) | string |  |
-|  [spec?](./openapi-v3.restendpoint.spec.md) | OperationObject | <i>(Optional)</i> |
-|  [verb](./openapi-v3.restendpoint.verb.md) | string |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [path](./openapi-v3.restendpoint.path.md) |  | string |  |
+|  [spec?](./openapi-v3.restendpoint.spec.md) |  | OperationObject | <i>(Optional)</i> |
+|  [verb](./openapi-v3.restendpoint.verb.md) |  | string |  |
 
 

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

@@ -18,7 +18,7 @@ Add tags for an endpoint. When applied to a class, this decorator adds the tags
 <b>Signature:</b>
 
 ```typescript
-export declare function tags(...tagNames: string[]): (target: any, method?: string | undefined, methodDescriptor?: TypedPropertyDescriptor<any> | undefined) => any;
+export declare function tags(...tagNames: string[]): (target: any, method?: string, methodDescriptor?: TypedPropertyDescriptor<any>) => any;
 ```
 
 ## Parameters
@@ -29,7 +29,7 @@ export declare function tags(...tagNames: string[]): (target: any, method?: stri
 
 <b>Returns:</b>
 
-(target: any, method?: string \| undefined, methodDescriptor?: TypedPropertyDescriptor&lt;any&gt; \| undefined) =&gt; any
+(target: any, method?: string, methodDescriptor?: TypedPropertyDescriptor&lt;any&gt;) =&gt; any
 
 ## Example
 

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

@@ -21,8 +21,8 @@ export interface TagsDecoratorMetadata
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [tags](./openapi-v3.tagsdecoratormetadata.tags.md) | string\[\] |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [tags](./openapi-v3.tagsdecoratormetadata.tags.md) |  | string\[\] |  |
 
 

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

@@ -20,7 +20,7 @@ You can optionally mark all controllers in a class with `@visibility('undocument
 <b>Signature:</b>
 
 ```typescript
-export declare function visibility(visibilityType: OperationVisibility): (target: any, method?: string | undefined, methodDescriptor?: TypedPropertyDescriptor<any> | undefined) => any;
+export declare function visibility(visibilityType: OperationVisibility): (target: any, method?: string, methodDescriptor?: TypedPropertyDescriptor<any>) => any;
 ```
 
 ## Parameters
@@ -31,7 +31,7 @@ export declare function visibility(visibilityType: OperationVisibility): (target
 
 <b>Returns:</b>
 
-(target: any, method?: string \| undefined, methodDescriptor?: TypedPropertyDescriptor&lt;any&gt; \| undefined) =&gt; any
+(target: any, method?: string, methodDescriptor?: TypedPropertyDescriptor&lt;any&gt;) =&gt; any
 
 ## Example
 

package/site/apidocs/pooling.pooledvalue.md

@@ -23,10 +23,10 @@ export interface PooledValue<T>
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [pool](./pooling.pooledvalue.pool.md) | Pool&lt;T&gt; | The resource pool |
-|  [value](./pooling.pooledvalue.value.md) | T | Acquired value from the pool |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [pool](./pooling.pooledvalue.pool.md) |  | Pool&lt;T&gt; | The resource pool |
+|  [value](./pooling.pooledvalue.value.md) |  | T | Acquired value from the pool |
 
 ## Methods
 

package/site/apidocs/pooling.poolfactory.md

@@ -20,7 +20,7 @@ Factory for the pooling service
 ```typescript
 export interface PoolFactory<T> extends Factory<T> 
 ```
-<b>Extends:</b> Factory
+<b>Extends:</b> Factory&lt;T&gt;
 
 ## Methods