Lowercase method, reorganise operation object for better readability (as a consumer)

Author: Brendan Abbott

CHANGELOG.md

@@ -13,10 +13,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Operation now supports `deprecated` and `tags` properties.
 - Parameters now support the `content` property.
 - Updated various build dependencies.
+- OpenAPI definition will now be smaller in most cases, choosing to omit optional properties instead of using empty defaults.
 
 ## Fixed
 
 - Handle when `models` is not iterable.
+- Handle when `models` have no `schema`.
+- Always lowercase the HTTP method to conform to OpenAPI spec.
 
 ## [v0.2.1] - 2017-07-07
 

README.md

@@ -240,7 +240,7 @@ cookieParams:
 
 #### `requestModels`
 
-The `requestModels` property allows you to define models for the HTTP Request of the function event. You can define a different model for each different `Content-Type`. You can define a reference to the relevant request model named in the `models` section of your configuration (see [Defining Models](#defining-models) section).
+The `requestModels` property allows you to define models for the HTTP Request of the function event. You can define a different model for each different `Content-Type`. You can define a reference to the relevant request model named in the `models` section of your configuration (see [Defining Models](#models) section).
 
 ```yml
 requestModels:
@@ -269,7 +269,7 @@ methodResponse:
 
 ##### `responseModels`
 
-The `responseModels` property allows you to define models for the HTTP Response of the function event. You can define a different model for each different `Content-Type`. You can define a reference to the relevant response model named in the `models` section of your configuration (see [Defining Models](#defining-models) section).
+The `responseModels` property allows you to define models for the HTTP Response of the function event. You can define a different model for each different `Content-Type`. You can define a reference to the relevant response model named in the `models` section of your configuration (see [Defining Models](#models) section).
 
 ```yml
 responseModels:

src/DefinitionGenerator.ts

@@ -45,6 +45,10 @@ export class DefinitionGenerator {
 
     if (isIterable(models)) {
       for (const model of models) {
+        if (!model.schema) {
+          continue;
+        }
+
         this.definition.components.schemas[model.name] = this.cleanSchema(
           dereference(model.schema),
         );
@@ -81,7 +85,7 @@ export class DefinitionGenerator {
           // Build OpenAPI path configuration structure for each method
           const pathConfig = {
             [`/${httpEventConfig.path}`]: {
-              [httpEventConfig.method]: this.getOperationFromConfig(
+              [httpEventConfig.method.toLowerCase()]: this.getOperationFromConfig(
                 funcConfig._functionName,
                 httpEventConfig.documentation,
               ),
@@ -120,16 +124,31 @@ export class DefinitionGenerator {
    * @param documentationConfig
    */
   private getOperationFromConfig (funcName: string, documentationConfig): IOperation {
-    return {
+    const operationObj: IOperation = {
       operationId: funcName,
-      tags: documentationConfig.tags || [],
-      deprecated: documentationConfig.deprecated || false,
-      summary: documentationConfig.summary || '',
-      description: documentationConfig.description || '',
-      parameters: this.getParametersFromConfig(documentationConfig),
-      requestBody: this.getRequestBodiesFromConfig(documentationConfig),
-      responses: this.getResponsesFromConfig(documentationConfig),
     };
+
+    if (documentationConfig.summary) {
+      operationObj.summary = documentationConfig.summary;
+    }
+
+    if (documentationConfig.description) {
+      operationObj.description = documentationConfig.description;
+    }
+
+    if (documentationConfig.tags) {
+      operationObj.tags = documentationConfig.tags;
+    }
+
+    if (documentationConfig.deprecated) {
+      operationObj.deprecated = true;
+    }
+
+    operationObj.parameters = this.getParametersFromConfig(documentationConfig);
+    operationObj.requestBody = this.getRequestBodiesFromConfig(documentationConfig);
+    operationObj.responses = this.getResponsesFromConfig(documentationConfig);
+
+    return operationObj;
   }
 
   /**