@loopback/docs 5.1.1 → 5.1.3

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

@@ -27,7 +27,7 @@ constructor(
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  getEnhancers | [Getter](./context.getter.md)<!-- -->&lt;[OASEnhancer](./openapi-v3.oasenhancer.md)<!-- -->\[\]&gt; |  |
+|  getEnhancers | Getter&lt;[OASEnhancer](./openapi-v3.oasenhancer.md)<!-- -->\[\]&gt; |  |
 |  options | [OASEnhancerServiceOptions](./openapi-v3.oasenhancerserviceoptions.md) \| undefined | <i>(Optional)</i> |
 
 

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

package/site/apidocs/pooling.poolingservice.md

@@ -38,8 +38,8 @@ The pool service observes life cycle events to start and stop.
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [context](./pooling.poolingservice.context.md) |  | [Context](./context.context.md) |  |
-|  [pool](./pooling.poolingservice.pool.md) |  | Pool<T> | The resource pool |
+|  [context](./pooling.poolingservice.context.md) | <code>readonly</code> | [Context](./context.context.md) |  |
+|  [pool](./pooling.poolingservice.pool.md) | <code>readonly</code> | Pool&lt;T&gt; | The resource pool |
 
 ## Methods
 

package/site/apidocs/pooling.poolingserviceoptions.md

@@ -23,9 +23,9 @@ export interface PoolingServiceOptions<T>
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [factory](./pooling.poolingserviceoptions.factory.md) | [PoolFactory](./pooling.poolfactory.md)<!-- -->&lt;T&gt; \| ((ctx: [Context](./context.context.md)<!-- -->) =&gt; [PoolFactory](./pooling.poolfactory.md)<!-- -->&lt;T&gt;) | A factory to create/destroy/validate resources for the pool or a function to create a factory for the given context |
-|  [poolOptions?](./pooling.poolingserviceoptions.pooloptions.md) | Options | <i>(Optional)</i> Options for the generic pool |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [factory](./pooling.poolingserviceoptions.factory.md) |  | [PoolFactory](./pooling.poolfactory.md)<!-- -->&lt;T&gt; \| ((ctx: [Context](./context.context.md)<!-- -->) =&gt; [PoolFactory](./pooling.poolfactory.md)<!-- -->&lt;T&gt;) | A factory to create/destroy/validate resources for the pool or a function to create a factory for the given context |
+|  [poolOptions?](./pooling.poolingserviceoptions.pooloptions.md) |  | Options | <i>(Optional)</i> Options for the generic pool |
 
 

package/site/apidocs/repository-json-schema.filterschemaoptions.md

@@ -21,9 +21,9 @@ export interface FilterSchemaOptions
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [exclude?](./repository-json-schema.filterschemaoptions.exclude.md) | string\[\] \| string | <i>(Optional)</i> To exclude one or more property from <code>filter</code> |
-|  [setTitle?](./repository-json-schema.filterschemaoptions.settitle.md) | boolean | <i>(Optional)</i> Set this flag if you want the schema to set generated title property.<!-- -->By default the setting is enabled. (e.g. {<!-- -->setTitle: true<!-- -->}<!-- -->) |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [exclude?](./repository-json-schema.filterschemaoptions.exclude.md) |  | string\[\] \| string | <i>(Optional)</i> To exclude one or more property from <code>filter</code> |
+|  [setTitle?](./repository-json-schema.filterschemaoptions.settitle.md) |  | boolean | <p><i>(Optional)</i> Set this flag if you want the schema to set generated title property.</p><p>By default the setting is enabled. (e.g. {<!-- -->setTitle: true<!-- -->}<!-- -->)</p> |
 
 

package/site/apidocs/repository-json-schema.jsonschemaoptions.md

@@ -21,12 +21,12 @@ export interface JsonSchemaOptions<T extends object>
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [exclude?](./repository-json-schema.jsonschemaoptions.exclude.md) | (keyof T)\[\] | <i>(Optional)</i> List of model properties to exclude from the schema. |
-|  [includeRelations?](./repository-json-schema.jsonschemaoptions.includerelations.md) | boolean | <i>(Optional)</i> Set this flag if you want the schema to define navigational properties for model relations. |
-|  [optional?](./repository-json-schema.jsonschemaoptions.optional.md) | (keyof T)\[\] | <i>(Optional)</i> List of model properties to mark as optional. Overrides the "partial" option if it is not empty. |
-|  [partial?](./repository-json-schema.jsonschemaoptions.partial.md) | boolean \| 'deep' | <i>(Optional)</i> Set this flag to mark all model properties as optional. This is typically used to describe request body of PATCH endpoints. This option will be overridden by the "optional" option if it is set and non-empty.<!-- -->The flag also applies to nested model instances if its value is set to 'deep', such as: |
-|  [title?](./repository-json-schema.jsonschemaoptions.title.md) | string | <i>(Optional)</i> The title to use in the generated schema.<!-- -->When using options like <code>exclude</code>, the auto-generated title can be difficult to read for humans. Use this option to change the title to a more meaningful value. |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [exclude?](./repository-json-schema.jsonschemaoptions.exclude.md) |  | (keyof T)\[\] | <i>(Optional)</i> List of model properties to exclude from the schema. |
+|  [includeRelations?](./repository-json-schema.jsonschemaoptions.includerelations.md) |  | boolean | <i>(Optional)</i> Set this flag if you want the schema to define navigational properties for model relations. |
+|  [optional?](./repository-json-schema.jsonschemaoptions.optional.md) |  | (keyof T)\[\] | <i>(Optional)</i> List of model properties to mark as optional. Overrides the "partial" option if it is not empty. |
+|  [partial?](./repository-json-schema.jsonschemaoptions.partial.md) |  | boolean \| 'deep' | <p><i>(Optional)</i> Set this flag to mark all model properties as optional. This is typically used to describe request body of PATCH endpoints. This option will be overridden by the "optional" option if it is set and non-empty.</p><p>The flag also applies to nested model instances if its value is set to 'deep', such as:</p> |
+|  [title?](./repository-json-schema.jsonschemaoptions.title.md) |  | string | <p><i>(Optional)</i> The title to use in the generated schema.</p><p>When using options like <code>exclude</code>, the auto-generated title can be difficult to read for humans. Use this option to change the title to a more meaningful value.</p> |
 
 

package/site/apidocs/repository-json-schema.md

@@ -24,12 +24,12 @@ Modules to easily convert LoopBack4 models that have been decorated with `@model
 |  Function | Description |
 |  --- | --- |
 |  [getFieldsJsonSchemaFor(modelCtor, options)](./repository-json-schema.getfieldsjsonschemafor.md) | Build a JSON schema describing the format of the "fields" object used to include or exclude properties of model instances. |
-|  [getFilterJsonSchemaFor(modelCtor, options)](./repository-json-schema.getfilterjsonschemafor.md) | Build a JSON 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. |
+|  [getFilterJsonSchemaFor(modelCtor, options)](./repository-json-schema.getfilterjsonschemafor.md) | <p>Build a JSON 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> |
 |  [getJsonSchema(ctor, options)](./repository-json-schema.getjsonschema.md) | Gets the JSON Schema of a TypeScript model/class by seeing if one exists in a cache. If not, one is generated and then cached. |
 |  [getJsonSchemaRef(modelCtor, options)](./repository-json-schema.getjsonschemaref.md) | Describe the provided Model as a reference to a definition shared by multiple endpoints. The definition is included in the returned schema. |
 |  [getNavigationalPropertyForRelation(relMeta, targetRef)](./repository-json-schema.getnavigationalpropertyforrelation.md) | Checks and return navigational property definition for the relation |
-|  [getScopeFilterJsonSchemaFor(modelCtor, options)](./repository-json-schema.getscopefilterjsonschemafor.md) | Build a JSON schema describing the format of the "scope" 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. |
-|  [getWhereJsonSchemaFor(modelCtor, options)](./repository-json-schema.getwherejsonschemafor.md) | Build a JSON 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. |
+|  [getScopeFilterJsonSchemaFor(modelCtor, options)](./repository-json-schema.getscopefilterjsonschemafor.md) | <p>Build a JSON schema describing the format of the "scope" 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> |
+|  [getWhereJsonSchemaFor(modelCtor, options)](./repository-json-schema.getwherejsonschemafor.md) | <p>Build a JSON 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> |
 |  [isArrayType(type)](./repository-json-schema.isarraytype.md) | Determines whether a given string or constructor is array type or not |
 |  [metaToJsonProperty(meta)](./repository-json-schema.metatojsonproperty.md) | Converts property metadata into a JSON property definition |
 |  [modelToJsonSchema(ctor, jsonSchemaOptions)](./repository-json-schema.modeltojsonschema.md) | Converts a TypeScript class into a JSON Schema using TypeScript's reflection API |

package/site/apidocs/repository-tests.crudfeatures.md

@@ -23,13 +23,13 @@ export interface CrudFeatures
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [emptyValue](./repository-tests.crudfeatures.emptyvalue.md) | undefined \| null | The value used by the database to store properties set to <code>undefined</code>. Typically, SQL databases store both <code>undefined</code> and <code>null</code> as <code>null</code>.<!-- -->Default: <code>undefined</code> |
-|  [freeFormProperties](./repository-tests.crudfeatures.freeformproperties.md) | boolean | Does the database (or the connector) require a fixed schema, or can it support additional (free-form) properties? SQL databases typically don't support free-form properties.<!-- -->Default: <code>true</code> |
-|  [hasRevisionToken](./repository-tests.crudfeatures.hasrevisiontoken.md) | boolean | Does the connector have the revision token for replacement operations? (Cloudant)<!-- -->Default: <code>false</code> |
-|  [idType](./repository-tests.crudfeatures.idtype.md) | 'string' \| 'number' | What type is used for auto-generated primary keys? - SQL databases typically use auto-incremented numbers, - NoSQL databases tend to use GUID/UUID strings.<!-- -->Default: <code>'string'</code>. |
-|  [supportsInclusionResolvers](./repository-tests.crudfeatures.supportsinclusionresolvers.md) | boolean | Does the repository provide <code>inclusionResolvers</code> object where resolvers can be registered?<!-- -->Default: <code>true</code> |
-|  [supportsTransactions](./repository-tests.crudfeatures.supportstransactions.md) | boolean | Does the connector support using transactions for performing CRUD operations atomically and being able to commit or rollback the changes? SQL databases usually support transactions<!-- -->Default: <code>false</code> |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [emptyValue](./repository-tests.crudfeatures.emptyvalue.md) |  | undefined \| null | <p>The value used by the database to store properties set to <code>undefined</code>. Typically, SQL databases store both <code>undefined</code> and <code>null</code> as <code>null</code>.</p><p>Default: <code>undefined</code></p> |
+|  [freeFormProperties](./repository-tests.crudfeatures.freeformproperties.md) |  | boolean | <p>Does the database (or the connector) require a fixed schema, or can it support additional (free-form) properties? SQL databases typically don't support free-form properties.</p><p>Default: <code>true</code></p> |
+|  [hasRevisionToken](./repository-tests.crudfeatures.hasrevisiontoken.md) |  | boolean | <p>Does the connector have the revision token for replacement operations? (Cloudant)</p><p>Default: <code>false</code></p> |
+|  [idType](./repository-tests.crudfeatures.idtype.md) |  | 'string' \| 'number' | <p>What type is used for auto-generated primary keys? - SQL databases typically use auto-incremented numbers, - NoSQL databases tend to use GUID/UUID strings.</p><p>Default: <code>'string'</code>.</p> |
+|  [supportsInclusionResolvers](./repository-tests.crudfeatures.supportsinclusionresolvers.md) |  | boolean | <p>Does the repository provide <code>inclusionResolvers</code> object where resolvers can be registered?</p><p>Default: <code>true</code></p> |
+|  [supportsTransactions](./repository-tests.crudfeatures.supportstransactions.md) |  | boolean | <p>Does the connector support using transactions for performing CRUD operations atomically and being able to commit or rollback the changes? SQL databases usually support transactions</p><p>Default: <code>false</code></p> |
 
 

package/site/apidocs/repository.anytype.md

@@ -20,13 +20,13 @@ Any type
 ```typescript
 export declare class AnyType implements Type<any> 
 ```
-<b>Implements:</b> [Type](./repository.type.md)
+<b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;any&gt;
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [name](./repository.anytype.name.md) |  | (not declared) |  |
+|  [name](./repository.anytype.name.md) | <code>readonly</code> | (not declared) |  |
 
 ## Methods
 

package/site/apidocs/repository.arraytype.md

@@ -20,7 +20,7 @@ Array type, such as string\[\]
 ```typescript
 export declare class ArrayType<T> implements Type<T[]> 
 ```
-<b>Implements:</b> [Type](./repository.type.md)
+<b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;T\[\]&gt;
 
 ## Constructors
 
@@ -33,7 +33,7 @@ export declare class ArrayType<T> implements Type<T[]>
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [itemType](./repository.arraytype.itemtype.md) |  | [Type](./repository.type.md)<!-- -->&lt;T&gt; |  |
-|  [name](./repository.arraytype.name.md) |  | (not declared) |  |
+|  [name](./repository.arraytype.name.md) | <code>readonly</code> | (not declared) |  |
 
 ## Methods
 

package/site/apidocs/repository.baserepositoryclass.md

@@ -25,9 +25,9 @@ export interface BaseRepositoryClass<M extends typeof Model, R extends Repositor
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [prototype](./repository.baserepositoryclass.prototype.md) | R |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [prototype](./repository.baserepositoryclass.prototype.md) |  | R |  |
 
 ## Methods
 

package/site/apidocs/repository.belongstoaccessor.md

@@ -21,8 +21,8 @@ export interface BelongsToAccessor<Target extends Entity, SourceId>
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [inclusionResolver](./repository.belongstoaccessor.inclusionresolver.md) | [InclusionResolver](./repository.inclusionresolver.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->, Target&gt; | Use <code>resolver</code> property to obtain an InclusionResolver for this relation. |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [inclusionResolver](./repository.belongstoaccessor.inclusionresolver.md) |  | [InclusionResolver](./repository.inclusionresolver.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->, Target&gt; | Use <code>resolver</code> property to obtain an InclusionResolver for this relation. |
 
 

package/site/apidocs/repository.belongstodefinition.md

@@ -22,12 +22,12 @@ export interface BelongsToDefinition extends RelationDefinitionBase
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [keyFrom?](./repository.belongstodefinition.keyfrom.md) | string | <i>(Optional)</i> |
-|  [keyTo?](./repository.belongstodefinition.keyto.md) | string | <i>(Optional)</i> |
-|  [polymorphic?](./repository.belongstodefinition.polymorphic.md) | boolean \| { discriminator: string; } | <i>(Optional)</i> The polymorphism of the target model. The discriminator is a key of source model. If the target model is not polymorphic, then the value should be left undefined or false; If the key on source model indicating the concrete class of the target instance is default i.e. camelCase(classNameOf(throughModelInstance)) + "Id" Then the discriminator field can be undefined |
-|  [targetsMany](./repository.belongstodefinition.targetsmany.md) | false |  |
-|  [type](./repository.belongstodefinition.type.md) | [RelationType.belongsTo](./repository.relationtype.md) |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [keyFrom?](./repository.belongstodefinition.keyfrom.md) |  | string | <i>(Optional)</i> |
+|  [keyTo?](./repository.belongstodefinition.keyto.md) |  | string | <i>(Optional)</i> |
+|  [polymorphic?](./repository.belongstodefinition.polymorphic.md) |  | boolean \| { discriminator: string; } | <i>(Optional)</i> The polymorphism of the target model. The discriminator is a key of source model. If the target model is not polymorphic, then the value should be left undefined or false; If the key on source model indicating the concrete class of the target instance is default i.e. camelCase(classNameOf(throughModelInstance)) + "Id" Then the discriminator field can be undefined |
+|  [targetsMany](./repository.belongstodefinition.targetsmany.md) |  | false |  |
+|  [type](./repository.belongstodefinition.type.md) |  | [RelationType.belongsTo](./repository.relationtype.md) |  |
 
 

package/site/apidocs/repository.booleantype.md

@@ -20,13 +20,13 @@ Boolean type
 ```typescript
 export declare class BooleanType implements Type<boolean> 
 ```
-<b>Implements:</b> [Type](./repository.type.md)
+<b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;boolean&gt;
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [name](./repository.booleantype.name.md) |  | (not declared) |  |
+|  [name](./repository.booleantype.name.md) | <code>readonly</code> | (not declared) |  |
 
 ## Methods
 

package/site/apidocs/repository.buffertype.md

@@ -20,13 +20,13 @@ Buffer (binary) type
 ```typescript
 export declare class BufferType implements Type<Buffer> 
 ```
-<b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;Buffer
+<b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;Buffer&gt;
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [name](./repository.buffertype.name.md) |  | (not declared) |  |
+|  [name](./repository.buffertype.name.md) | <code>readonly</code> | (not declared) |  |
 
 ## Methods
 

package/site/apidocs/repository.buildlookupmap.md

@@ -18,7 +18,7 @@ Returns a map which maps key values(ids) to instances. The instances can be grou
 <b>Signature:</b>
 
 ```typescript
-export declare function buildLookupMap<Key, InType, OutType = InType>(list: InType[], keyName: StringKeyOf<InType>, reducer: (accumulator: OutType | undefined, current: InType) => OutType): Map<Key, OutType>;
+export declare function buildLookupMap<Key, InType extends object, OutType = InType>(list: InType[], keyName: StringKeyOf<InType>, reducer: (accumulator: OutType | undefined, current: InType) => OutType): Map<Key, OutType>;
 ```
 
 ## Parameters

package/site/apidocs/repository.connector.md

@@ -23,11 +23,11 @@ export interface Connector
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [configModel?](./repository.connector.configmodel.md) | [Model](./repository.model.md) | <i>(Optional)</i> |
-|  [interfaces?](./repository.connector.interfaces.md) | (string \| [ConnectorInterfaces.StrongRelation](./repository.connectorinterfaces.strongrelation.md) \| [ConnectorInterfaces.StrongJoins](./repository.connectorinterfaces.strongjoins.md)<!-- -->)\[\] | <i>(Optional)</i> |
-|  [name](./repository.connector.name.md) | string |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [configModel?](./repository.connector.configmodel.md) |  | [Model](./repository.model.md) | <i>(Optional)</i> |
+|  [interfaces?](./repository.connector.interfaces.md) |  | (string \| [ConnectorInterfaces.StrongRelation](./repository.connectorinterfaces.strongrelation.md) \| [ConnectorInterfaces.StrongJoins](./repository.connectorinterfaces.strongjoins.md)<!-- -->)\[\] | <i>(Optional)</i> |
+|  [name](./repository.connector.name.md) |  | string |  |
 
 ## Methods
 

package/site/apidocs/repository.count.md

@@ -23,8 +23,8 @@ export interface Count
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [count](./repository.count.count.md) | number |  |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [count](./repository.count.count.md) |  | number |  |
 
 

package/site/apidocs/repository.createbelongstoaccessor.md

@@ -28,7 +28,7 @@ export declare function createBelongsToAccessor<Target extends Entity, TargetId,
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  belongsToMetadata | [BelongsToDefinition](./repository.belongstodefinition.md) |  |
-|  targetRepositoryGetter | [Getter](./context.getter.md)<!-- -->&lt;[EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Target, TargetId&gt;&gt; \| { \[repoType: string\]: [Getter](./context.getter.md)<!-- -->&lt;[EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Target, TargetId&gt;&gt;; } |  |
+|  targetRepositoryGetter | Getter&lt;[EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Target, TargetId&gt;&gt; \| { \[repoType: string\]: Getter&lt;[EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Target, TargetId&gt;&gt;; } |  |
 |  sourceRepository | [EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Source, SourceId&gt; |  |
 
 <b>Returns:</b>

package/site/apidocs/repository.createbelongstoinclusionresolver.md

@@ -30,7 +30,7 @@ export declare function createBelongsToInclusionResolver<Target extends Entity,
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  meta | [BelongsToDefinition](./repository.belongstodefinition.md) | resolved BelongsToMetadata |
-|  getTargetRepoDict | { \[repoType: string\]: [Getter](./context.getter.md)<!-- -->&lt;[EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Target, TargetID, TargetRelations&gt;&gt;; } | dictionary of target model type - target repository i.e where related instances for different types are |
+|  getTargetRepoDict | { \[repoType: string\]: Getter&lt;[EntityCrudRepository](./repository.entitycrudrepository.md)<!-- -->&lt;Target, TargetID, TargetRelations&gt;&gt;; } | dictionary of target model type - target repository i.e where related instances for different types are |
 
 <b>Returns:</b>