fix: surface all validation errors (#639)

readmeio · Oct 17, 2022 · 39b2c61 · 39b2c61
1 parent 89d1914
commit 39b2c61
Show file tree

Hide file tree

Showing 5 changed files with 132 additions and 45 deletions.
diff --git a/__tests__/__fixtures__/very-invalid-oas.json b/__tests__/__fixtures__/very-invalid-oas.json
@@ -0,0 +1,61 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "description": "This OpenAPI definition has a typod `servers.url` and `paths.**.tags` properties.",
+    "version": "1.0.0",
+    "title": "Swagger Petstore"
+  },
+  "servers": [
+    {
+      "urll": "http://petstore.swagger.io/v2"
+    }
+  ],
+  "tags": [
+    {
+      "name": "pet",
+      "description": "Everything about your Pets",
+      "externalDocs": {
+        "description": "Find out more",
+        "url": "http://swagger.io"
+      }
+    }
+  ],
+  "paths": {
+    "/pet/findByStatus": {
+      "get": {
+        "tagss": [
+          "pet"
+        ],
+        "summary": "Finds Pets by status",
+        "description": "Multiple status values can be provided with comma separated strings",
+        "operationId": "findPetsByStatus",
+        "parameters": [
+          {
+            "name": "status",
+            "in": "query",
+            "description": "Status values that need to be considered for filter",
+            "required": true,
+            "explode": true,
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "enum": [
+                  "available",
+                  "pending",
+                  "sold"
+                ],
+                "default": "available"
+              }
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/__tests__/cmds/openapi/__snapshots__/validate.test.ts.snap b/__tests__/cmds/openapi/__snapshots__/validate.test.ts.snap
@@ -148,6 +148,30 @@ jobs:
 "
 `;
 
+exports[`rdme openapi:validate error handling should throw an error if an invalid API definition has many errors 1`] = `
+[SyntaxError: OpenAPI schema validation failed.
+
+REQUIRED must have required property 'url'
+
+   7 |   },
+   8 |   "servers": [
+>  9 |     {
+     |     ^ ☹️  url is missing here!
+  10 |       "urll": "http://petstore.swagger.io/v2"
+  11 |     }
+  12 |   ],
+
+ADDITIONAL PROPERTY must NOT have additional properties
+
+  24 |     "/pet/findByStatus": {
+  25 |       "get": {
+> 26 |         "tagss": [
+     |         ^^^^^^^ 😲  tagss is not expected to be here!
+  27 |           "pet"
+  28 |         ],
+  29 |         "summary": "Finds Pets by status",]
+`;
+
 exports[`rdme openapi:validate error handling should throw an error if an invalid OpenAPI 3.1 definition is supplied 1`] = `
 [SyntaxError: OpenAPI schema validation failed.
 

diff --git a/__tests__/cmds/openapi/validate.test.ts b/__tests__/cmds/openapi/validate.test.ts
@@ -107,6 +107,10 @@ describe('rdme openapi:validate', () => {
     it('should throw an error if an invalid Swagger definition is supplied', () => {
       return expect(validate.run({ spec: './__tests__/__fixtures__/invalid-swagger.json' })).rejects.toMatchSnapshot();
     });
+
+    it('should throw an error if an invalid API definition has many errors', () => {
+      return expect(validate.run({ spec: './__tests__/__fixtures__/very-invalid-oas.json' })).rejects.toMatchSnapshot();
+    });
   });
 
   describe('CI tests', () => {

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -50,8 +50,8 @@
     "jsonpath": "^1.1.1",
     "mime-types": "^2.1.35",
     "node-fetch": "^2.6.1",
-    "oas": "^18.4.4",
-    "oas-normalize": "^7.0.0",
+    "oas": "^19.0.1",
+    "oas-normalize": "^7.1.0",
     "open": "^8.2.1",
     "ora": "^5.4.1",
     "parse-link-header": "^2.0.0",