@loopback/repository-json-schema 1.11.3 → 1.12.2

package/CHANGELOG.md

@@ -3,6 +3,42 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.12.2](https://github.com/strongloop/loopback-next/compare/@loopback/repository-json-schema@1.12.1...@loopback/repository-json-schema@1.12.2) (2020-02-06)
+
+**Note:** Version bump only for package @loopback/repository-json-schema
+
+
+
+
+
+## [1.12.1](https://github.com/strongloop/loopback-next/compare/@loopback/repository-json-schema@1.12.0...@loopback/repository-json-schema@1.12.1) (2020-02-05)
+
+**Note:** Version bump only for package @loopback/repository-json-schema
+
+
+
+
+
+# [1.12.0](https://github.com/strongloop/loopback-next/compare/@loopback/repository-json-schema@1.11.4...@loopback/repository-json-schema@1.12.0) (2020-01-27)
+
+
+### Features
+
+* **repository-json-schema:** add filter title ([2d65971](https://github.com/strongloop/loopback-next/commit/2d6597133885c16c132221cef80893093fa3d289))
+* **repository-json-schema:** add title to filter schemas ([6105883](https://github.com/strongloop/loopback-next/commit/6105883967ca5853cc8990f423d9febd1eb07101))
+
+
+
+
+
+## [1.11.4](https://github.com/strongloop/loopback-next/compare/@loopback/repository-json-schema@1.11.3...@loopback/repository-json-schema@1.11.4) (2020-01-07)
+
+**Note:** Version bump only for package @loopback/repository-json-schema
+
+
+
+
+
 ## [1.11.3](https://github.com/strongloop/loopback-next/compare/@loopback/repository-json-schema@1.11.2...@loopback/repository-json-schema@1.11.3) (2019-12-09)
 
 **Note:** Version bump only for package @loopback/repository-json-schema

package/dist/filter-json-schema.d.ts

@@ -1,5 +1,24 @@
 import { Model } from '@loopback/repository';
 import { JSONSchema6 as JsonSchema } from 'json-schema';
+export interface FilterSchemaOptions {
+    /**
+     * Set this flag if you want the schema to set generated title property.
+     *
+     * By default the setting is enabled. (e.g. {setTitle: true})
+     *
+     */
+    setTitle?: boolean;
+}
+/**
+ * Build a JSON schema describing the format of the "scope" 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.
+ *
+ * @param modelCtor - The model constructor to build the filter schema for.
+ */
+export declare function getScopeFilterJsonSchemaFor(modelCtor: typeof Model, options?: FilterSchemaOptions): JsonSchema;
 /**
  * Build a JSON schema describing the format of the "filter" object
  * used to query model instances.
@@ -9,7 +28,7 @@ import { JSONSchema6 as JsonSchema } from 'json-schema';
  *
  * @param modelCtor - The model constructor to build the filter schema for.
  */
-export declare function getFilterJsonSchemaFor(modelCtor: typeof Model): JsonSchema;
+export declare function getFilterJsonSchemaFor(modelCtor: typeof Model, options?: FilterSchemaOptions): JsonSchema;
 /**
  * Build a JSON schema describing the format of the "where" object
  * used to filter model instances to query, update or delete.
@@ -19,11 +38,11 @@ export declare function getFilterJsonSchemaFor(modelCtor: typeof Model): JsonSch
  *
  * @param modelCtor - The model constructor to build the filter schema for.
  */
-export declare function getWhereJsonSchemaFor(modelCtor: typeof Model): JsonSchema;
+export declare function getWhereJsonSchemaFor(modelCtor: typeof Model, options?: FilterSchemaOptions): JsonSchema;
 /**
  * Build a JSON schema describing the format of the "fields" object
  * used to include or exclude properties of model instances.
  *
  * @param modelCtor - The model constructor to build the filter schema for.
  */
-export declare function getFieldsJsonSchemaFor(modelCtor: typeof Model): JsonSchema;
+export declare function getFieldsJsonSchemaFor(modelCtor: typeof Model, options?: FilterSchemaOptions): JsonSchema;

package/dist/filter-json-schema.js

@@ -11,12 +11,27 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const repository_1 = require("@loopback/repository");
-let EmptyModel = class EmptyModel extends repository_1.Model {
-};
-EmptyModel = __decorate([
-    repository_1.model({ settings: { strict: false } })
-], EmptyModel);
-const scopeFilter = getFilterJsonSchemaFor(EmptyModel);
+/**
+ * Build a JSON schema describing the format of the "scope" 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.
+ *
+ * @param modelCtor - The model constructor to build the filter schema for.
+ */
+function getScopeFilterJsonSchemaFor(modelCtor, options = {}) {
+    let EmptyModel = class EmptyModel extends repository_1.Model {
+    };
+    EmptyModel = __decorate([
+        repository_1.model({ settings: { strict: false } })
+    ], EmptyModel);
+    const schema = Object.assign(Object.assign({}, getFilterJsonSchemaFor(EmptyModel, { setTitle: false })), (options.setTitle !== false && {
+        title: `${modelCtor.modelName}.ScopeFilter`,
+    }));
+    return schema;
+}
+exports.getScopeFilterJsonSchemaFor = getScopeFilterJsonSchemaFor;
 /**
  * Build a JSON schema describing the format of the "filter" object
  * used to query model instances.
@@ -26,11 +41,12 @@ const scopeFilter = getFilterJsonSchemaFor(EmptyModel);
  *
  * @param modelCtor - The model constructor to build the filter schema for.
  */
-function getFilterJsonSchemaFor(modelCtor) {
-    const schema = {
-        properties: {
-            where: getWhereJsonSchemaFor(modelCtor),
-            fields: getFieldsJsonSchemaFor(modelCtor),
+function getFilterJsonSchemaFor(modelCtor, options = {}) {
+    const schema = Object.assign(Object.assign({}, (options.setTitle !== false && {
+        title: `${modelCtor.modelName}.Filter`,
+    })), { properties: {
+            where: getWhereJsonSchemaFor(modelCtor, options),
+            fields: getFieldsJsonSchemaFor(modelCtor, options),
             offset: {
                 type: 'integer',
                 minimum: 0,
@@ -50,24 +66,20 @@ function getFilterJsonSchemaFor(modelCtor) {
                     type: 'string',
                 },
             },
-        },
-        additionalProperties: false,
-    };
+        }, additionalProperties: false });
     const modelRelations = repository_1.getModelRelations(modelCtor);
     const hasRelations = Object.keys(modelRelations).length > 0;
     if (hasRelations) {
-        schema.properties.include = {
-            type: 'array',
-            items: {
-                type: 'object',
-                properties: {
+        schema.properties.include = Object.assign(Object.assign({}, (options.setTitle !== false && {
+            title: `${modelCtor.modelName}.IncludeFilter`,
+        })), { type: 'array', items: Object.assign(Object.assign({}, (options.setTitle !== false && {
+                title: `${modelCtor.modelName}.IncludeFilter.Items`,
+            })), { type: 'object', properties: {
                     // TODO(bajtos) restrict values to relations defined by "model"
                     relation: { type: 'string' },
                     // TODO(bajtos) describe the filter for the relation target model
-                    scope: scopeFilter,
-                },
-            },
-        };
+                    scope: getScopeFilterJsonSchemaFor(modelCtor, options),
+                } }) });
     }
     return schema;
 }
@@ -81,13 +93,13 @@ exports.getFilterJsonSchemaFor = getFilterJsonSchemaFor;
  *
  * @param modelCtor - The model constructor to build the filter schema for.
  */
-function getWhereJsonSchemaFor(modelCtor) {
-    const schema = {
-        type: 'object',
+function getWhereJsonSchemaFor(modelCtor, options = {}) {
+    const schema = Object.assign(Object.assign({}, (options.setTitle !== false && {
+        title: `${modelCtor.modelName}.WhereFilter`,
+    })), { type: 'object', 
         // TODO(bajtos) enumerate "model" properties and operators like "and"
         // See https://github.com/strongloop/loopback-next/issues/1748
-        additionalProperties: true,
-    };
+        additionalProperties: true });
     return schema;
 }
 exports.getWhereJsonSchemaFor = getWhereJsonSchemaFor;
@@ -97,14 +109,12 @@ exports.getWhereJsonSchemaFor = getWhereJsonSchemaFor;
  *
  * @param modelCtor - The model constructor to build the filter schema for.
  */
-function getFieldsJsonSchemaFor(modelCtor) {
-    const schema = {
-        type: 'object',
-        properties: Object.assign({}, ...Object.keys(modelCtor.definition.properties).map(k => ({
+function getFieldsJsonSchemaFor(modelCtor, options = {}) {
+    const schema = Object.assign(Object.assign({}, (options.setTitle !== false && {
+        title: `${modelCtor.modelName}.Fields`,
+    })), { type: 'object', properties: Object.assign({}, ...Object.keys(modelCtor.definition.properties).map(k => ({
             [k]: { type: 'boolean' },
-        }))),
-        additionalProperties: modelCtor.definition.settings.strict === false,
-    };
+        }))), additionalProperties: modelCtor.definition.settings.strict === false });
     return schema;
 }
 exports.getFieldsJsonSchemaFor = getFieldsJsonSchemaFor;

package/dist/filter-json-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"filter-json-schema.js","sourceRoot":"","sources":["../src/filter-json-schema.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,gDAAgD;AAChD,+CAA+C;AAC/C,gEAAgE;;;;;;;;AAEhE,qDAAqE;AAIrE,IAAM,UAAU,GAAhB,MAAM,UAAW,SAAQ,kBAAK;CAAG,CAAA;AAA3B,UAAU;IADf,kBAAK,CAAC,EAAC,QAAQ,EAAE,EAAC,MAAM,EAAE,KAAK,EAAC,EAAC,CAAC;GAC7B,UAAU,CAAiB;AAEjC,MAAM,WAAW,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;AAEvD;;;;;;;;GAQG;AACH,SAAgB,sBAAsB,CAAC,SAAuB;IAC5D,MAAM,MAAM,GAAe;QACzB,UAAU,EAAE;YACV,KAAK,EAAE,qBAAqB,CAAC,SAAS,CAAC;YAEvC,MAAM,EAAE,sBAAsB,CAAC,SAAS,CAAC;YAEzC,MAAM,EAAE;gBACN,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,CAAC;aACX;YAED,KAAK,EAAE;gBACL,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,CAAC;gBACV,QAAQ,EAAE,CAAC,GAAG,CAAC;aAChB;YAED,IAAI,EAAE;gBACJ,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,CAAC;aACX;YAED,KAAK,EAAE;gBACL,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;iBACf;aACF;SACF;QACD,oBAAoB,EAAE,KAAK;KAC5B,CAAC;IAEF,MAAM,cAAc,GAAG,8BAAiB,CAAC,SAAS,CAAC,CAAC;IACpD,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IAE5D,IAAI,YAAY,EAAE;QAChB,MAAM,CAAC,UAAW,CAAC,OAAO,GAAG;YAC3B,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,+DAA+D;oBAC/D,QAAQ,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAC;oBAC1B,iEAAiE;oBACjE,KAAK,EAAE,WAAW;iBACnB;aACF;SACF,CAAC;KACH;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AApDD,wDAoDC;AAED;;;;;;;;GAQG;AACH,SAAgB,qBAAqB,CAAC,SAAuB;IAC3D,MAAM,MAAM,GAAe;QACzB,IAAI,EAAE,QAAQ;QACd,qEAAqE;QACrE,8DAA8D;QAC9D,oBAAoB,EAAE,IAAI;KAC3B,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC;AARD,sDAQC;AAED;;;;;GAKG;AAEH,SAAgB,sBAAsB,CAAC,SAAuB;IAC5D,MAAM,MAAM,GAAe;QACzB,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,MAAM,CAAC,MAAM,CACvB,EAAE,EACF,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACxD,CAAC,CAAC,CAAC,EAAE,EAAC,IAAI,EAAE,SAAS,EAAC;SACvB,CAAC,CAAC,CACJ;QACD,oBAAoB,EAAE,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,KAAK,KAAK;KACrE,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC;AAZD,wDAYC"}
+{"version":3,"file":"filter-json-schema.js","sourceRoot":"","sources":["../src/filter-json-schema.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,gDAAgD;AAChD,+CAA+C;AAC/C,gEAAgE;;;;;;;;AAEhE,qDAAqE;AAarE;;;;;;;;GAQG;AACH,SAAgB,2BAA2B,CACzC,SAAuB,EACvB,UAA+B,EAAE;IAGjC,IAAM,UAAU,GAAhB,MAAM,UAAW,SAAQ,kBAAK;KAAG,CAAA;IAA3B,UAAU;QADf,kBAAK,CAAC,EAAC,QAAQ,EAAE,EAAC,MAAM,EAAE,KAAK,EAAC,EAAC,CAAC;OAC7B,UAAU,CAAiB;IAEjC,MAAM,MAAM,mCACP,sBAAsB,CAAC,UAAU,EAAE,EAAC,QAAQ,EAAE,KAAK,EAAC,CAAC,GACrD,CAAC,OAAO,CAAC,QAAQ,KAAK,KAAK,IAAI;QAChC,KAAK,EAAE,GAAG,SAAS,CAAC,SAAS,cAAc;KAC5C,CAAC,CACH,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AAfD,kEAeC;AAED;;;;;;;;GAQG;AACH,SAAgB,sBAAsB,CACpC,SAAuB,EACvB,UAA+B,EAAE;IAEjC,MAAM,MAAM,mCACP,CAAC,OAAO,CAAC,QAAQ,KAAK,KAAK,IAAI;QAChC,KAAK,EAAE,GAAG,SAAS,CAAC,SAAS,SAAS;KACvC,CAAC,KACF,UAAU,EAAE;YACV,KAAK,EAAE,qBAAqB,CAAC,SAAS,EAAE,OAAO,CAAC;YAEhD,MAAM,EAAE,sBAAsB,CAAC,SAAS,EAAE,OAAO,CAAC;YAElD,MAAM,EAAE;gBACN,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,CAAC;aACX;YAED,KAAK,EAAE;gBACL,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,CAAC;gBACV,QAAQ,EAAE,CAAC,GAAG,CAAC;aAChB;YAED,IAAI,EAAE;gBACJ,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,CAAC;aACX;YAED,KAAK,EAAE;gBACL,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;iBACf;aACF;SACF,EACD,oBAAoB,EAAE,KAAK,GAC5B,CAAC;IAEF,MAAM,cAAc,GAAG,8BAAiB,CAAC,SAAS,CAAC,CAAC;IACpD,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IAE5D,IAAI,YAAY,EAAE;QAChB,MAAM,CAAC,UAAW,CAAC,OAAO,mCACrB,CAAC,OAAO,CAAC,QAAQ,KAAK,KAAK,IAAI;YAChC,KAAK,EAAE,GAAG,SAAS,CAAC,SAAS,gBAAgB;SAC9C,CAAC,KACF,IAAI,EAAE,OAAO,EACb,KAAK,kCACA,CAAC,OAAO,CAAC,QAAQ,KAAK,KAAK,IAAI;gBAChC,KAAK,EAAE,GAAG,SAAS,CAAC,SAAS,sBAAsB;aACpD,CAAC,KACF,IAAI,EAAE,QAAQ,EACd,UAAU,EAAE;oBACV,+DAA+D;oBAC/D,QAAQ,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAC;oBAC1B,iEAAiE;oBACjE,KAAK,EAAE,2BAA2B,CAAC,SAAS,EAAE,OAAO,CAAC;iBACvD,MAEJ,CAAC;KACH;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAhED,wDAgEC;AAED;;;;;;;;GAQG;AACH,SAAgB,qBAAqB,CACnC,SAAuB,EACvB,UAA+B,EAAE;IAEjC,MAAM,MAAM,mCACP,CAAC,OAAO,CAAC,QAAQ,KAAK,KAAK,IAAI;QAChC,KAAK,EAAE,GAAG,SAAS,CAAC,SAAS,cAAc;KAC5C,CAAC,KACF,IAAI,EAAE,QAAQ;QACd,qEAAqE;QACrE,8DAA8D;QAC9D,oBAAoB,EAAE,IAAI,GAC3B,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AAfD,sDAeC;AAED;;;;;GAKG;AAEH,SAAgB,sBAAsB,CACpC,SAAuB,EACvB,UAA+B,EAAE;IAEjC,MAAM,MAAM,mCACP,CAAC,OAAO,CAAC,QAAQ,KAAK,KAAK,IAAI;QAChC,KAAK,EAAE,GAAG,SAAS,CAAC,SAAS,SAAS;KACvC,CAAC,KACF,IAAI,EAAE,QAAQ,EAEd,UAAU,EAAE,MAAM,CAAC,MAAM,CACvB,EAAE,EACF,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACxD,CAAC,CAAC,CAAC,EAAE,EAAC,IAAI,EAAE,SAAS,EAAC;SACvB,CAAC,CAAC,CACJ,EACD,oBAAoB,EAAE,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,KAAK,KAAK,GACrE,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AApBD,wDAoBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loopback/repository-json-schema",
-  "version": "1.11.3",
+  "version": "1.12.2",
   "description": "Converts TS classes into JSON Schemas using TypeScript's reflection API",
   "engines": {
     "node": ">=8.9"
@@ -23,19 +23,19 @@
     "access": "public"
   },
   "dependencies": {
-    "@loopback/context": "^1.25.0",
-    "@loopback/metadata": "^1.3.9",
-    "@loopback/repository": "^1.16.0",
-    "@types/json-schema": "^7.0.3",
+    "@loopback/context": "^2.1.1",
+    "@loopback/metadata": "^1.4.1",
+    "@loopback/repository": "^1.19.1",
+    "@types/json-schema": "^7.0.4",
     "debug": "^4.1.1"
   },
   "devDependencies": {
-    "@loopback/build": "^3.0.0",
-    "@loopback/eslint-config": "^5.0.0",
-    "@loopback/testlab": "^1.10.0",
+    "@loopback/build": "^3.1.1",
+    "@loopback/eslint-config": "^5.0.3",
+    "@loopback/testlab": "^1.10.3",
     "@types/debug": "^4.1.5",
-    "@types/node": "^10.17.6",
-    "ajv": "^6.10.2"
+    "@types/node": "^10.17.14",
+    "ajv": "^6.11.0"
   },
   "files": [
     "README.md",
@@ -50,5 +50,5 @@
     "url": "https://github.com/strongloop/loopback-next.git",
     "directory": "packages/repository-json-schema"
   },
-  "gitHead": "89eb61bacaed75e6eb61ae6840cea266cb888659"
+  "gitHead": "6eea5e428b145cafb84a998bd53979da8c8fba07"
 }

package/src/filter-json-schema.ts

@@ -6,10 +6,41 @@
 import {getModelRelations, Model, model} from '@loopback/repository';
 import {JSONSchema6 as JsonSchema} from 'json-schema';
 
-@model({settings: {strict: false}})
-class EmptyModel extends Model {}
+export interface FilterSchemaOptions {
+  /**
+   * Set this flag if you want the schema to set generated title property.
+   *
+   * By default the setting is enabled. (e.g. {setTitle: true})
+   *
+   */
+  setTitle?: boolean;
+}
+
+/**
+ * Build a JSON schema describing the format of the "scope" 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.
+ *
+ * @param modelCtor - The model constructor to build the filter schema for.
+ */
+export function getScopeFilterJsonSchemaFor(
+  modelCtor: typeof Model,
+  options: FilterSchemaOptions = {},
+): JsonSchema {
+  @model({settings: {strict: false}})
+  class EmptyModel extends Model {}
 
-const scopeFilter = getFilterJsonSchemaFor(EmptyModel);
+  const schema: JsonSchema = {
+    ...getFilterJsonSchemaFor(EmptyModel, {setTitle: false}),
+    ...(options.setTitle !== false && {
+      title: `${modelCtor.modelName}.ScopeFilter`,
+    }),
+  };
+
+  return schema;
+}
 
 /**
  * Build a JSON schema describing the format of the "filter" object
@@ -20,12 +51,18 @@ const scopeFilter = getFilterJsonSchemaFor(EmptyModel);
  *
  * @param modelCtor - The model constructor to build the filter schema for.
  */
-export function getFilterJsonSchemaFor(modelCtor: typeof Model): JsonSchema {
+export function getFilterJsonSchemaFor(
+  modelCtor: typeof Model,
+  options: FilterSchemaOptions = {},
+): JsonSchema {
   const schema: JsonSchema = {
+    ...(options.setTitle !== false && {
+      title: `${modelCtor.modelName}.Filter`,
+    }),
     properties: {
-      where: getWhereJsonSchemaFor(modelCtor),
+      where: getWhereJsonSchemaFor(modelCtor, options),
 
-      fields: getFieldsJsonSchemaFor(modelCtor),
+      fields: getFieldsJsonSchemaFor(modelCtor, options),
 
       offset: {
         type: 'integer',
@@ -58,14 +95,20 @@ export function getFilterJsonSchemaFor(modelCtor: typeof Model): JsonSchema {
 
   if (hasRelations) {
     schema.properties!.include = {
+      ...(options.setTitle !== false && {
+        title: `${modelCtor.modelName}.IncludeFilter`,
+      }),
       type: 'array',
       items: {
+        ...(options.setTitle !== false && {
+          title: `${modelCtor.modelName}.IncludeFilter.Items`,
+        }),
         type: 'object',
         properties: {
           // TODO(bajtos) restrict values to relations defined by "model"
           relation: {type: 'string'},
           // TODO(bajtos) describe the filter for the relation target model
-          scope: scopeFilter,
+          scope: getScopeFilterJsonSchemaFor(modelCtor, options),
         },
       },
     };
@@ -83,13 +126,20 @@ export function getFilterJsonSchemaFor(modelCtor: typeof Model): JsonSchema {
  *
  * @param modelCtor - The model constructor to build the filter schema for.
  */
-export function getWhereJsonSchemaFor(modelCtor: typeof Model): JsonSchema {
+export function getWhereJsonSchemaFor(
+  modelCtor: typeof Model,
+  options: FilterSchemaOptions = {},
+): JsonSchema {
   const schema: JsonSchema = {
+    ...(options.setTitle !== false && {
+      title: `${modelCtor.modelName}.WhereFilter`,
+    }),
     type: 'object',
     // TODO(bajtos) enumerate "model" properties and operators like "and"
     // See https://github.com/strongloop/loopback-next/issues/1748
     additionalProperties: true,
   };
+
   return schema;
 }
 
@@ -100,9 +150,16 @@ export function getWhereJsonSchemaFor(modelCtor: typeof Model): JsonSchema {
  * @param modelCtor - The model constructor to build the filter schema for.
  */
 
-export function getFieldsJsonSchemaFor(modelCtor: typeof Model): JsonSchema {
+export function getFieldsJsonSchemaFor(
+  modelCtor: typeof Model,
+  options: FilterSchemaOptions = {},
+): JsonSchema {
   const schema: JsonSchema = {
+    ...(options.setTitle !== false && {
+      title: `${modelCtor.modelName}.Fields`,
+    }),
     type: 'object',
+
     properties: Object.assign(
       {},
       ...Object.keys(modelCtor.definition.properties).map(k => ({
@@ -111,5 +168,6 @@ export function getFieldsJsonSchemaFor(modelCtor: typeof Model): JsonSchema {
     ),
     additionalProperties: modelCtor.definition.settings.strict === false,
   };
+
   return schema;
 }