@loopback/docs 6.0.3 → 6.0.5

package/site/apidocs/pooling.poolingservice.stop.md

@@ -1,27 +0,0 @@
----
-lang: en
-title: 'API docs: pooling.poolingservice.stop'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/pooling
-permalink: /doc/en/lb4/apidocs.pooling.poolingservice.stop.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/pooling](./pooling.md) &gt; [PoolingService](./pooling.poolingservice.md) &gt; [stop](./pooling.poolingservice.stop.md)
-
-## PoolingService.stop() method
-
-Stop the pool
-
-**Signature:**
-
-```typescript
-stop(): Promise<void>;
-```
-**Returns:**
-
-Promise&lt;void&gt;
-
-

package/site/apidocs/pooling.poolingserviceoptions.factory.md

@@ -1,23 +0,0 @@
----
-lang: en
-title: 'API docs: pooling.poolingserviceoptions.factory'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/pooling
-permalink: /doc/en/lb4/apidocs.pooling.poolingserviceoptions.factory.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/pooling](./pooling.md) &gt; [PoolingServiceOptions](./pooling.poolingserviceoptions.md) &gt; [factory](./pooling.poolingserviceoptions.factory.md)
-
-## PoolingServiceOptions.factory property
-
-A factory to create/destroy/validate resources for the pool or a function to create a factory for the given context
-
-**Signature:**
-
-```typescript
-factory: PoolFactory<T> | ((ctx: Context) => PoolFactory<T>);
-```
-

package/site/apidocs/pooling.poolingserviceoptions.md

@@ -1,31 +0,0 @@
----
-lang: en
-title: 'API docs: pooling.poolingserviceoptions'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/pooling
-permalink: /doc/en/lb4/apidocs.pooling.poolingserviceoptions.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/pooling](./pooling.md) &gt; [PoolingServiceOptions](./pooling.poolingserviceoptions.md)
-
-## PoolingServiceOptions interface
-
-Options to configure a resource pool
-
-**Signature:**
-
-```typescript
-export interface PoolingServiceOptions<T> 
-```
-
-## Properties
-
-|  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 | _(Optional)_ Options for the generic pool |
-
-

package/site/apidocs/pooling.poolingserviceoptions.pooloptions.md

@@ -1,23 +0,0 @@
----
-lang: en
-title: 'API docs: pooling.poolingserviceoptions.pooloptions'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/pooling
-permalink: /doc/en/lb4/apidocs.pooling.poolingserviceoptions.pooloptions.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/pooling](./pooling.md) &gt; [PoolingServiceOptions](./pooling.poolingserviceoptions.md) &gt; [poolOptions](./pooling.poolingserviceoptions.pooloptions.md)
-
-## PoolingServiceOptions.poolOptions property
-
-Options for the generic pool
-
-**Signature:**
-
-```typescript
-poolOptions?: Options;
-```
-

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

@@ -1,21 +0,0 @@
----
-lang: en
-title: 'API docs: repository-json-schema.anyscopefilterschema'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository-json-schema
-permalink: /doc/en/lb4/apidocs.repository-json-schema.anyscopefilterschema.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository-json-schema](./repository-json-schema.md) &gt; [AnyScopeFilterSchema](./repository-json-schema.anyscopefilterschema.md)
-
-## AnyScopeFilterSchema variable
-
-**Signature:**
-
-```typescript
-AnyScopeFilterSchema: JsonSchema
-```
-

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

@@ -1,23 +0,0 @@
----
-lang: en
-title: 'API docs: repository-json-schema.filterschemaoptions.exclude'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository-json-schema
-permalink: /doc/en/lb4/apidocs.repository-json-schema.filterschemaoptions.exclude.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository-json-schema](./repository-json-schema.md) &gt; [FilterSchemaOptions](./repository-json-schema.filterschemaoptions.md) &gt; [exclude](./repository-json-schema.filterschemaoptions.exclude.md)
-
-## FilterSchemaOptions.exclude property
-
-To exclude one or more property from `filter`
-
-**Signature:**
-
-```typescript
-exclude?: string[] | string;
-```
-

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

