@loopback/docs
Version:
Documentation files rendered at [https://loopback.io](https://loopback.io)
83 lines (42 loc) • 1.54 kB
Markdown
---
lang: en
title: 'API docs: openapi-v3.getfilterschemafor'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/openapi-v3
permalink: /doc/en/lb4/apidocs.openapi-v3.getfilterschemafor.html
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@loopback/openapi-v3](./openapi-v3.md) > [getFilterSchemaFor](./openapi-v3.getfilterschemafor.md)
## getFilterSchemaFor() function
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.
**Signature:**
```typescript
export declare function getFilterSchemaFor(modelCtor: typeof Model, options?: FilterSchemaOptions): SchemaObject;
```
## Parameters
<table><thead><tr><th>
Parameter
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
modelCtor
</td><td markdown="1">
typeof Model
</td><td markdown="1">
The model constructor to build the filter schema for.
</td></tr>
<tr><td markdown="1">
options
</td><td markdown="1">
[FilterSchemaOptions](./repository-json-schema.filterschemaoptions.md)
</td><td markdown="1">
_(Optional)_ Options to build the filter schema.
</td></tr>
</tbody></table>
**Returns:**
SchemaObject