feat(validation): add support for ignoring errors (#126)

Refs #3

Author: char0n

.github/workflows/main.yml

@@ -52,3 +52,15 @@ jobs:
         uses: char0n/swagger-editor-validate@master
         with:
           definition-file: examples/openapi-2-0.yaml
+
+  test_swagger_editor_ignore_error:
+    runs-on: ubuntu-latest
+    name: Swagger Editor Ignore Errors
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Validate OpenAPI definition
+        uses: char0n/swagger-editor-validate@master
+        with:
+          definition-file: examples/openapi-2-0-ignore-error.yaml
+          ignore-error: examples/ignore-error.js

README.md

@@ -26,6 +26,10 @@ file is going to be validated. Default `https://editor.swagger.io/`.
 **Required** Defines path of [OAS](https://github.com/OAI/OpenAPI-Specification) definition file that exists
 as a physical file in your repository.
 
+### `ignore-error`
+
+**Optional** Defines path to JavaScript file containing predicate for determining if the error should be ignored or not.
+
 
 ## Example usage
 

action.yml

@@ -9,12 +9,15 @@ inputs:
   definition-file:
     description: Path to definition file
     required: true
+  ignore-error:
+    description: JavaScript file containing predicate for determining if the error should be ignored or not
+    required: false
 runs:
   using: composite
   steps:
     - run: cd ${{ github.action_path }} && npm install
       shell: bash
-    - run: cd ${{ github.action_path }} && SWAGGER_EDITOR_URL=${{ inputs.swagger-editor-url }} DEFINITION_FILE=${{ inputs.definition-file }} node src/index.js
+    - run: cd ${{ github.action_path }} && SWAGGER_EDITOR_URL=${{ inputs.swagger-editor-url }} DEFINITION_FILE=${{ inputs.definition-file }} IGNORE_ERROR=${{ inputs.ignore-error }} node src/index.js
       shell: bash
 branding:
   icon: 'file-text'

examples/ignore-error.js

@@ -0,0 +1,11 @@
+const shouldIgnoreError = (error) => {
+  if (error.lineNo === 2) {
+    if (/should NOT have additional properties\s*additionalProperty: contact1/mg.test(error.message)) {
+      return true;
+    }
+  }
+
+  return false;
+}
+
+module.exports = shouldIgnoreError;