feat(cli): update controller template to enable filter for findById endpoint

Author: Agnes Lin

docs/site/Controller-generator.md

@@ -202,12 +202,19 @@ export class TodoController {
     responses: {
       '200': {
         description: 'Todo model instance',
-        content: {'application/json': {schema: getModelSchemaRef(Todo)}},
+        content: {
+          'application/json': {
+            schema: getModelSchemaRef(Todo, {includeRelations: true}),
+          },
+        },
       },
     },
   })
-  async findById(@param.path.number('id') id: number): Promise<Todo> {
-    return this.todoRepository.findById(id);
+  async findById(
+    @param.path.number('id') id: number,
+    @param.query.object('filter', getFilterSchemaFor(Todo)) filter?: Filter<Todo>
+  ): Promise<Todo> {
+    return this.todoRepository.findById(id, filter);
   }
 
   @patch('/todos/{id}', {

docs/site/Sequence.md

@@ -231,15 +231,25 @@ from the path object.
   responses: {
     '200': {
       description: 'Note model instance',
-      content: {'application/json': {schema: getModelSchemaRef(Note)}},
+      content: {
+        'application/json': {
+          schema: getModelSchemaRef(Note, {includeRelations: true}),
+        },
+      },
     },
   },
 })
-async findById(@param.path.string('id') id: string): Promise<Note> {
-  return this.noteRepository.findById(id);
+async findById(
+  @param.path.string('id') id: string,
+  @param.query.object('filter', getFilterSchemaFor(Note)) filter?: Filter<Note>
+): Promise<Note> {
+  return this.noteRepository.findById(id, filter);
 }
 ```
 
+(Notice: the filter for `findById()` method only supports the `include` clause
+for now.)
+
 You can also specify a parameter which is an object value encoded as a JSON
 string or in multiple nested keys. For a JSON string, a sample value would be
 `location={"lang": 23.414, "lat": -98.1515}`. For the same `location` object, it
@@ -378,7 +388,7 @@ details.
   ```
 
 During development and testing, it may be useful to see all error details in the
-HTTP responsed returned by the server. This behavior can be enabled by enabling
+HTTP response returned by the server. This behavior can be enabled by enabling
 the `debug` flag in error-handler configuration as shown in the code example
 below. See strong-error-handler
 [docs](https://github.com/strongloop/strong-error-handler#options) for a list of

packages/cli/generators/controller/templates/src/controllers/controller-rest-template.ts.ejs

@@ -70,7 +70,10 @@ export class <%= className %>Controller {
         description: 'Array of <%= modelName %> model instances',
         content: {
           'application/json': {
-            schema: {type: 'array', items: getModelSchemaRef(<%= modelName %>)},
+            schema: {
+              type: 'array',
+              items: getModelSchemaRef(<%= modelName %>, {includeRelations: true}),
+            },
           },
         },
       },
@@ -108,12 +111,19 @@ export class <%= className %>Controller {
     responses: {
       '200': {
         description: '<%= modelName %> model instance',
-        content: {'application/json': {schema: getModelSchemaRef(<%= modelName %>)}},
+        content: {
+          'application/json': {
+            schema: getModelSchemaRef(<%= modelName %>, {includeRelations: true}),
+          },
+        },
       },
     },
   })
-  async findById(@param.path.<%= idType %>('id') id: <%= idType %>): Promise<<%= modelName %>> {
-    return this.<%= repositoryNameCamel %>.findById(id);
+  async findById(
+    @param.path.<%= idType %>('id') id: <%= idType %>,
+    @param.query.object('filter', getFilterSchemaFor(<%= modelName %>)) filter?: Filter<<%= modelName %>>
+  ): Promise<<%= modelName %>> {
+    return this.<%= repositoryNameCamel %>.findById(id, filter);
   }
 
   @patch('<%= httpPathName %>/{id}', {

packages/cli/snapshots/integration/generators/controller.integration.snapshots.js

@@ -80,7 +80,10 @@ export class ProductReviewController {
         description: 'Array of ProductReview model instances',
         content: {
           'application/json': {
-            schema: {type: 'array', items: getModelSchemaRef(ProductReview)},
+            schema: {
+              type: 'array',
+              items: getModelSchemaRef(ProductReview, {includeRelations: true}),
+            },
           },
         },
       },
@@ -118,12 +121,19 @@ export class ProductReviewController {
     responses: {
       '200': {
         description: 'ProductReview model instance',
-        content: {'application/json': {schema: getModelSchemaRef(ProductReview)}},
+        content: {
+          'application/json': {
+            schema: getModelSchemaRef(ProductReview, {includeRelations: true}),
+          },
+        },
       },
     },
   })
-  async findById(@param.path.number('id') id: number): Promise<ProductReview> {
-    return this.barRepository.findById(id);
+  async findById(
+    @param.path.number('id') id: number,
+    @param.query.object('filter', getFilterSchemaFor(ProductReview)) filter?: Filter<ProductReview>
+  ): Promise<ProductReview> {
+    return this.barRepository.findById(id, filter);
   }
 
   @patch('/product-reviews/{id}', {
@@ -249,7 +259,10 @@ export class ProductReviewController {
         description: 'Array of ProductReview model instances',
         content: {
           'application/json': {
-            schema: {type: 'array', items: getModelSchemaRef(ProductReview)},
+            schema: {
+              type: 'array',
+              items: getModelSchemaRef(ProductReview, {includeRelations: true}),
+            },
           },
         },
       },
@@ -287,12 +300,19 @@ export class ProductReviewController {
     responses: {
       '200': {
         description: 'ProductReview model instance',
-        content: {'application/json': {schema: getModelSchemaRef(ProductReview)}},
+        content: {
+          'application/json': {
+            schema: getModelSchemaRef(ProductReview, {includeRelations: true}),
+          },
+        },
       },
     },
   })
-  async findById(@param.path.number('id') id: number): Promise<ProductReview> {
-    return this.barRepository.findById(id);
+  async findById(
+    @param.path.number('id') id: number,
+    @param.query.object('filter', getFilterSchemaFor(ProductReview)) filter?: Filter<ProductReview>
+  ): Promise<ProductReview> {
+    return this.barRepository.findById(id, filter);
   }
 
   @patch('/product-reviews/{id}', {