@@ -1,29 +0,0 @@
----
-lang: en
-title: 'API docs: repository-json-schema.filterschemaoptions'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository-json-schema
-permalink: /doc/en/lb4/apidocs.repository-json-schema.filterschemaoptions.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository-json-schema](./repository-json-schema.md) &gt; [FilterSchemaOptions](./repository-json-schema.filterschemaoptions.md)
-
-## FilterSchemaOptions interface
-
-**Signature:**
-
-```typescript
-export interface FilterSchemaOptions 
-```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [exclude?](./repository-json-schema.filterschemaoptions.exclude.md) |  | string\[\] \| string | _(Optional)_ To exclude one or more property from <code>filter</code> |
-|  [setTitle?](./repository-json-schema.filterschemaoptions.settitle.md) |  | boolean | <p>_(Optional)_ 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.filterschemaoptions.settitle.md

@@ -1,25 +0,0 @@
----
-lang: en
-title: 'API docs: repository-json-schema.filterschemaoptions.settitle'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository-json-schema
-permalink: /doc/en/lb4/apidocs.repository-json-schema.filterschemaoptions.settitle.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository-json-schema](./repository-json-schema.md) &gt; [FilterSchemaOptions](./repository-json-schema.filterschemaoptions.md) &gt; [setTitle](./repository-json-schema.filterschemaoptions.settitle.md)
-
-## FilterSchemaOptions.setTitle property
-
-Set this flag if you want the schema to set generated title property.
-
-By default the setting is enabled. (e.g. {<!-- -->setTitle: true<!-- -->}<!-- -->)
-
-**Signature:**
-
-```typescript
-setTitle?: boolean;
-```
-

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

@@ -1,35 +0,0 @@
----
-lang: en
-title: 'API docs: repository-json-schema.getfieldsjsonschemafor'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository-json-schema
-permalink: /doc/en/lb4/apidocs.repository-json-schema.getfieldsjsonschemafor.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository-json-schema](./repository-json-schema.md) &gt; [getFieldsJsonSchemaFor](./repository-json-schema.getfieldsjsonschemafor.md)
-
-## getFieldsJsonSchemaFor() function
-
-Build a JSON schema describing the format of the "fields" object used to include or exclude properties of model instances.
-
-**Signature:**
-
-```typescript
-export declare function getFieldsJsonSchemaFor(modelCtor: typeof Model, options?: FilterSchemaOptions): JsonSchema;
-```
-
-## Parameters
-
-|  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) | _(Optional)_ |
-
-**Returns:**
-
-JsonSchema
-
-

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

@@ -1,37 +0,0 @@
----
-lang: en
-title: 'API docs: repository-json-schema.getfilterjsonschemafor'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository-json-schema
-permalink: /doc/en/lb4/apidocs.repository-json-schema.getfilterjsonschemafor.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository-json-schema](./repository-json-schema.md) &gt; [getFilterJsonSchemaFor](./repository-json-schema.getfilterjsonschemafor.md)
-
-## getFilterJsonSchemaFor() function
-
-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.
-
-**Signature:**
-
-```typescript
-export declare function getFilterJsonSchemaFor(modelCtor: typeof Model, options?: FilterSchemaOptions): JsonSchema;
-```
-
-## Parameters
-
-|  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) | _(Optional)_ Options to build the filter schema. |
-
-**Returns:**
-
-JsonSchema
-
-

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

@@ -1,37 +0,0 @@
----
-lang: en
-title: 'API docs: repository-json-schema.getjsonschema'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository-json-schema
-permalink: /doc/en/lb4/apidocs.repository-json-schema.getjsonschema.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository-json-schema](./repository-json-schema.md) &gt; [getJsonSchema](./repository-json-schema.getjsonschema.md)
-
-## getJsonSchema() function
-
-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.
-
-**Signature:**
-
-```typescript
-export declare function getJsonSchema<T extends object>(ctor: Function & {
-    prototype: T;
-}, options?: JsonSchemaOptions<T>): JsonSchema;
-```
-
-## Parameters
-
-|  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; | _(Optional)_ |
-
-**Returns:**
-
-JsonSchema
-
-

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

