Prepare files for Vale.

Signed-off-by: dblock <[email protected]>

.cspell

@@ -58,7 +58,6 @@ Geohex
 geoip
 geopoint
 geoshape
-geospacial
 geospatial
 geotile
 gsub
@@ -77,7 +76,6 @@ Intertransport
 Jelinek
 kibanainfo
 kibanaserver
-kmeans
 koelnerphonetik
 kstem
 kuromoji
@@ -135,7 +133,6 @@ Oversample
 performanceanalyzer
 permissionsinfo
 pipefail
-postmigration
 preconfigure
 preconfigured
 prefilter

.github/vale/styles/OpenSearch/SubstitutionsError.yml

@@ -16,7 +16,6 @@ swap:
   geo point: geopoint
   geo shape: geoshape
   geo tile: geotile
-  geospacial: geospatial
   hard code: hardcode
   high-performance computing: high performance computing
   host name: hostname
@@ -25,11 +24,9 @@ swap:
   ingestion pipeline: ingest pipeline
   key store: keystore
   key/value: key-value
-  kmeans: k-means
   kNN: k-NN
   machine-learning: machine learning
   nonproduction: non-production
-  postmigration: post-migration
   pre-configure: preconfigure
   pre-configured: preconfigured
   pre-defined: predefined

.github/workflows/lint.yml

@@ -31,9 +31,3 @@ jobs:
 
       - name: Lint
         run: npm run lint
-
-      - name: Check Style
-        uses: errata-ai/[email protected]
-        with:
-          version: 3.7.1
-          files: '["spec","tests"]'

.github/workflows/style.yml

@@ -0,0 +1,31 @@
+name: Style
+
+on: [pull_request, push]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20'
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: Prepare for Vale (spec)
+        run: npm run style:prepare -- --source spec
+
+      - name: Prepare for Vale (test)
+        run: npm run style:prepare -- --source tests
+
+      - name: Check Style
+        uses: errata-ai/[email protected]
+        with:
+          version: 3.7.1
+          vale_flags: --ignore-syntax
+          files: '["spec", "tests"]'

CHANGELOG.md

@@ -102,6 +102,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added `404` response for `DELETE /{index}`, `GET /{index}/_doc/{id}`, `DELETE /{index}/_doc/{id}` ([#589](https://github.com/opensearch-project/opensearch-api-specification/pull/589))
 - Added ability to pass `InlineScript` as a simple string ([#605](https://github.com/opensearch-project/opensearch-api-specification/pull/605))
 - Added `config_id` and `config_id_list` to `/_plugins/_notifications/configs` query parameters ([#594](https://github.com/opensearch-project/opensearch-api-specification/pull/594))
+- Added a spec style checker [#620](https://github.com/opensearch-project/opensearch-api-specification/pull/620).
 
 ### Changed