fix: if an OAS has an empty examples object, don't parse it (#600)

* fix: if an OAS has an empty examples object, don't parse it * style: fixing a typo in a test
readmeio · Apr 14, 2020 · b0887ad · b0887ad
1 parent 418afe1
commit b0887ad
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 6 deletions.
diff --git a/packages/api-explorer/__tests__/__fixtures__/example-results/oas.json b/packages/api-explorer/__tests__/__fixtures__/example-results/oas.json
@@ -180,6 +180,21 @@
         "summary": "Update Password"
       }
     },
+    "/emptyexample": {
+      "get": {
+        "description": "",
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "examples": {}
+              }
+            }
+          }
+        }
+      }
+    },
     "/nolang": {
       "get": {
         "description": ""

diff --git a/packages/api-explorer/__tests__/lib/create-code-shower.test.js b/packages/api-explorer/__tests__/lib/create-code-shower.test.js
@@ -137,6 +137,11 @@ describe('createCodeShower', () => {
     expect(createCodeShower(operation, oas)).toStrictEqual([]);
   });
 
+  it('should return early if there is an empty example', () => {
+    const operation = oas.operation('/emptyexample', 'get');
+    expect(createCodeShower(operation, oas)).toStrictEqual([]);
+  });
+
   it('should return early if there is no response', () => {
     const operation = oas.operation('/nolang', 'get');
     expect(createCodeShower(operation, oas)).toStrictEqual([]);

diff --git a/packages/api-explorer/src/lib/create-code-shower.js b/packages/api-explorer/src/lib/create-code-shower.js
@@ -31,8 +31,10 @@ function getExample(response, lang) {
 
   let example = examples[0];
   example = response.content[lang].examples[example];
-  if ('value' in example) {
-    return example.value;
+  if (example !== null && typeof example === 'object') {
+    if ('value' in example) {
+      return example.value;
+    }
   }
 
   return example;
@@ -42,9 +44,9 @@ function getMultipleExamples(response, lang) {
   if (!response.content[lang].examples || response.content[lang].examples.response) return false;
 
   const { examples } = response.content[lang];
-  return Object.keys(examples).map(key => {
+  const multipleExamples = Object.keys(examples).map(key => {
     let example = examples[key];
-    if (typeof example === 'object') {
+    if (example !== null && typeof example === 'object') {
       if ('value' in example) {
         example = example.value;
       }
@@ -57,15 +59,19 @@ function getMultipleExamples(response, lang) {
       code: example,
     };
   });
+
+  return multipleExamples.length > 0 ? multipleExamples : false;
 }
 
 function constructLanguage(language, response, example) {
   const multipleExamples = getMultipleExamples(response, language);
-  if (!example && !multipleExamples) return false;
+  if (!example && !multipleExamples) {
+    return false;
+  }
 
   return {
     language,
-    code: typeof example === 'object' ? JSON.stringify(example, undefined, 2) : example,
+    code: example !== null && typeof example === 'object' ? JSON.stringify(example, undefined, 2) : example,
     multipleExamples: !example ? multipleExamples : false,
   };
 }