npm - @loopback/docs - Versions diffs - 4.0.3 → 5.1.0 - Mend

@loopback/docs 4.0.3 → 5.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (661) hide show

package/site/apidocs/metadata.parameterdecoratorfactory.mergewithinherited.md CHANGED Viewed

@@ -25,8 +25,8 @@ protected mergeWithInherited(inheritedMetadata: MetadataMap<T[]>, target: Object
 |  --- | --- | --- |
 |  inheritedMetadata | [MetadataMap](./metadata.metadatamap.md)<!-- -->&lt;T\[\]&gt; |  |
 |  target | Object |  |
-|  methodName | string |  |
-|  parameterIndex | TypedPropertyDescriptor&lt;any&gt; \| number |  |
+|  methodName | string | <i>(Optional)</i> |
+|  parameterIndex | TypedPropertyDescriptor&lt;any&gt; \| number | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/metadata.parameterdecoratorfactory.mergewithown.md CHANGED Viewed

@@ -25,8 +25,8 @@ protected mergeWithOwn(ownMetadata: MetadataMap<T[]>, target: Object, methodName
 |  --- | --- | --- |
 |  ownMetadata | [MetadataMap](./metadata.metadatamap.md)<!-- -->&lt;T\[\]&gt; |  |
 |  target | Object |  |
-|  methodName | string |  |
-|  parameterIndex | TypedPropertyDescriptor&lt;any&gt; \| number |  |
+|  methodName | string | <i>(Optional)</i> |
+|  parameterIndex | TypedPropertyDescriptor&lt;any&gt; \| number | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/metadata.propertydecoratorfactory.createdecorator.md CHANGED Viewed

@@ -27,7 +27,7 @@ static createDecorator<S>(key: MetadataKey<S, PropertyDecorator>, spec: S, optio
 |  --- | --- | --- |
 |  key | [MetadataKey](./metadata.metadatakey.md)<!-- -->&lt;S, PropertyDecorator&gt; | Metadata key |
 |  spec | S | Metadata object from the decorator function |
-|  options | [DecoratorOptions](./metadata.decoratoroptions.md) | Options for the decorator |
+|  options | [DecoratorOptions](./metadata.decoratoroptions.md) | <i>(Optional)</i> Options for the decorator |
 <b>Returns:</b>

package/site/apidocs/metadata.propertydecoratorfactory.md CHANGED Viewed

@@ -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&gt;
+<b>Extends:</b> [DecoratorFactory](./metadata.decoratorfactory.md)<!-- -->&lt;T, [MetadataMap](./metadata.metadatamap.md)<!-- -->&lt;T&gt;, PropertyDecorator
 ## Methods

package/site/apidocs/metadata.propertydecoratorfactory.mergewithinherited.md CHANGED Viewed

@@ -25,8 +25,8 @@ protected mergeWithInherited(inheritedMetadata: MetadataMap<T>, target: Object,
 |  --- | --- | --- |
 |  inheritedMetadata | [MetadataMap](./metadata.metadatamap.md)<!-- -->&lt;T&gt; |  |
 |  target | Object |  |
-|  propertyName | string |  |
-|  descriptorOrIndex | TypedPropertyDescriptor&lt;any&gt; \| number |  |
+|  propertyName | string | <i>(Optional)</i> |
+|  descriptorOrIndex | TypedPropertyDescriptor&lt;any&gt; \| number | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/metadata.propertydecoratorfactory.mergewithown.md CHANGED Viewed

@@ -25,8 +25,8 @@ protected mergeWithOwn(ownMetadata: MetadataMap<T>, target: Object, propertyName
 |  --- | --- | --- |
 |  ownMetadata | [MetadataMap](./metadata.metadatamap.md)<!-- -->&lt;T&gt; |  |
 |  target | Object |  |
-|  propertyName | string |  |
-|  descriptorOrParameterIndex | TypedPropertyDescriptor&lt;any&gt; \| number |  |
+|  propertyName | string | <i>(Optional)</i> |
+|  descriptorOrParameterIndex | TypedPropertyDescriptor&lt;any&gt; \| number | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/metrics.metricscomponent._constructor_.md CHANGED Viewed

@@ -26,6 +26,6 @@ constructor(application: Application, metricsConfig?: MetricsConfig);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  application | [Application](./core.application.md) |  |
-|  metricsConfig | [MetricsConfig](./metrics.metricsconfig.md) |  |
+|  metricsConfig | [MetricsConfig](./metrics.metricsconfig.md) | <i>(Optional)</i> |

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

@@ -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&gt;
+<b>Extends:</b> [BuilderBase](./openapi-spec-builder.builderbase.md)<!-- -->&lt;ComponentsObject
 ## Constructors

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

@@ -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&gt;
+<b>Extends:</b> [BuilderBase](./openapi-spec-builder.builderbase.md)<!-- -->&lt;OpenAPIObject
 ## Constructors

package/site/apidocs/openapi-spec-builder.openapispecbuilder.withoperationreturningstring.md CHANGED Viewed

@@ -27,7 +27,7 @@ withOperationReturningString(verb: string, path: string, operationName?: string)
 |  --- | --- | --- |
 |  verb | string | The HTTP verb. |
 |  path | string | The path relative to basePath. |
-|  operationName | string | The name of the controller method implementing this operation (<code>x-operation-name</code> field). |
+|  operationName | string | <i>(Optional)</i> The name of the controller method implementing this operation (<code>x-operation-name</code> field). |
 <b>Returns:</b>

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

@@ -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&gt;
+<b>Extends:</b> [BuilderBase](./openapi-spec-builder.builderbase.md)<!-- -->&lt;OperationObject
 ## Constructors

package/site/apidocs/openapi-spec-builder.operationspecbuilder.withstringresponse.md CHANGED Viewed

@@ -23,7 +23,7 @@ withStringResponse(status?: number | 'default'): this;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  status | number \| 'default' |  |
+|  status | number \| 'default' | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/openapi-v3.del.md CHANGED Viewed

@@ -26,7 +26,7 @@ export declare function del(path: string, spec?: OperationObject): MethodDecorat
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  path | string | The URL path of this operation, e.g. <code>/product/{id}</code> |
-|  spec | OperationObject | The OpenAPI specification describing parameters and responses of this operation. |
+|  spec | OperationObject | <i>(Optional)</i> The OpenAPI specification describing parameters and responses of this operation. |
 <b>Returns:</b>

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

@@ -20,18 +20,18 @@ 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
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  isDeprecated | boolean | whether or not the path should be marked as deprecated. This is useful for marking a class as deprecated, but a method as not deprecated. |
+|  isDeprecated | boolean | <i>(Optional)</i> whether or not the path should be marked as deprecated. This is useful for marking a class as deprecated, but a method as not deprecated. |
 <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.get.md CHANGED Viewed

@@ -26,7 +26,7 @@ export declare function get(path: string, spec?: OperationObject): MethodDecorat
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  path | string | The URL path of this operation, e.g. <code>/product/{id}</code> |
-|  spec | OperationObject | The OpenAPI specification describing parameters and responses of this operation. |
+|  spec | OperationObject | <i>(Optional)</i> The OpenAPI specification describing parameters and responses of this operation. |
 <b>Returns:</b>

package/site/apidocs/openapi-v3.getfilterschemafor.md CHANGED Viewed

@@ -28,7 +28,7 @@ export declare function getFilterSchemaFor(modelCtor: typeof Model, options?: Fi
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  modelCtor | typeof [Model](./repository.model.md) | The model constructor to build the filter schema for. |
-|  options | [FilterSchemaOptions](./repository-json-schema.filterschemaoptions.md) | Options to build the filter schema. |
+|  options | [FilterSchemaOptions](./repository-json-schema.filterschemaoptions.md) | <i>(Optional)</i> Options to build the filter schema. |
 <b>Returns:</b>

package/site/apidocs/openapi-v3.getmodelschemaref.md CHANGED Viewed

@@ -28,7 +28,7 @@ export declare function getModelSchemaRef<T extends object>(modelCtor: Function
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  modelCtor | Function &amp; { prototype: T; } | The model constructor (e.g. <code>Product</code>) |
-|  options | [JsonSchemaOptions](./repository-json-schema.jsonschemaoptions.md)<!-- -->&lt;T&gt; | Additional options |
+|  options | [JsonSchemaOptions](./repository-json-schema.jsonschemaoptions.md)<!-- -->&lt;T&gt; | <i>(Optional)</i> Additional options |
 <b>Returns:</b>

package/site/apidocs/openapi-v3.jsontoschemaobject.md CHANGED Viewed

@@ -26,7 +26,7 @@ export declare function jsonToSchemaObject(json: JsonSchema, visited?: Map<JsonS
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  json | JsonSchema | JSON Schema to convert from |
-|  visited | Map&lt;JsonSchema, SchemaObject \| [SchemaRef](./openapi-v3.schemaref.md)<!-- -->&gt; | A map to keep track of mapped json schemas to handle circular references |
+|  visited | Map&lt;JsonSchema, SchemaObject \| [SchemaRef](./openapi-v3.schemaref.md)<!-- -->&gt; | <i>(Optional)</i> A map to keep track of mapped json schemas to handle circular references |
 <b>Returns:</b>

package/site/apidocs/openapi-v3.oasenhancerservice._constructor_.md CHANGED Viewed

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

package/site/apidocs/openapi-v3.oasenhancerservice.applyallenhancers.md CHANGED Viewed

@@ -25,7 +25,7 @@ applyAllEnhancers(options?: {}): Promise<OpenApiSpec>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | {} |  |
+|  options | {} | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/openapi-v3.operation.md CHANGED Viewed

@@ -27,7 +27,7 @@ export declare function operation(verb: string, path: string, spec?: OperationOb
 |  --- | --- | --- |
 |  verb | string | HTTP verb, e.g. <code>GET</code> or <code>POST</code>. |
 |  path | string | The URL path of this operation, e.g. <code>/product/{id}</code> |
-|  spec | OperationObject | The OpenAPI specification describing parameters and responses of this operation. |
+|  spec | OperationObject | <i>(Optional)</i> The OpenAPI specification describing parameters and responses of this operation. |
 <b>Returns:</b>

package/site/apidocs/openapi-v3.param.filter.md CHANGED Viewed

@@ -28,7 +28,7 @@ function filter(modelCtor: typeof Model, options?: string | (FilterSchemaOptions
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  modelCtor | typeof [Model](./repository.model.md) | Model class |
-|  options | string \| ([FilterSchemaOptions](./repository-json-schema.filterschemaoptions.md) &amp; { name?: string; }) | Options to customize the parameter name or filter schema |
+|  options | string \| ([FilterSchemaOptions](./repository-json-schema.filterschemaoptions.md) &amp; { name?: string; }) | <i>(Optional)</i> Options to customize the parameter name or filter schema |
 <b>Returns:</b>

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

@@ -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.param.where.md CHANGED Viewed

@@ -26,7 +26,7 @@ function where(modelCtor: typeof Model, name?: string): (target: object, member:
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  modelCtor | typeof [Model](./repository.model.md) | Model class |
-|  name | string | Custom name for the parameter, default to <code>where</code> |
+|  name | string | <i>(Optional)</i> Custom name for the parameter, default to <code>where</code> |
 <b>Returns:</b>

package/site/apidocs/openapi-v3.patch.md CHANGED Viewed

@@ -26,7 +26,7 @@ export declare function patch(path: string, spec?: OperationObject): MethodDecor
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  path | string | The URL path of this operation, e.g. <code>/product/{id}</code> |
-|  spec | OperationObject | The OpenAPI specification describing parameters and responses of this operation. |
+|  spec | OperationObject | <i>(Optional)</i> The OpenAPI specification describing parameters and responses of this operation. |
 <b>Returns:</b>

package/site/apidocs/openapi-v3.post.md CHANGED Viewed

@@ -26,7 +26,7 @@ export declare function post(path: string, spec?: OperationObject): MethodDecora
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  path | string | The URL path of this operation, e.g. <code>/product/{id}</code> |
-|  spec | OperationObject | The OpenAPI specification describing parameters and responses of this operation. |
+|  spec | OperationObject | <i>(Optional)</i> The OpenAPI specification describing parameters and responses of this operation. |
 <b>Returns:</b>

package/site/apidocs/openapi-v3.put.md CHANGED Viewed

@@ -26,7 +26,7 @@ export declare function put(path: string, spec?: OperationObject): MethodDecorat
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  path | string | The URL path of this operation, e.g. <code>/product/{id}</code> |
-|  spec | OperationObject | The OpenAPI specification describing parameters and responses of this operation. |
+|  spec | OperationObject | <i>(Optional)</i> The OpenAPI specification describing parameters and responses of this operation. |
 <b>Returns:</b>

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

@@ -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 CHANGED Viewed

@@ -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.tags.md CHANGED Viewed

@@ -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.visibility.md CHANGED Viewed

@@ -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.getpooledvalue.md CHANGED Viewed

@@ -26,7 +26,7 @@ export declare function getPooledValue<T>(poolingService: PoolingService<T> | Po
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  poolingService | [PoolingService](./pooling.poolingservice.md)<!-- -->&lt;T&gt; \| Pool&lt;T&gt; | Pooling service or pool |
-|  requestCtx | [Context](./context.context.md) | Request context |
+|  requestCtx | [Context](./context.context.md) | <i>(Optional)</i> Request context |
 <b>Returns:</b>

package/site/apidocs/pooling.poolfactory.md CHANGED Viewed

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

package/site/apidocs/pooling.poolingservice.acquire.md CHANGED Viewed

@@ -25,7 +25,7 @@ acquire(requestCtx?: Context): Promise<T>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  requestCtx | [Context](./context.context.md) | Optional request context, default to the owning context |
+|  requestCtx | [Context](./context.context.md) | <i>(Optional)</i> Optional request context, default to the owning context |
 <b>Returns:</b>

package/site/apidocs/pooling.poolingservice.run.md CHANGED Viewed

@@ -26,7 +26,7 @@ run(task: (resource: T) => ValueOrPromise<void>, requestCtx?: Context): Promise<
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  task | (resource: T) =&gt; [ValueOrPromise](./context.valueorpromise.md)<!-- -->&lt;void&gt; | A function that accepts a resource and returns a Promise. |
-|  requestCtx | [Context](./context.context.md) |  |
+|  requestCtx | [Context](./context.context.md) | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/repository-json-schema.getfieldsjsonschemafor.md CHANGED Viewed

@@ -26,7 +26,7 @@ export declare function getFieldsJsonSchemaFor(modelCtor: typeof Model, options?
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  modelCtor | typeof [Model](./repository.model.md) | The model constructor to build the filter schema for. |
-|  options | [FilterSchemaOptions](./repository-json-schema.filterschemaoptions.md) |  |
+|  options | [FilterSchemaOptions](./repository-json-schema.filterschemaoptions.md) | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/repository-json-schema.getfilterjsonschemafor.md CHANGED Viewed

@@ -28,7 +28,7 @@ export declare function getFilterJsonSchemaFor(modelCtor: typeof Model, options?
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  modelCtor | typeof [Model](./repository.model.md) | The model constructor to build the filter schema for. |
-|  options | [FilterSchemaOptions](./repository-json-schema.filterschemaoptions.md) | Options to build the filter schema. |
+|  options | [FilterSchemaOptions](./repository-json-schema.filterschemaoptions.md) | <i>(Optional)</i> Options to build the filter schema. |
 <b>Returns:</b>

package/site/apidocs/repository-json-schema.getjsonschema.md CHANGED Viewed

@@ -28,7 +28,7 @@ export declare function getJsonSchema<T extends object>(ctor: Function & {
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  ctor | Function &amp; { prototype: T; } | Constructor of class to get JSON Schema from |
-|  options | [JsonSchemaOptions](./repository-json-schema.jsonschemaoptions.md)<!-- -->&lt;T&gt; |  |
+|  options | [JsonSchemaOptions](./repository-json-schema.jsonschemaoptions.md)<!-- -->&lt;T&gt; | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/repository-json-schema.getjsonschemaref.md CHANGED Viewed

@@ -28,7 +28,7 @@ export declare function getJsonSchemaRef<T extends object>(modelCtor: Function &
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  modelCtor | Function &amp; { prototype: T; } | The model constructor (e.g. <code>Product</code>) |
-|  options | [JsonSchemaOptions](./repository-json-schema.jsonschemaoptions.md)<!-- -->&lt;T&gt; | Additional options |
+|  options | [JsonSchemaOptions](./repository-json-schema.jsonschemaoptions.md)<!-- -->&lt;T&gt; | <i>(Optional)</i> Additional options |
 <b>Returns:</b>

package/site/apidocs/repository-json-schema.getscopefilterjsonschemafor.md CHANGED Viewed

@@ -28,7 +28,7 @@ export declare function getScopeFilterJsonSchemaFor(modelCtor: typeof Model, opt
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  modelCtor | typeof [Model](./repository.model.md) | The model constructor to build the filter schema for. |
-|  options | [FilterSchemaOptions](./repository-json-schema.filterschemaoptions.md) |  |
+|  options | [FilterSchemaOptions](./repository-json-schema.filterschemaoptions.md) | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/repository-json-schema.getwherejsonschemafor.md CHANGED Viewed

@@ -28,7 +28,7 @@ export declare function getWhereJsonSchemaFor(modelCtor: typeof Model, options?:
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  modelCtor | typeof [Model](./repository.model.md) | The model constructor to build the filter schema for. |
-|  options | [FilterSchemaOptions](./repository-json-schema.filterschemaoptions.md) |  |
+|  options | [FilterSchemaOptions](./repository-json-schema.filterschemaoptions.md) | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/repository-json-schema.modeltojsonschema.md CHANGED Viewed

@@ -28,7 +28,7 @@ export declare function modelToJsonSchema<T extends object>(ctor: Function & {
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  ctor | Function &amp; { prototype: T; } | Constructor of class to convert from |
-|  jsonSchemaOptions | [JsonSchemaOptions](./repository-json-schema.jsonschemaoptions.md)<!-- -->&lt;T&gt; |  |
+|  jsonSchemaOptions | [JsonSchemaOptions](./repository-json-schema.jsonschemaoptions.md)<!-- -->&lt;T&gt; | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/repository.anytype.md CHANGED Viewed

@@ -20,7 +20,7 @@ Any type
 ```typescript
 export declare class AnyType implements Type<any>
 ```
-<b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;any&gt;
+<b>Implements:</b> [Type](./repository.type.md)
 ## Properties

package/site/apidocs/repository.applicationwithrepositories.component.md CHANGED Viewed

@@ -24,7 +24,7 @@ component(component: Class<unknown>, name?: string): Binding;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  component | [Class](./repository.class.md)<!-- -->&lt;unknown&gt; |  |
-|  name | string |  |
+|  name | string | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/repository.applicationwithrepositories.datasource.md CHANGED Viewed

@@ -24,7 +24,7 @@ dataSource<D extends juggler.DataSource>(dataSource: Class<D> | D, name?: string
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  dataSource | [Class](./repository.class.md)<!-- -->&lt;D&gt; \| D |  |
-|  name | string |  |
+|  name | string | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/repository.applicationwithrepositories.migrateschema.md CHANGED Viewed

@@ -23,7 +23,7 @@ migrateSchema(options?: SchemaMigrationOptions): Promise<void>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [SchemaMigrationOptions](./repository.schemamigrationoptions.md) |  |
+|  options | [SchemaMigrationOptions](./repository.schemamigrationoptions.md) | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/repository.applicationwithrepositories.repository.md CHANGED Viewed

@@ -24,7 +24,7 @@ repository<R extends Repository<any>>(repo: Class<R>, name?: string): Binding<R>
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  repo | [Class](./repository.class.md)<!-- -->&lt;R&gt; |  |
-|  name | string |  |
+|  name | string | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/repository.arraytype.md CHANGED Viewed

@@ -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)<!-- -->&lt;T\[\]&gt;
+<b>Implements:</b> [Type](./repository.type.md)
 ## Constructors

package/site/apidocs/repository.belongsto.md CHANGED Viewed

@@ -26,8 +26,8 @@ export declare function belongsTo<T extends Entity>(targetResolver: EntityResolv
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  targetResolver | [EntityResolver](./repository.entityresolver.md)<!-- -->&lt;T&gt; | A resolver function that returns the target model for a belongsTo relation |
-|  definition | Partial&lt;[BelongsToDefinition](./repository.belongstodefinition.md)<!-- -->&gt; | Optional metadata for setting up a belongsTo relation |
-|  propertyDefinition | Partial&lt;[PropertyDefinition](./repository.propertydefinition.md)<!-- -->&gt; | Optional metadata for setting up the property |
+|  definition | Partial&lt;[BelongsToDefinition](./repository.belongstodefinition.md)<!-- -->&gt; | <i>(Optional)</i> Optional metadata for setting up a belongsTo relation |
+|  propertyDefinition | Partial&lt;[PropertyDefinition](./repository.propertydefinition.md)<!-- -->&gt; | <i>(Optional)</i> Optional metadata for setting up the property |
 <b>Returns:</b>

package/site/apidocs/repository.belongstodefinition.md CHANGED Viewed

@@ -26,6 +26,7 @@ export interface BelongsToDefinition extends RelationDefinitionBase
 |  --- | --- | --- |
 |  [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.belongstodefinition.polymorphic.md ADDED Viewed

@@ -0,0 +1,25 @@
+---
+lang: en
+title: 'API docs: repository.belongstodefinition.polymorphic'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
+permalink: /doc/en/lb4/apidocs.repository.belongstodefinition.polymorphic.html
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [BelongsToDefinition](./repository.belongstodefinition.md) &gt; [polymorphic](./repository.belongstodefinition.polymorphic.md)
+## BelongsToDefinition.polymorphic property
+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
+<b>Signature:</b>
+```typescript
+polymorphic?: boolean | {
+        discriminator: string;
+    };
+```

package/site/apidocs/repository.belongstorepository.get.md CHANGED Viewed

@@ -18,14 +18,16 @@ Gets the target model instance
 <b>Signature:</b>
 ```typescript
-get(options?: Options): Promise<Target>;
+get(options?: Options & {
+        polymorphicType?: string | string[];
+    }): Promise<Target>;
 ```
 ## Parameters
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [Options](./repository.options.md) |  |
+|  options | [Options](./repository.options.md) &amp; { polymorphicType?: string \| string\[\]; } | <i>(Optional)</i> options.polymorphicType - a string or a string array of polymorphic type names to specify which repositories should are expected to be searched It is highly recommended to contain this param especially for datasources using deplicated ids across tables |
 <b>Returns:</b>

package/site/apidocs/repository.booleantype.md CHANGED Viewed

@@ -20,7 +20,7 @@ Boolean type
 ```typescript
 export declare class BooleanType implements Type<boolean>
 ```
-<b>Implements:</b> [Type](./repository.type.md)<!-- -->&lt;boolean&gt;
+<b>Implements:</b> [Type](./repository.type.md)
 ## Properties