json-api · dgeb · May 19, 2024 · Dec 22, 2021 · Jan 18, 2022 · Jan 24, 2022
diff --git a/.github/workflows/node.yml b/.github/workflows/node.yml
@@ -0,0 +1,27 @@
+name: Schema validation tests
+
+on:
+  push:
+    branches: [ gh-pages, schema-1.0 ]
+  pull_request:
+    branches: [ gh-pages ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Install dependencies
+        run: npm ci
+      - name: Test schemas
+        run: npm run test-schema
diff --git a/.gitignore b/.gitignore
@@ -25,3 +25,7 @@ Gemfile.lock
 /bin
 /b
 .rbx
+
+# Ignore the node_modules directory
+
+/node_modules
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -17,3 +17,28 @@ place. Ideas for new extensions and questions about how to correctly implement
 or consume an API that adheres to the JSON:API specification belong here.
 
 [about]: http://jsonapi.org/about
+
+## JSON Schema
+If you would like to update the JSON schemas, you must first install the node.js dependencies :
+
+`
+npm install
+`
+
+Then you can run the schema validator by running one of the following commands :
+
+`
+node ./_schemas/scripts/validator.js
+`
+
+or
+
+`
+npm run test-schema
+`
+
+This script validates all test files against all available versions of the specification.
+Some options can be used :
+- `--verbose` : allows more verbose output.
+- `-f relative-path` : the relative path of the only file to test. For example : `npm run test-schema -- -f _schemas/1.0/response/valid/with_success/complete.json`
+- `-v version` : the version of the specification to use to test the files. For example : `npm run test-schema -- -v 1.0`
-Original file line number
+Diff line change
@@ Expand Up / @@ -25,3 +25,7 @@ Gemfile.lock @@
     /bin
     /b
     .rbx
+    # Ignore the node_modules directory
+    /node_modules