Emit schema with all model properties optional + allow partial updates via PATCH

docs/site/Controller-generator.md

@@ -169,10 +169,17 @@ export class TodoController {
     },
   })
   async updateAll(
-    @requestBody() data: Todo,
+    @requestBody({
+      content: {
+        'application/json': {
+          schema: getModelSchemaRef(Todo, {partial: true}),
+        },
+      },
+    })
+    todo: Partial<Todo>
     @param.query.object('where', getWhereSchemaFor(Todo)) where?: Where<Todo>,
   ): Promise<number> {
-    return await this.todoRepository.updateAll(data, where);
+    return await this.todoRepository.updateAll(todo, where);
   }
 
   @get('/todos/{id}', {
@@ -196,9 +203,16 @@ export class TodoController {
   })
   async updateById(
     @param.path.number('id') id: number,
-    @requestBody() data: Todo,
+    @requestBody({
+      content: {
+        'application/json': {
+          schema: getModelSchemaRef(Todo, {partial: true}),
+        },
+      },
+    })
+    todo: Partial<Todo>,
   ): Promise<void> {
-    await this.todoRepository.updateById(id, data);
+    await this.todoRepository.updateById(id, todo);
   }
 
   @del('/todos/{id}', {

docs/site/tutorials/todo-list/todo-list-tutorial-controller.md

@@ -256,7 +256,14 @@ export class TodoListTodoController {
   })
   async patch(
     @param.path.number('id') id: number,
-    @requestBody() todo: Partial<Todo>,
+    @requestBody({
+      content: {
+        'application/json': {
+          schema: getModelSchemaRef(Todo, {partial: true}),
+        },
+      },
+    })
+    todo: Partial<Todo>
     @param.query.object('where', getWhereSchemaFor(Todo)) where?: Where<Todo>,
   ): Promise<Count> {
     return await this.todoListRepo.todos(id).patch(todo, where);

examples/express-composition/src/controllers/note.controller.ts

@@ -14,6 +14,7 @@ import {
   del,
   get,
   getFilterSchemaFor,
+  getModelSchemaRef,
   getWhereSchemaFor,
   param,
   patch,
@@ -84,7 +85,14 @@ export class NoteController {
     },
   })
   async updateAll(
-    @requestBody() note: Note,
+    @requestBody({
+      content: {
+        'application/json': {
+          schema: getModelSchemaRef(Note, {partial: true}),
+        },
+      },
+    })
+    note: Partial<Note>,
     @param.query.object('where', getWhereSchemaFor(Note)) where?: Where<Note>,
   ): Promise<Count> {
     return await this.noteRepository.updateAll(note, where);
@@ -111,7 +119,14 @@ export class NoteController {
   })
   async updateById(
     @param.path.number('id') id: number,
-    @requestBody() note: Note,
+    @requestBody({
+      content: {
+        'application/json': {
+          schema: getModelSchemaRef(Note, {partial: true}),
+        },
+      },
+    })
+    note: Partial<Note>,
   ): Promise<void> {
     await this.noteRepository.updateById(id, note);
   }

examples/todo-list/src/controllers/todo-list-todo.controller.ts

@@ -13,6 +13,7 @@ import {
 import {
   del,
   get,
+  getModelSchemaRef,
   getWhereSchemaFor,
   param,
   patch,
@@ -71,7 +72,14 @@ export class TodoListTodoController {
   })
   async patch(
     @param.path.number('id') id: number,
-    @requestBody() todo: Partial<Todo>,
+    @requestBody({
+      content: {
+        'application/json': {
+          schema: getModelSchemaRef(Todo, {partial: true}),
+        },
+      },
+    })
+    todo: Partial<Todo>,
     @param.query.object('where', getWhereSchemaFor(Todo)) where?: Where<Todo>,
   ): Promise<Count> {
     return await this.todoListRepo.todos(id).patch(todo, where);

examples/todo-list/src/controllers/todo-list.controller.ts

@@ -88,11 +88,18 @@ export class TodoListController {
     },
   })
   async updateAll(
-    @requestBody() obj: Partial<TodoList>,
+    @requestBody({
+      content: {
+        'application/json': {
+          schema: getModelSchemaRef(TodoList, {partial: true}),
+        },
+      },
+    })
+    todoList: Partial<TodoList>,
     @param.query.object('where', getWhereSchemaFor(TodoList))
     where?: Where<TodoList>,
   ): Promise<Count> {
-    return await this.todoListRepository.updateAll(obj, where);
+    return await this.todoListRepository.updateAll(todoList, where);
   }
 
   @get('/todo-lists/{id}', {
@@ -124,9 +131,16 @@ export class TodoListController {
   })
   async updateById(
     @param.path.number('id') id: number,
-    @requestBody() obj: TodoList,
+    @requestBody({
+      content: {
+        'application/json': {
+          schema: getModelSchemaRef(TodoList, {partial: true}),
+        },
+      },
+    })
+    todoList: Partial<TodoList>,
   ): Promise<void> {
-    await this.todoListRepository.updateById(id, obj);
+    await this.todoListRepository.updateById(id, todoList);
   }
 
   @del('/todo-lists/{id}', {

examples/todo-list/src/controllers/todo.controller.ts

@@ -98,7 +98,14 @@ export class TodoController {
   })
   async updateTodo(
     @param.path.number('id') id: number,
-    @requestBody() todo: Todo,
+    @requestBody({
+      content: {
+        'application/json': {
+          schema: getModelSchemaRef(Todo, {partial: true}),
+        },
+      },
+    })
+    todo: Partial<Todo>,
   ): Promise<void> {
     await this.todoRepo.updateById(id, todo);
   }

examples/todo/src/__tests__/acceptance/todo.acceptance.ts

@@ -126,7 +126,6 @@ describe('TodoApplication', () => {
 
     it('updates the todo by ID ', async () => {
       const updatedTodo = givenTodo({
-        title: 'DO SOMETHING AWESOME',
         isComplete: true,
       });
       await client

examples/todo/src/controllers/todo.controller.ts

@@ -9,6 +9,7 @@ import {
   del,
   get,
   getFilterSchemaFor,
+  getModelSchemaRef,
   param,
   patch,
   post,
@@ -103,7 +104,14 @@ export class TodoController {
   })
   async updateTodo(
     @param.path.number('id') id: number,
-    @requestBody() todo: Todo,
+    @requestBody({
+      content: {
+        'application/json': {
+          schema: getModelSchemaRef(Todo, {partial: true}),
+        },
+      },
+    })
+    todo: Partial<Todo>,
   ): Promise<void> {
     await this.todoRepo.updateById(id, todo);
   }

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

@@ -10,6 +10,7 @@ import {
   param,
   get,
   getFilterSchemaFor,
+  getModelSchemaRef,
   getWhereSchemaFor,
   patch,
   put,
@@ -78,7 +79,14 @@ export class <%= className %>Controller {
     },
   })
   async updateAll(
-    @requestBody() <%= modelVariableName %>: <%= modelName %>,
+    @requestBody({
+      content: {
+        'application/json': {
+          schema: getModelSchemaRef(<%= modelName %>, {partial: true}),
+        },
+      },
+    })
+    <%= modelVariableName %>: <%= modelName %>,
     @param.query.object('where', getWhereSchemaFor(<%= modelName %>)) where?: Where<<%= modelName %>>,
   ): Promise<Count> {
     return await this.<%= repositoryNameCamel %>.updateAll(<%= modelVariableName %>, where);
@@ -105,7 +113,14 @@ export class <%= className %>Controller {
   })
   async updateById(
     @param.path.<%= idType %>('id') id: <%= idType %>,
-    @requestBody() <%= modelVariableName %>: <%= modelName %>,
+    @requestBody({
+      content: {
+        'application/json': {
+          schema: getModelSchemaRef(<%= modelName %>, {partial: true}),
+        },
+      },
+    })
+    <%= modelVariableName %>: <%= modelName %>,
   ): Promise<void> {
     await this.<%= repositoryNameCamel %>.updateById(id, <%= modelVariableName %>);
   }

packages/cli/generators/relation/templates/controller-relation-template-has-many.ts.ejs

@@ -8,6 +8,7 @@ import {
 import {
   del,
   get,
+  getModelSchemaRef,
   getWhereSchemaFor,
   param,
   patch,
@@ -69,7 +70,14 @@ export class <%= controllerClassName %> {
   })
   async patch(
     @param.path.<%= sourceModelPrimaryKeyType %>('id') id: <%= sourceModelPrimaryKeyType %>,
-    @requestBody() <%= targetModelRequestBody %>: Partial<<%= targetModelClassName %>>,
+    @requestBody({
+      content: {
+        'application/json': {
+          schema: getModelSchemaRef(<%= targetModelClassName %>, {partial: true}),
+        },
+      },
+    })
+    <%= targetModelRequestBody %>: Partial<<%= targetModelClassName %>>,
     @param.query.object('where', getWhereSchemaFor(<%= targetModelClassName %>)) where?: Where<<%= targetModelClassName %>>,
   ): Promise<Count> {
     return await this.<%= paramSourceRepository %>.<%= relationPropertyName %>(id).patch(<%= targetModelRequestBody %>, where);

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

@@ -287,7 +287,7 @@ function checkRestCrudContents() {
     /'200': {/,
     /description: 'ProductReview PATCH success count'/,
     /content: {'application\/json': {schema: CountSchema}},\s{1,}},\s{1,}},\s{1,}}\)/,
-    /async updateAll\(\s{1,}\@requestBody\(\) productReview: ProductReview,\s{1,} @param\.query\.object\('where', getWhereSchemaFor\(ProductReview\)\) where\?: Where<ProductReview>(|,\s+)\)/,
+    /async updateAll\(\s+\@requestBody\({\s+content: {\s+'application\/json': {\s+schema: getModelSchemaRef\(ProductReview, {partial: true}\),\s+},\s+},\s+}\)\s+productReview: ProductReview,\s{1,} @param\.query\.object\('where', getWhereSchemaFor\(ProductReview\)\) where\?: Where<ProductReview>(|,\s+)\)/,
   ];
   patchUpdateAllRegEx.forEach(regex => {
     assert.fileContent(expectedFile, regex);
@@ -312,7 +312,7 @@ function checkRestCrudContents() {
     /responses: {/,
     /'204': {/,
     /description: 'ProductReview PATCH success'/,
-    /async updateById\(\s{1,}\@param.path.number\('id'\) id: number,\s{1,}\@requestBody\(\) productReview: ProductReview,\s+\)/,
+    /async updateById\(\s+\@param.path.number\('id'\) id: number,\s+\@requestBody\({\s+content: {\s+'application\/json': {\s+schema: getModelSchemaRef\(ProductReview, {partial: true}\),\s+},\s+},\s+}\)\s+productReview: ProductReview,\s+\)/,
   ];
   patchUpdateByIdRegEx.forEach(regex => {
     assert.fileContent(expectedFile, regex);

packages/cli/test/integration/generators/hasmany.relation.integration.js

@@ -494,7 +494,8 @@ context('check if the controller file created ', () => {
           /description: 'Customer.Order PATCH success count',\n/,
           /content: { 'application\/json': { schema: CountSchema } },\n/,
           /},\n {4}},\n {2}}\)\n {2}async patch\(\n/,
-          /\@param\.path\.number\('id'\) id: number,\n {4}\@requestBody\(\) order: Partial<Order>,\n/,
+          /\@param\.path\.number\('id'\) id: number,\n {4}/,
+          /\@requestBody\({\s+content: {\s+'application\/json': {\s+schema: getModelSchemaRef\(Order, {partial: true}\),\s+},\s+},\s+}\)\s+order: Partial<Order>,\n/,
           /\@param\.query\.object\('where', getWhereSchemaFor\(Order\)\) where\?: Where<Order>,\n/,
           /\): Promise<Count> {\n/,
           /return await this\.customerRepository\.orders\(id\).patch\(order, where\);\n {2}}\n/,
@@ -505,7 +506,8 @@ context('check if the controller file created ', () => {
           /description: 'CustomerClass.OrderClass PATCH success count',\n/,
           /content: { 'application\/json': { schema: CountSchema } },\n/,
           /},\n {4}},\n {2}}\)\n {2}async patch\(\n/,
-          /\@param\.path\.number\('id'\) id: number,\n {4}\@requestBody\(\) orderClass: Partial<OrderClass>,\n/,
+          /\@param\.path\.number\('id'\) id: number,\n {4}/,
+          /\@requestBody\({\s+content: {\s+'application\/json': {\s+schema: getModelSchemaRef\(OrderClass, {partial: true}\),\s+},\s+},\s+}\)\s+orderClass: Partial<OrderClass>,\n/,
           /\@param\.query\.object\('where', getWhereSchemaFor\(OrderClass\)\) where\?: Where<OrderClass>,\n/,
           /\): Promise<Count> {\n/,
           /return await this\.customerClassRepository\.orderClasses\(id\)\.patch\(orderClass, where\);\n {2}}\n/,
@@ -516,7 +518,8 @@ context('check if the controller file created ', () => {
           /description: 'CustomerClassType.OrderClassType PATCH success count',\n/,
           /content: { 'application\/json': { schema: CountSchema } },\n/,
           /},\n {4}},\n {2}}\)\n {2}async patch\(\n/,
-          /\@param\.path\.number\('id'\) id: number,\n {4}\@requestBody\(\) orderClassType: Partial<OrderClassType>,\n/,
+          /\@param\.path\.number\('id'\) id: number,\n {4}/,
+          /\@requestBody\({\s+content: {\s+'application\/json': {\s+schema: getModelSchemaRef\(OrderClassType, {partial: true}\),\s+},\s+},\s+}\)\s+orderClassType: Partial<OrderClassType>,\n/,
           /\@param\.query\.object\('where', getWhereSchemaFor\(OrderClassType\)\) where\?: Where<OrderClassType>,\n/,
           /\): Promise<Count> {\n/,
           /return await this\.customerClassTypeRepository\.orderClassTypes\(id\).patch\(orderClassType, where\);\n {2}}\n/,

packages/repository-json-schema/src/__tests__/integration/build-schema.integration.ts

@@ -910,5 +910,27 @@ describe('build-schema', () => {
         title: 'Category',
       });
     });
+
+    it('emits all properties as optional when the option "partial" is set', () => {
+      @model()
+      class Product extends Entity {
+        @property({id: true, required: true})
+        id: number;
+
+        @property({required: true})
+        name: string;
+
+        @property()
+        optionalDescription: string;
+      }
+
+      const originalSchema = getJsonSchema(Product);
+      expect(originalSchema.required).to.deepEqual(['id', 'name']);
+      expect(originalSchema.title).to.equal('Product');
+
+      const partialSchema = getJsonSchema(Product, {partial: true});
+      expect(partialSchema.required).to.equal(undefined);
+      expect(partialSchema.title).to.equal('ProductPartial');
+    });
   });
 });

