feat(oas): address pr comments

closes #253
NeuraLegion · Oct 7, 2024 · 0e4f426 · 0e4f426
1 parent 935e7a5
commit 0e4f426
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 7 deletions.
diff --git a/packages/oas/README.md b/packages/oas/README.md
@@ -69,6 +69,16 @@ console.log(requests);
 
 Notice the `includeVendorExamples` option affects Swagger specifications only.
 
+Some specifications may have configuration for `Accept` header value in request parameters section. The automatically inferred `Accept` header values may be skipped, to skip these inferred values in output use the `oas2har` function as follows:
+
+```js
+import schema from './swagger.json' assert { type: 'json' };
+import { oas2har } from '@har-sdk/oas';
+
+const requests = await oas2har(schema, { skipAcceptHeaderInference: true });
+console.log(requests);
+```
+
 ## License
 
 Copyright © 2023 [Bright Security](https://brightsec.com/).

diff --git a/packages/oas/src/converter/Converter.ts b/packages/oas/src/converter/Converter.ts
@@ -1,7 +1,7 @@
 import { OpenAPI, Request } from '@har-sdk/core';
 
 export interface ConverterOptions {
-  omitInferringAcceptHeadersInFavorOfParams?: boolean;
+  skipAcceptHeaderInference?: boolean;
 }
 
 export interface Converter {

diff --git a/packages/oas/src/converter/parts/headers/HeadersConverter.ts b/packages/oas/src/converter/parts/headers/HeadersConverter.ts
@@ -51,7 +51,7 @@ export abstract class HeadersConverter<T extends OpenAPI.Document>
     const paramsHeaders = this.parseFromParams(path, method);
 
     const addInferred =
-      !this.options.omitInferringAcceptHeadersInFavorOfParams ||
+      !this.options.skipAcceptHeaderInference ||
       !paramsHeaders.some((x) => x.name === 'accept');
 
     headers.push(...(addInferred ? acceptHeaders : []), ...paramsHeaders);

diff --git a/packages/oas/src/index.ts b/packages/oas/src/index.ts
@@ -14,7 +14,7 @@ export const oas2har = (
   collection: OpenAPI.Document,
   options: {
     includeVendorExamples?: boolean;
-    omitInferringAcceptHeadersInFavorOfParams?: boolean;
+    skipAcceptHeaderInference?: boolean;
   } = {}
 ): Promise<Request[]> => {
   if (!collection) {

diff --git a/packages/oas/tests/DefaultConverter.spec.ts b/packages/oas/tests/DefaultConverter.spec.ts
@@ -413,16 +413,16 @@ describe('DefaultConverter', () => {
       expect(result).toStrictEqual(expectedDoc);
     });
 
-    it('should omit the inferring of accept headers when accept header comes from parameters', async () => {
+    it('should skip accept header inference when it comes from parameters', async () => {
       // arrange
       const { inputDoc, expectedDoc } = await createFixture({
-        inputFile: `./fixtures/params-header.omit-inferring.oas.yaml`,
-        expectedFile: `./fixtures/params-header.omit-inferring.oas.result.json`
+        inputFile: `./fixtures/params-header.skip-inference.oas.yaml`,
+        expectedFile: `./fixtures/params-header.skip-inference.oas.result.json`
       });
 
       // act
       const result: Request[] = await oas2har(inputDoc as any, {
-        omitInferringAcceptHeadersInFavorOfParams: true
+        skipAcceptHeaderInference: true
       });
 
       // assert

diff --git a/...ams-header.omit-inferring.oas.result.json → ...ams-header.skip-inference.oas.result.json b/...ams-header.omit-inferring.oas.result.json → ...ams-header.skip-inference.oas.result.json
diff --git a/...res/params-header.omit-inferring.oas.yaml → ...res/params-header.skip-inference.oas.yaml b/...res/params-header.omit-inferring.oas.yaml → ...res/params-header.skip-inference.oas.yaml