feat(rest-crud): implement "deleteById" operation

Signed-off-by: Miroslav Bajtoš <[email protected]>
loopbackio · Aug 22, 2019 · bec7199 · bec7199
1 parent c24b1cd
commit bec7199
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 0 deletions.
diff --git a/packages/rest-crud/src/__tests__/acceptance/default-model-crud-rest.acceptance.ts b/packages/rest-crud/src/__tests__/acceptance/default-model-crud-rest.acceptance.ts
@@ -213,6 +213,39 @@ describe('CrudRestController for a simple Product model', () => {
     });
   });
 
+  describe('deleteById', () => {
+    beforeEach(seedData);
+
+    it('deletes model with the given id', async () => {
+      await client.del(`/products/${pen.id}`).expect(204);
+
+      const stored = await repo.find();
+      expect(toJSON(stored)).to.deepEqual(
+        toJSON([
+          /* pen was deleted */
+          pencil,
+        ]),
+      );
+    });
+
+    // TODO(bajtos) to fully verify this functionality, we should create
+    // a new test suite that will configure a PK with a different name
+    // and type, e.g. `pk: string` instead of `id: number`.
+    it('uses correct schema for the id parameter', async () => {
+      const spec = app.restServer.getApiSpec();
+      const findByIdOp = spec.paths['/products/{id}']['delete'];
+      expect(findByIdOp).to.containDeep({
+        parameters: [
+          {
+            name: 'id',
+            in: 'path',
+            schema: {type: 'number'},
+          },
+        ],
+      });
+    });
+  });
+
   async function setupTestScenario() {
     const db = new juggler.DataSource({connector: 'memory'});
     repo = new DefaultCrudRepository<Product, typeof Product.prototype.id>(

diff --git a/packages/rest-crud/src/crud-rest.controller.ts b/packages/rest-crud/src/crud-rest.controller.ts
@@ -14,6 +14,7 @@ import {
 } from '@loopback/repository';
 import {
   api,
+  del,
   get,
   getFilterSchemaFor,
   getJsonSchema,
@@ -229,6 +230,15 @@ export function defineCrudRestController<
         data as DataObject<T>,
       );
     }
+
+    @del('/{id}', {
+      responses: {
+        '204': {description: `${modelName} was deleted`},
+      },
+    })
+    async deleteById(@param(idPathParam) id: IdType): Promise<void> {
+      await this.repository.deleteById(id);
+    }
   }
 
   // See https://github.com/microsoft/TypeScript/issues/14607