packages/repository-json-schema/src/__tests__/unit/build-schema.unit.ts

@@ -10,6 +10,7 @@ import {
 } from '@loopback/repository';
 import {expect} from '@loopback/testlab';
 import {
+  buildModelCacheKey,
   getNavigationalPropertyForRelation,
   metaToJsonProperty,
   stringTypeToWrapper,
@@ -214,4 +215,30 @@ describe('build-schema', () => {
       ).to.throw(/targetsMany attribute missing for Test/);
     });
   });
+
+  describe('buildModelCacheKey', () => {
+    it('returns "modelOnly" when no options were provided', () => {
+      const key = buildModelCacheKey();
+      expect(key).to.equal('modelOnly');
+    });
+
+    it('returns "modelWithRelations" when a single option "includeRelations" is set', () => {
+      const key = buildModelCacheKey({includeRelations: true});
+      expect(key).to.equal('modelWithRelations');
+    });
+
+    it('returns "partial" when a single option "partial" is set', () => {
+      const key = buildModelCacheKey({partial: true});
+      expect(key).to.equal('partial');
+    });
+
+    it('returns concatenated option names otherwise', () => {
+      const key = buildModelCacheKey({
+        // important: object keys are defined in reverse order
+        partial: true,
+        includeRelations: true,
+      });
+      expect(key).to.equal('includeRelations+partial');
+    });
+  });
 });