- Updated parsing of comments

Author: ferdikoomen

rollup.config.js

@@ -34,6 +34,8 @@ const handlebarsPlugin = () => ({
                     union: true,
                     intersection: true,
                     enumerator: true,
+                    escapeComment: true,
+                    escapeDescription: true,
                 },
             });
             return `export default ${templateSpec};`;

src/openApi/v2/parser/escapeDescription.spec.ts

@@ -3,7 +3,6 @@ import { getPattern } from '../../../utils/getPattern';
 import type { OpenApi } from '../interfaces/OpenApi';
 import type { OpenApiSchema } from '../interfaces/OpenApiSchema';
 import { extendEnum } from './extendEnum';
-import { getComment } from './getComment';
 import { getEnum } from './getEnum';
 import { getEnumFromDescription } from './getEnumFromDescription';
 import { getModelComposition } from './getModelComposition';
@@ -23,7 +22,7 @@ export function getModel(
         base: 'any',
         template: null,
         link: null,
-        description: getComment(definition.description),
+        description: definition.description || null,
         isDefinition,
         isReadOnly: definition.readOnly === true,
         isNullable: definition['x-nullable'] === true,

src/openApi/v2/parser/escapeDescription.ts

@@ -3,7 +3,6 @@ import { getPattern } from '../../../utils/getPattern';
 import type { OpenApi } from '../interfaces/OpenApi';
 import type { OpenApiSchema } from '../interfaces/OpenApiSchema';
 import { escapeName } from './escapeName';
-import { getComment } from './getComment';
 import type { getModel } from './getModel';
 import { getType } from './getType';
 
@@ -25,7 +24,7 @@ export function getModelProperties(openApi: OpenApi, definition: OpenApiSchema,
                     base: model.base,
                     template: model.template,
                     link: null,
-                    description: getComment(property.description),
+                    description: property.description || null,
                     isDefinition: false,
                     isReadOnly: property.readOnly === true,
                     isRequired: propertyRequired,
@@ -58,7 +57,7 @@ export function getModelProperties(openApi: OpenApi, definition: OpenApiSchema,
                     base: model.base,
                     template: model.template,
                     link: model.link,
-                    description: getComment(property.description),
+                    description: property.description || null,
                     isDefinition: false,
                     isReadOnly: property.readOnly === true,
                     isRequired: propertyRequired,

src/openApi/v2/parser/getComment.spec.ts

@@ -2,7 +2,6 @@ import type { Operation } from '../../../client/interfaces/Operation';
 import type { OperationParameters } from '../../../client/interfaces/OperationParameters';
 import type { OpenApi } from '../interfaces/OpenApi';
 import type { OpenApiOperation } from '../interfaces/OpenApiOperation';
-import { getComment } from './getComment';
 import { getOperationErrors } from './getOperationErrors';
 import { getOperationName } from './getOperationName';
 import { getOperationParameters } from './getOperationParameters';
@@ -30,8 +29,8 @@ export function getOperation(
     const operation: Operation = {
         service: serviceName,
         name: operationName,
-        summary: getComment(op.summary),
-        description: getComment(op.description),
+        summary: op.summary || null,
+        description: op.description || null,
         deprecated: op.deprecated === true,
         method: method.toUpperCase(),
         path: operationPath,

src/openApi/v2/parser/getComment.ts

@@ -1,14 +1,17 @@
 import type { OperationError } from '../../../client/interfaces/OperationError';
 import type { OperationResponse } from '../../../client/interfaces/OperationResponse';
-import { escapeDescription } from './escapeDescription';
 
+/**
+ *
+ * @param operationResponses
+ */
 export function getOperationErrors(operationResponses: OperationResponse[]): OperationError[] {
     return operationResponses
         .filter(operationResponse => {
             return operationResponse.code >= 300 && operationResponse.description;
         })
         .map(response => ({
             code: response.code,
-            description: escapeDescription(response.description!),
+            description: response.description!,
         }));
 }

src/openApi/v2/parser/getModel.ts

@@ -4,7 +4,6 @@ import type { OpenApi } from '../interfaces/OpenApi';
 import type { OpenApiParameter } from '../interfaces/OpenApiParameter';
 import type { OpenApiSchema } from '../interfaces/OpenApiSchema';
 import { extendEnum } from './extendEnum';
-import { getComment } from './getComment';
 import { getEnum } from './getEnum';
 import { getEnumFromDescription } from './getEnumFromDescription';
 import { getModel } from './getModel';
@@ -23,7 +22,7 @@ export function getOperationParameter(openApi: OpenApi, parameter: OpenApiParame
         base: 'any',
         template: null,
         link: null,
-        description: getComment(parameter.description),
+        description: parameter.description || null,
         isDefinition: false,
         isReadOnly: false,
         isRequired: parameter.required === true,