@loopback/docs
Version:
Documentation for LoopBack 4
36 lines (23 loc) • 1.17 kB
Markdown
lang: en
title: 'API docs: repository-json-schema.getfieldsjsonschemafor'
keywords: LoopBack 4.0, LoopBack 4
sidebar: lb4_sidebar
editurl: https://github.com/strongloop/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) > [@loopback/repository-json-schema](./repository-json-schema.md) > [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.
<b>Signature:</b>
```typescript
export declare function getFieldsJsonSchemaFor(modelCtor: typeof Model, options?: FilterSchemaOptions): JsonSchema;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| modelCtor | <code>typeof Model</code> | The model constructor to build the filter schema for. |
| options | <code>FilterSchemaOptions</code> | |
<b>Returns:</b>
`JsonSchema`