Page Contents

Home > @loopback/repository-json-schema > getWhereJsonSchemaFor

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:

export declare function getWhereJsonSchemaFor(modelCtor: typeof Model, options?: FilterSchemaOptions): JsonSchema;

Parameters

Parameter Type Description
modelCtor typeof Model The model constructor to build the filter schema for.
options FilterSchemaOptions (Optional)

Returns:

JsonSchema