feat: use descriptive title to describe schema of POST (create) reque…

…st bodies Signed-off-by: Miroslav Bajtoš <[email protected]>
loopbackio · Sep 16, 2019 · 8f49a45 · 8f49a45
1 parent 7664b3e
commit 8f49a45
Show file tree

Hide file tree

Showing 11 changed files with 21 additions and 10 deletions.
diff --git a/docs/site/Controller-generator.md b/docs/site/Controller-generator.md
@@ -134,7 +134,7 @@ export class TodoController {
     @requestBody({
       content: {
         'application/json': {
-          schema: getModelSchemaRef(Todo, {exclude: ['id']}),
+          schema: getModelSchemaRef(Todo, {title: 'NewTodo', exclude: ['id']}),
         },
       },
     })

diff --git a/docs/site/tutorials/todo-list/todo-list-tutorial-controller.md b/docs/site/tutorials/todo-list/todo-list-tutorial-controller.md
@@ -181,7 +181,7 @@ export class TodoListTodoController {
     @requestBody({
       content: {
         'application/json': {
-          schema: getModelSchemaRef(Todo, {exclude: ['id']}),
+          schema: getModelSchemaRef(Todo, {title: 'NewTodo', exclude: ['id']}),
         },
       },
     })
@@ -237,7 +237,7 @@ export class TodoListTodoController {
     @requestBody({
       content: {
         'application/json': {
-          schema: getModelSchemaRef(Todo, {exclude: ['id']}),
+          schema: getModelSchemaRef(Todo, {title: 'NewTodo', exclude: ['id']}),
         },
       },
     })

diff --git a/examples/express-composition/src/controllers/note.controller.ts b/examples/express-composition/src/controllers/note.controller.ts
@@ -43,7 +43,7 @@ export class NoteController {
     @requestBody({
       content: {
         'application/json': {
-          schema: getModelSchemaRef(Note, {exclude: ['id']}),
+          schema: getModelSchemaRef(Note, {title: 'NewNote', exclude: ['id']}),
         },
       },
     })

diff --git a/examples/todo-list/src/controllers/todo-list-todo.controller.ts b/examples/todo-list/src/controllers/todo-list-todo.controller.ts
@@ -42,6 +42,7 @@ export class TodoListTodoController {
       content: {
         'application/json': {
           schema: getModelSchemaRef(Todo, {
+            title: 'NewTodoInTodoList',
             exclude: ['id'],
             optional: ['todoListId'],
           }),

diff --git a/examples/todo-list/src/controllers/todo-list.controller.ts b/examples/todo-list/src/controllers/todo-list.controller.ts
@@ -42,7 +42,10 @@ export class TodoListController {
     @requestBody({
       content: {
         'application/json': {
-          schema: getModelSchemaRef(TodoList, {exclude: ['id']}),
+          schema: getModelSchemaRef(TodoList, {
+            title: 'NewTodoList',
+            exclude: ['id'],
+          }),
         },
       },
     })

diff --git a/examples/todo-list/src/controllers/todo.controller.ts b/examples/todo-list/src/controllers/todo.controller.ts
@@ -33,7 +33,7 @@ export class TodoController {
     @requestBody({
       content: {
         'application/json': {
-          schema: getModelSchemaRef(Todo, {exclude: ['id']}),
+          schema: getModelSchemaRef(Todo, {title: 'NewTodo', exclude: ['id']}),
         },
       },
     })

diff --git a/examples/todo/src/controllers/todo.controller.ts b/examples/todo/src/controllers/todo.controller.ts
@@ -38,7 +38,7 @@ export class TodoController {
     @requestBody({
       content: {
         'application/json': {
-          schema: getModelSchemaRef(Todo, {exclude: ['id']}),
+          schema: getModelSchemaRef(Todo, {title: 'NewTodo', exclude: ['id']}),
         },
       },
     })

diff --git a/packages/cli/generators/controller/templates/src/controllers/controller-rest-template.ts.ejs b/packages/cli/generators/controller/templates/src/controllers/controller-rest-template.ts.ejs
@@ -38,7 +38,10 @@ export class <%= className %>Controller {
     @requestBody({
       content: {
         'application/json': {
-          schema: getModelSchemaRef(<%= modelName %>, {exclude: ['<%= id %>']}),
+          schema: getModelSchemaRef(<%= modelName %>, {
+            title: 'New<%= modelName %>',
+            exclude: ['<%= id %>'],
+          }),
         },
       },
     })

diff --git a/packages/cli/generators/relation/templates/controller-relation-template-has-many.ts.ejs b/packages/cli/generators/relation/templates/controller-relation-template-has-many.ts.ejs
@@ -59,6 +59,7 @@ export class <%= controllerClassName %> {
       content: {
         'application/json': {
           schema: getModelSchemaRef(<%= targetModelClassName %>, {
+            title: 'New <%= targetModelClassName %>In<%= sourceModelClassName %>',
             exclude: ['<%= targetModelPrimaryKey %>'],
             optional: ['<%= foreignKeyName %>']
           }),

diff --git a/packages/cli/test/integration/generators/controller.integration.js b/packages/cli/test/integration/generators/controller.integration.js
@@ -249,7 +249,7 @@ function checkRestCrudContents() {
     /'200': {/,
     /description: 'ProductReview model instance'/,
     /content: {'application\/json': {schema: getModelSchemaRef\(ProductReview\)}},\s{1,}},\s{1,}},\s{1,}}\)/,
-    /async create\(\s+\@requestBody\({\s+content: {\s+'application\/json': {\s+schema: getModelSchemaRef\(ProductReview, {exclude: \['productId'\]}\),\s+},\s+},\s+}\)\s+productReview: Omit<ProductReview, 'productId'>,\s+\)/,
+    /async create\(\s+\@requestBody\({\s+content: {\s+'application\/json': {\s+schema: getModelSchemaRef\(ProductReview, {\s+title: 'NewProductReview',\s+exclude: \['productId'\],\s+}\),\s+},\s+},\s+}\)\s+productReview: Omit<ProductReview, 'productId'>,\s+\)/,
   ];
   postCreateRegEx.forEach(regex => {
     assert.fileContent(expectedFile, regex);

diff --git a/packages/rest-crud/src/crud-rest.controller.ts b/packages/rest-crud/src/crud-rest.controller.ts
@@ -152,7 +152,10 @@ export function defineCrudRestController<
       ...response.model(200, `${modelName} instance created`, modelCtor),
     })
     async create(
-      @body(modelCtor, {exclude: modelCtor.getIdProperties() as (keyof T)[]})
+      @body(modelCtor, {
+        title: `New${modelName}`,
+        exclude: modelCtor.getIdProperties() as (keyof T)[],
+      })
       data: Omit<T, IdName>,
     ): Promise<T> {
       return this.repository.create(