fixup!: apply feedback

loopbackio · Dec 19, 2019 · 2435327 · 2435327
1 parent 8a74cc6
commit 2435327
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/docs/site/Extending-OpenAPI-specification.md b/docs/site/Extending-OpenAPI-specification.md
@@ -32,7 +32,7 @@ For example, to modify the `info` field of an OAS, you can create an
 ```ts
 import {bind} from '@loopback/core';
 import {
-  defaultMergeFn,
+  mergeOpenAPISpec,
   asSpecEnhancer,
   OASEnhancer,
   OpenApiSpec,
@@ -52,7 +52,7 @@ export class InfoSpecEnhancer implements OASEnhancer {
       info: {title: 'LoopBack Test Application', version: '1.0.1'},
     };
     // the example calls a default helper function to merge the fragment spec.
-    const mergedSpec = defaultMergeFn(spec, InfoPatchSpec);
+    const mergedSpec = mergeOpenAPISpec(spec, InfoPatchSpec);
     return mergedSpec;
   }
 }
@@ -64,7 +64,7 @@ export class InfoSpecEnhancer implements OASEnhancer {
   [extension point section](#oas-enhancer-service-as-extension-point)).
 - The enhancer changes the current specification's `info` object in function
   `modifySpec`.
-- It calls [`defaultMergeFn`](#default-merge-function) to merge the
+- It calls [`mergeOpenAPISpec`](#default-merge-function) to merge the
   specification fragment into the current spec.
 
 ### Default Merge Function
@@ -74,7 +74,7 @@ operation: merge, delete, or more complicated changes. This is totally
 determined by the extension contributor.
 
 To apply the basic merging, we provide a default helper function called
-`defaultMergeFn` that leverages
+`mergeOpenAPISpec` that leverages
 [`json-merge-patch`](https://github.com/pierreinglebert/json-merge-patch) to
 merge two json objects. You can find its usage in the
 [previous section](#adding-a-new-oas-enhancer)

diff --git a/packages/openapi-v3/src/__tests__/unit/enhancers/fixtures/info.spec.extension.ts b/packages/openapi-v3/src/__tests__/unit/enhancers/fixtures/info.spec.extension.ts
@@ -6,7 +6,7 @@
 import {bind} from '@loopback/core';
 import debugModule from 'debug';
 import {inspect} from 'util';
-import {defaultMergeFn} from '../../../..';
+import {mergeOpenAPISpec} from '../../../..';
 import {asSpecEnhancer, OASEnhancer} from '../../../../enhancers/types';
 import {OpenApiSpec} from '../../../../types';
 const debug = debugModule('loopback:openapi:spec-enhancer');
@@ -22,7 +22,7 @@ export class InfoSpecEnhancer implements OASEnhancer {
     const InfoPatchSpec = {
       info: {title: 'LoopBack Test Application', version: '1.0.1'},
     };
-    const mergedSpec = defaultMergeFn(spec, InfoPatchSpec);
+    const mergedSpec = mergeOpenAPISpec(spec, InfoPatchSpec);
     debug(`security spec extension, merged spec: ${inspect(mergedSpec)}`);
     return mergedSpec;
   }

diff --git a/packages/openapi-v3/src/__tests__/unit/enhancers/fixtures/security.spec.extension.ts b/packages/openapi-v3/src/__tests__/unit/enhancers/fixtures/security.spec.extension.ts
@@ -7,7 +7,7 @@ import {bind} from '@loopback/core';
 import debugModule from 'debug';
 import {inspect} from 'util';
 import {
-  defaultMergeFn,
+  mergeOpenAPISpec,
   ReferenceObject,
   SecuritySchemeObject,
 } from '../../../..';
@@ -37,7 +37,7 @@ export class SecuritySpecEnhancer implements OASEnhancer {
 
   modifySpec(spec: OpenApiSpec): OpenApiSpec {
     const patchSpec = {components: {securitySchemes: SECURITY_SCHEME_SPEC}};
-    const mergedSpec = defaultMergeFn(spec, patchSpec);
+    const mergedSpec = mergeOpenAPISpec(spec, patchSpec);
     debug(`security spec extension, merged spec: ${inspect(mergedSpec)}`);
     return mergedSpec;
   }

diff --git a/packages/openapi-v3/src/enhancers/spec-enhancer.service.ts b/packages/openapi-v3/src/enhancers/spec-enhancer.service.ts
@@ -112,7 +112,7 @@ export class OASEnhancerService {
  * @param currentSpec The original spec
  * @param patchSpec The patch spec to be merged into the original spec
  */
-export function defaultMergeFn(
+export function mergeOpenAPISpec(
   currentSpec: Partial<OpenApiSpec>,
   patchSpec: Partial<OpenApiSpec>,
 ) {