fix: issues preventing people from upgrading off our legacy explorer (#…

…602) * chore: updating deps in the lockfile * fix: always attempt to uppercase language names * fix: stop double-nesting json response examples * fix: bug where legacy responses that weren't set up are ignored * chore(deps): upgrading @readme/api-explorer to 3.1.9 * fix: always try to render an operations path * docs: Update packages/api-explorer/src/lib/upgrade-legacy-responses.js Co-Authored-By: Rafe Goldberg <rafegoldberg@gmail.com> Co-authored-by: Rafe Goldberg <rafegoldberg@gmail.com>
readmeio · Apr 15, 2020 · 4385347 · 4385347
1 parent 2da7a88
commit 4385347
Show file tree

Hide file tree

Showing 9 changed files with 49 additions and 73 deletions.
diff --git a/packages/api-explorer/__tests__/lib/upgrade-legacy-responses.test.js b/packages/api-explorer/__tests__/lib/upgrade-legacy-responses.test.js
@@ -5,6 +5,10 @@ function encodeJsonExample(json) {
 }
 
 describe('upgradeLegacyResponses', () => {
+  it('should not return anything for an legacy response that hasnt been fully configured', () => {
+    expect(upgradeLegacyResponses([{ language: 'text', code: '' }])).toStrictEqual([]);
+  });
+
   it('should return codes array for a legacy response shape', () => {
     const encodedExample = {
       meta: {

diff --git a/packages/api-explorer/package-lock.json b/packages/api-explorer/package-lock.json
diff --git a/packages/api-explorer/src/PathUrl.jsx b/packages/api-explorer/src/PathUrl.jsx
@@ -81,17 +81,14 @@ function PathUrl({
           )}
 
           <span className={`pg-type-big pg-type type-${operation.method}`}>{operation.method}</span>
-
-          {oas.servers && oas.servers.length > 0 && (
-            <span className="definition-url">
-              <span className="url">{oas.url()}</span>
-              {splitPath(operation.path).map(part => (
-                <span key={part.key} className={`api-${part.type}`}>
-                  {part.value}
-                </span>
-              ))}
-            </span>
-          )}
+          <span className="definition-url">
+            <span className="url">{oas.url()}</span>
+            {splitPath(operation.path).map(part => (
+              <span key={part.key} className={`api-${part.type}`}>
+                {part.value}
+              </span>
+            ))}
+          </span>
         </div>
       </div>
     </div>

diff --git a/packages/api-explorer/src/ResponseExample.jsx b/packages/api-explorer/src/ResponseExample.jsx
@@ -246,7 +246,7 @@ class ResponseExample extends React.Component {
                         )}
 
                       {isJson && !example.multipleExamples ? (
-                        <div className="example example_json">{transformExampleIntoReactJson(example)}</div>
+                        transformExampleIntoReactJson(example)
                       ) : (
                         // json + multiple examples is already handled in `showExamples`.
                         <React.Fragment>

diff --git a/packages/api-explorer/src/lib/generate-code-snippet.js b/packages/api-explorer/src/lib/generate-code-snippet.js
@@ -88,4 +88,4 @@ module.exports = (oas, operation, values, auth, lang) => {
   };
 };
 
-module.exports.getLangName = lang => (supportedLanguages[lang] ? uppercase(lang) : lang);
+module.exports.getLangName = lang => uppercase(lang);
diff --git a/packages/api-explorer/src/lib/upgrade-legacy-responses.js b/packages/api-explorer/src/lib/upgrade-legacy-responses.js
@@ -13,6 +13,11 @@ module.exports = responses => {
   const codes = {};
 
   responses.forEach(response => {
+    // If there's no status set, then the legacy response wasn't fully configured so we should ignore it.
+    if (!('status' in response)) {
+      return;
+    }
+
     if (typeof codes[response.status] === 'undefined') {
       codes[response.status] = {
         languages: {},

diff --git a/packages/markdown-magic/package-lock.json b/packages/markdown-magic/package-lock.json
diff --git a/packages/oas-to-har/package-lock.json b/packages/oas-to-har/package-lock.json
diff --git a/packages/oas-to-har/package.json b/packages/oas-to-har/package.json
@@ -5,7 +5,7 @@
   "main": "src/index.js",
   "dependencies": {
     "@readme/oas-extensions": "^6.0.5",
-    "@readme/oas-tooling": "^3.1.8",
+    "@readme/oas-tooling": "^3.1.9",
     "querystring": "^0.2.0"
   },
   "scripts": {
-Original file line number
+Diff line change
@@ Expand Up / @@ -88,4 +88,4 @@ module.exports = (oas, operation, values, auth, lang) => { @@
       };
     };
-    module.exports.getLangName = lang => (supportedLanguages[lang] ? uppercase(lang) : lang);
+    module.exports.getLangName = lang => uppercase(lang);