@@ -1,54 +0,0 @@
----
-lang: en
-title: 'API docs: repository-json-schema.getjsonschemaref'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository-json-schema
-permalink: /doc/en/lb4/apidocs.repository-json-schema.getjsonschemaref.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository-json-schema](./repository-json-schema.md) &gt; [getJsonSchemaRef](./repository-json-schema.getjsonschemaref.md)
-
-## getJsonSchemaRef() function
-
-Describe the provided Model as a reference to a definition shared by multiple endpoints. The definition is included in the returned schema.
-
-**Signature:**
-
-```typescript
-export declare function getJsonSchemaRef<T extends object>(modelCtor: Function & {
-    prototype: T;
-}, options?: JsonSchemaOptions<T>): JsonSchema;
-```
-
-## Parameters
-
-|  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; | _(Optional)_ Additional options |
-
-**Returns:**
-
-JsonSchema
-
-## Example
-
-
-```ts
-const schema = {
-  $ref: '/definitions/Product',
-  definitions: {
-    Product: {
-      title: 'Product',
-      properties: {
-        // etc.
-      }
-    }
-  }
-}
-```
-
-

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

@@ -1,35 +0,0 @@
----
-lang: en
-title: 'API docs: repository-json-schema.getnavigationalpropertyforrelation'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository-json-schema
-permalink: /doc/en/lb4/apidocs.repository-json-schema.getnavigationalpropertyforrelation.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository-json-schema](./repository-json-schema.md) &gt; [getNavigationalPropertyForRelation](./repository-json-schema.getnavigationalpropertyforrelation.md)
-
-## getNavigationalPropertyForRelation() function
-
-Checks and return navigational property definition for the relation
-
-**Signature:**
-
-```typescript
-export declare function getNavigationalPropertyForRelation(relMeta: RelationMetadata, targetRef: JsonSchema): JsonSchema;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  relMeta | [RelationMetadata](./repository.relationmetadata.md) | Relation metadata object |
-|  targetRef | JsonSchema | Schema definition for the target model |
-
-**Returns:**
-
-JsonSchema
-
-

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

@@ -1,37 +0,0 @@
----
-lang: en
-title: 'API docs: repository-json-schema.getscopefilterjsonschemafor'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository-json-schema
-permalink: /doc/en/lb4/apidocs.repository-json-schema.getscopefilterjsonschemafor.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository-json-schema](./repository-json-schema.md) &gt; [getScopeFilterJsonSchemaFor](./repository-json-schema.getscopefilterjsonschemafor.md)
-
-## getScopeFilterJsonSchemaFor() function
-
-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.
-
-**Signature:**
-
-```typescript
-export declare function getScopeFilterJsonSchemaFor(modelCtor: typeof Model, options?: FilterSchemaOptions): JsonSchema;
-```
-
-## Parameters
-
-|  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) | _(Optional)_ |
-
-**Returns:**
-
-JsonSchema
-
-

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

@@ -1,37 +0,0 @@
----
-lang: en
-title: 'API docs: repository-json-schema.getwherejsonschemafor'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository-json-schema
-permalink: /doc/en/lb4/apidocs.repository-json-schema.getwherejsonschemafor.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository-json-schema](./repository-json-schema.md) &gt; [getWhereJsonSchemaFor](./repository-json-schema.getwherejsonschemafor.md)
-
-## getWhereJsonSchemaFor() function
-
-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.
-
-**Signature:**
-
-```typescript
-export declare function getWhereJsonSchemaFor(modelCtor: typeof Model, options?: FilterSchemaOptions): JsonSchema;
-```
-
-## Parameters
-
-|  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) | _(Optional)_ |
-
-**Returns:**
-
-JsonSchema
-
-

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

@@ -1,34 +0,0 @@
----
-lang: en
-title: 'API docs: repository-json-schema.isarraytype'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository-json-schema
-permalink: /doc/en/lb4/apidocs.repository-json-schema.isarraytype.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository-json-schema](./repository-json-schema.md) &gt; [isArrayType](./repository-json-schema.isarraytype.md)
-
-## isArrayType() function
-
-Determines whether a given string or constructor is array type or not
-
-**Signature:**
-
-```typescript
-export declare function isArrayType(type: string | Function | PropertyType): boolean;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  type | string \| Function \| [PropertyType](./repository.propertytype.md) | Type as string or wrapper |
-
-**Returns:**
-
-boolean
-
-

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

