@loopback/docs
Version:
Documentation for LoopBack 4
36 lines (22 loc) • 1.01 kB
Markdown
lang: en
title: 'API docs: openapi-v3.getfilterschemafor'
keywords: LoopBack 4.0, LoopBack 4
sidebar: lb4_sidebar
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.
<b>Signature:</b>
```typescript
export declare function getFilterSchemaFor(modelCtor: typeof Model): SchemaObject;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| modelCtor | <code>typeof Model</code> | The model constructor to build the filter schema for. |
<b>Returns:</b>
`SchemaObject`