@loopback/docs
Version:
Documentation for LoopBack 4
36 lines (22 loc) • 1.03 kB
Markdown
lang: en
title: 'API docs: openapi-v3.getwhereschemafor'
keywords: LoopBack 4.0, LoopBack 4
sidebar: lb4_sidebar
permalink: /doc/en/lb4/apidocs.openapi-v3.getwhereschemafor.html
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@loopback/openapi-v3](./openapi-v3.md) > [getWhereSchemaFor](./openapi-v3.getwhereschemafor.md)
## getWhereSchemaFor() function
Build a OpenAPI 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.
<b>Signature:</b>
```typescript
export declare function getWhereSchemaFor(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`