@@ -1,25 +0,0 @@
----
-lang: en
-title: 'API docs: repository-json-schema.json_schema_key'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository-json-schema
-permalink: /doc/en/lb4/apidocs.repository-json-schema.json_schema_key.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository-json-schema](./repository-json-schema.md) &gt; [JSON\_SCHEMA\_KEY](./repository-json-schema.json_schema_key.md)
-
-## JSON\_SCHEMA\_KEY variable
-
-Metadata key used to set or retrieve repository JSON Schema
-
-**Signature:**
-
-```typescript
-JSON_SCHEMA_KEY: MetadataAccessor<{
-    [key: string]: JsonSchema;
-}, ClassDecorator>
-```
-

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

@@ -1,23 +0,0 @@
----
-lang: en
-title: 'API docs: repository-json-schema.jsonschemaoptions.exclude'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository-json-schema
-permalink: /doc/en/lb4/apidocs.repository-json-schema.jsonschemaoptions.exclude.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository-json-schema](./repository-json-schema.md) &gt; [JsonSchemaOptions](./repository-json-schema.jsonschemaoptions.md) &gt; [exclude](./repository-json-schema.jsonschemaoptions.exclude.md)
-
-## JsonSchemaOptions.exclude property
-
-List of model properties to exclude from the schema.
-
-**Signature:**
-
-```typescript
-exclude?: (keyof T)[];
-```
-

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

@@ -1,23 +0,0 @@
----
-lang: en
-title: 'API docs: repository-json-schema.jsonschemaoptions.includerelations'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository-json-schema
-permalink: /doc/en/lb4/apidocs.repository-json-schema.jsonschemaoptions.includerelations.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository-json-schema](./repository-json-schema.md) &gt; [JsonSchemaOptions](./repository-json-schema.jsonschemaoptions.md) &gt; [includeRelations](./repository-json-schema.jsonschemaoptions.includerelations.md)
-
-## JsonSchemaOptions.includeRelations property
-
-Set this flag if you want the schema to define navigational properties for model relations.
-
-**Signature:**
-
-```typescript
-includeRelations?: boolean;
-```
-

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

@@ -1,32 +0,0 @@
----
-lang: en
-title: 'API docs: repository-json-schema.jsonschemaoptions'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository-json-schema
-permalink: /doc/en/lb4/apidocs.repository-json-schema.jsonschemaoptions.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository-json-schema](./repository-json-schema.md) &gt; [JsonSchemaOptions](./repository-json-schema.jsonschemaoptions.md)
-
-## JsonSchemaOptions interface
-
-**Signature:**
-
-```typescript
-export interface JsonSchemaOptions<T extends object> 
-```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [exclude?](./repository-json-schema.jsonschemaoptions.exclude.md) |  | (keyof T)\[\] | _(Optional)_ List of model properties to exclude from the schema. |
-|  [includeRelations?](./repository-json-schema.jsonschemaoptions.includerelations.md) |  | boolean | _(Optional)_ Set this flag if you want the schema to define navigational properties for model relations. |
-|  [optional?](./repository-json-schema.jsonschemaoptions.optional.md) |  | (keyof T)\[\] | _(Optional)_ 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>_(Optional)_ 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>_(Optional)_ 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.jsonschemaoptions.optional.md

@@ -1,23 +0,0 @@
----
-lang: en
-title: 'API docs: repository-json-schema.jsonschemaoptions.optional'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository-json-schema
-permalink: /doc/en/lb4/apidocs.repository-json-schema.jsonschemaoptions.optional.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository-json-schema](./repository-json-schema.md) &gt; [JsonSchemaOptions](./repository-json-schema.jsonschemaoptions.md) &gt; [optional](./repository-json-schema.jsonschemaoptions.optional.md)
-
-## JsonSchemaOptions.optional property
-
-List of model properties to mark as optional. Overrides the "partial" option if it is not empty.
-
-**Signature:**
-
-```typescript
-optional?: (keyof T)[];
-```
-