feat(openapi-v2): add sugar function for head op

loopbackio · Jan 15, 2018 · 353e448 · 353e448
1 parent 4286c0d
commit 353e448
Show file tree

Hide file tree

Showing 2 changed files with 59 additions and 54 deletions.
diff --git a/packages/openapi-v2/src/controller-spec.ts b/packages/openapi-v2/src/controller-spec.ts
@@ -248,6 +248,18 @@ export function del(path: string, spec?: OperationObject) {
   return operation('delete', path, spec);
 }
 
+/**
+ * Expose a Controller method as a REST API operation
+ * mapped to `HEAD` request method.
+ *
+ * @param path The URL path of this operation, e.g. `/product/{id}`
+ * @param spec The OpenAPI specification describing parameters and responses
+ *   of this operation.
+ */
+export function head(path: string, spec?: OperationObject) {
+  return operation('head', path, spec);
+}
+
 /**
  * Expose a Controller method as a REST API operation.
  *

diff --git a/packages/openapi-v2/test/unit/controller-spec/controller-decorators.test.ts b/packages/openapi-v2/test/unit/controller-spec/controller-decorators.test.ts
@@ -12,6 +12,7 @@ import {
   put,
   patch,
   del,
+  head,
   param,
 } from '../../..';
 import {expect} from '@loopback/testlab';
@@ -25,9 +26,7 @@ describe('Routing metadata', () => {
 
     @api(expectedSpec)
     class MyController {
-      greet() {
-        return 'Hello world!';
-      }
+      greet() {}
     }
 
     const actualSpec = getControllerSpec(MyController);
@@ -41,9 +40,7 @@ describe('Routing metadata', () => {
 
     @api(expectedSpec)
     class MyController {
-      greet() {
-        return 'Hello world!';
-      }
+      greet() {}
     }
 
     const spec1 = getControllerSpec(MyController);
@@ -52,15 +49,11 @@ describe('Routing metadata', () => {
   });
 
   it('returns spec defined via @get decorator', () => {
-    const operationSpec = anOperationSpec()
-      .withStringResponse()
-      .build();
+    const operationSpec = givenAnOperationSpec();
 
     class MyController {
       @get('/greet', operationSpec)
-      greet() {
-        return 'Hello world!';
-      }
+      greet() {}
     }
 
     const actualSpec = getControllerSpec(MyController);
@@ -78,9 +71,7 @@ describe('Routing metadata', () => {
   });
 
   it('returns spec defined via @post decorator', () => {
-    const operationSpec = anOperationSpec()
-      .withStringResponse()
-      .build();
+    const operationSpec = givenAnOperationSpec();
 
     class MyController {
       @post('/greeting', operationSpec)
@@ -102,9 +93,7 @@ describe('Routing metadata', () => {
   });
 
   it('returns spec defined via @put decorator', () => {
-    const operationSpec = anOperationSpec()
-      .withStringResponse()
-      .build();
+    const operationSpec = givenAnOperationSpec();
 
     class MyController {
       @put('/greeting', operationSpec)
@@ -126,9 +115,7 @@ describe('Routing metadata', () => {
   });
 
   it('returns spec defined via @patch decorator', () => {
-    const operationSpec = anOperationSpec()
-      .withStringResponse()
-      .build();
+    const operationSpec = givenAnOperationSpec();
 
     class MyController {
       @patch('/greeting', operationSpec)
@@ -150,9 +137,7 @@ describe('Routing metadata', () => {
   });
 
   it('returns spec defined via @del decorator', () => {
-    const operationSpec = anOperationSpec()
-      .withStringResponse()
-      .build();
+    const operationSpec = givenAnOperationSpec();
 
     class MyController {
       @del('/greeting', operationSpec)
@@ -173,10 +158,30 @@ describe('Routing metadata', () => {
     });
   });
 
+  it('returns spec defined via @head decorator', () => {
+    const operationSpec = givenAnOperationSpec();
+
+    class MyController {
+      @head('/greeting', operationSpec)
+      greet() {}
+    }
+
+    const actualSpec = getControllerSpec(MyController);
+
+    expect(actualSpec).to.eql({
+      paths: {
+        '/greeting': {
+          head: {
+            'x-operation-name': 'greet',
+            ...operationSpec,
+          },
+        },
+      },
+    });
+  });
+
   it('returns spec defined via @operation decorator', () => {
-    const operationSpec = anOperationSpec()
-      .withStringResponse()
-      .build();
+    const operationSpec = givenAnOperationSpec();
 
     class MyController {
       @operation('post', '/greeting', operationSpec)
@@ -232,16 +237,12 @@ describe('Routing metadata', () => {
 
     class Parent {
       @get('/parent', operationSpec)
-      getParentName() {
-        return 'The Parent';
-      }
+      getParentName() {}
     }
 
     class Child extends Parent {
       @get('/child', operationSpec)
-      getChildName() {
-        return 'The Child';
-      }
+      getChildName() {}
     }
 
     const actualSpec = getControllerSpec(Child);
@@ -265,22 +266,16 @@ describe('Routing metadata', () => {
   });
 
   it('allows children to override parent REST endpoints', () => {
-    const operationSpec = anOperationSpec()
-      .withStringResponse()
-      .build();
+    const operationSpec = givenAnOperationSpec();
 
     class Parent {
       @get('/name', operationSpec)
-      getParentName() {
-        return 'The Parent';
-      }
+      getParentName() {}
     }
 
     class Child extends Parent {
       @get('/name', operationSpec)
-      getChildName() {
-        return 'The Child';
-      }
+      getChildName() {}
     }
 
     const actualSpec = getControllerSpec(Child);
@@ -298,16 +293,12 @@ describe('Routing metadata', () => {
 
     class Parent {
       @get('/parent-name', operationSpec)
-      getName() {
-        return 'The Parent';
-      }
+      getName() {}
     }
 
     class Child extends Parent {
       @get('/child-name', operationSpec)
-      getName() {
-        return 'The Child';
-      }
+      getName() {}
     }
 
     const childSpec = getControllerSpec(Child);
@@ -337,15 +328,11 @@ describe('Routing metadata', () => {
 
     class Parent {
       @get('/greet', operationSpec)
-      greet(@param.query.string('msg') msg: string) {
-        return `Parent: ${msg}`;
-      }
+      greet(@param.query.string('msg') msg: string) {}
     }
 
     class Child extends Parent {
-      greet(@param.query.string('message') msg: string) {
-        return `Child: ${msg}`;
-      }
+      greet(@param.query.string('message') msg: string) {}
     }
 
     const childSpec = getControllerSpec(Child);
@@ -371,4 +358,10 @@ describe('Routing metadata', () => {
       in: 'query',
     });
   });
+
+  function givenAnOperationSpec() {
+    return anOperationSpec()
+      .withStringResponse()
+      .build();
+  }
 });