Merge pull request #1609 from shockey/master

Validation improvements

Author: shockey

src/index.js

@@ -5,7 +5,8 @@ import "swagger-ui/dist/swagger-ui.css"
 
 import EditorPlugin from "./plugins/editor"
 import LocalStoragePlugin from "./plugins/local-storage"
-import ValidatePlugin from "./plugins/validate"
+import ValidateBasePlugin from "./plugins/validate-base"
+import ValidateSemanticPlugin from "./plugins/validate-semantic"
 import ValidateJsonSchemaPlugin from "./plugins/validate-json-schema"
 import EditorAutosuggestPlugin from "./plugins/editor-autosuggest"
 import EditorAutosuggestSnippetsPlugin from "./plugins/editor-autosuggest-snippets"
@@ -22,7 +23,8 @@ window.versions = window.versions || {}
 window.versions.swaggerEditor = `${PACKAGE_VERSION}/${GIT_COMMIT || "unknown"}${GIT_DIRTY ? "-dirty" : ""}`
 const plugins = {
   EditorPlugin,
-  ValidatePlugin,
+  ValidateBasePlugin,
+  ValidateSemanticPlugin,
   ValidateJsonSchemaPlugin,
   LocalStoragePlugin,
   EditorAutosuggestPlugin,

src/plugins/validate-base/index.js

@@ -0,0 +1,37 @@
+// Base validate plugin that provides a placeholder `validateSpec` that fires
+// after `updateResolved` is dispatched.
+
+export const updateResolved = (ori, {specActions}) => (...args) => {
+  ori(...args)
+  /*
+    To allow us to remove this, we should prefer the practice of
+    only _composing_ inside of wrappedActions. It keeps us free to
+    remove pieces added by plugins. In this case, I want to toggle validation.
+    But I can't look inside the updateResolved action,
+    I can only remove it ( which isn't desirable ). However I _can_ remove `validateSpec` action,
+    making it a noop. That way, the only overhead I end up with is a bunch of noops inside wrappedActions.
+    Which isn't bad.
+  */
+  const [ spec ] = args
+  specActions.validateSpec(spec)
+}
+
+//eslint-disable-next-line no-unused-vars
+export const validateSpec = (resolvedSpec) => ({ specSelectors, errActions }) => {
+
+}
+
+export default function() {
+  return {
+    statePlugins: {
+      spec: {
+        actions: {
+          validateSpec,
+        },
+        wrapActions: {
+          updateResolved
+        }
+      }
+    }
+  }
+}

src/plugins/validate-json-schema/apis/index.js

@@ -4,21 +4,6 @@ import { makeValidationWorker } from "../helpers"
 
 let debouncedValidation = makeValidationWorker()
 
-export const updateResolved = (ori, {specActions}) => (...args) => {
-  ori(...args)
-  /*
-    To allow us to remove this, we should prefer the practice of
-    only _composing_ inside of wrappedActions. It keeps us free to
-    remove pieces added by plugins. In this case, I want to toggle validation.
-    But I can't look inside the updateResolved action,
-    I can only remove it ( which isn't desirable ). However I _can_ remove `validateSpec` action,
-    making it a noop. That way, the only overhead I end up with is a bunch of noops inside wrappedActions.
-    Which isn't bad.
-  */
-  const [ spec ] = args
-  specActions.validateSpec(spec)
-}
-
 export const validateSpec = (resolvedSpec) => ({ specSelectors, errActions }) => {
   const isOAS3 = specSelectors.isOAS3 ? specSelectors.isOAS3() : false
   const ourMode = isOAS3 ? "oas3" : "swagger2"
@@ -31,9 +16,6 @@ export default function() {
       spec: {
         actions: {
           validateSpec,
-        },
-        wrapActions: {
-          updateResolved
         }
       }
     }

src/plugins/validate-json-schema/modes.js

@@ -5,13 +5,11 @@ export default {
   "swagger2": {
     schemas: [swagger2Schema], // the swagger2 schema references itself by URL, so we have to preload it
     testSchema: swagger2Schema,
-    runStructural: true,
-    runSemantic: true
+    runStructural: true
   },
   "oas3": {
     schemas: [oas3Schema],
     testSchema: oas3Schema,
-    runStructural: true,
-    runSemantic: false
+    runStructural: true
   }
 }