update current version

.cspell

@@ -2,6 +2,7 @@ aarch
 actiongroup
 actiongroups
 aggregatable
+aoss
 APIV
 argjson
 asciifolding
@@ -59,6 +60,7 @@ gsub
 Gsub
 haasephonetik
 heteroscedastic
+hnsw
 homoscedastic
 hotthreads
 huggingface
@@ -74,6 +76,7 @@ kstem
 kuromoji
 Kuromoji
 languageset
+localstats
 Lovins
 lucene
 Lucene
@@ -90,7 +93,6 @@ mmapfs
 mmdb
 mokotoff
 Moneyball
-Moneyball
 msearch
 msmarco
 mtermvectors
@@ -131,11 +133,15 @@ readingform
 rebalance
 Rebalance
 recoverysource
+Refn
 reindex
 Reindex
 relo
 reloadcerts
 remotestore
+rerank
+Rerank
+Reranker
 rethrottle
 Rethrottle
 rolesmapping
@@ -165,6 +171,7 @@ subqueries
 subschemas
 subword
 syserr
+tcnative
 tdigest
 tenantinfo
 termvectors
@@ -176,6 +183,7 @@ translog
 Translog
 tubone
 ulimits
+Undeploys
 unigrams
 Unmanaged
 unmatch

.github/workflows/analyze-pr-changes.yml

@@ -57,7 +57,7 @@ jobs:
             -e OPENSEARCH_INITIAL_ADMIN_PASSWORD="$OPENSEARCH_PASSWORD" \
             opensearch-with-api-plugin
 
-          npm install
+          npm ci
 
           npm run dump-cluster-spec -- --opensearch-insecure --output $CLUSTER_SPEC
 
@@ -72,7 +72,7 @@ jobs:
       - name: Build BEFORE Spec
         shell: bash -eo pipefail {0}
         run: |
-          npm install
+          npm ci
           npm run merge -- --source ./spec --output $BEFORE_SPEC
 
       - name: Checkout AFTER Spec
@@ -82,7 +82,7 @@ jobs:
       - name: Build AFTER Spec
         shell: bash -eo pipefail {0}
         run: |
-          npm install
+          npm ci
           npm run merge -- --source ./spec --output $AFTER_SPEC
 
       - name: Calculate Coverage
@@ -216,4 +216,4 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: pr-comment
-          path: pr-comment.json
+          path: pr-comment.json

.github/workflows/build.yml

@@ -21,7 +21,7 @@ jobs:
           node-version: '20'
 
       - name: Build
-        run: npm install && npm run merge
+        run: npm ci && npm run merge
 
       - name: Extract Branch Name
         id: branch

.github/workflows/changelog.yml

@@ -7,7 +7,7 @@ jobs:
   verify-changelog:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           ref: ${{ github.event.pull_request.head.sha }}

.github/workflows/lint.yml

@@ -25,7 +25,7 @@ jobs:
           node-version: '20'
 
       - name: Install Dependencies
-        run: npm install
+        run: npm ci
 
       - name: Lint
         run: npm run lint

.github/workflows/test-spec.yml

@@ -23,22 +23,31 @@ jobs:
     strategy:
       matrix:
         entry:
-          - {version: 1.3.17, admin_password: admin}
-          - {version: 2.0.0, admin_password: admin}
-          - {version: 2.15.0}
+          - version: 1.3.17
+            admin_password: admin
+          - version: 2.0.0
+            admin_password: admin
           - version: 2.16.0
+          - version: 2.16.0
+            tests: plugins/index_state_management
+          - version: 2.16.0
+            tests: snapshot
+          - version: 2.17.0
             hub: opensearchstaging
-            ref: '@sha256:50fbfe3b95c41e92a113ada3e80513ba4524dfc8a25dc6aaeff2bbe1e1145d5f'
+            ref: '@sha256:ed4274522a50228f41b50f1a7ea86e6b52fa6737072fc151b2624d22aff80d56'
+          - version: 3.0.0
+            hub: opensearchstaging
+            ref: '@sha256:cab6f71b284485c44306f8f4849ad520283c2a32ece617109b38183ba29cc401'
 
-    name: test-opensearch-spec (version=${{ matrix.entry.version }}, hub=${{ matrix.entry.hub || 'opensearchproject' }})
+    name: test-opensearch-spec (version=${{ matrix.entry.version }}, hub=${{ matrix.entry.hub || 'opensearchproject' }}, tests=${{ matrix.entry.tests || 'default' }})
     runs-on: ubuntu-latest
 
     env:
       OPENSEARCH_DOCKER_HUB_PROJECT: ${{ matrix.entry.hub || 'opensearchproject' }}
       OPENSEARCH_DOCKER_REF: ${{ matrix.entry.ref }}
       OPENSEARCH_VERSION: ${{ matrix.entry.version }}
       OPENSEARCH_PASSWORD: ${{ matrix.entry.admin_password || 'myStrongPassword123!' }}
-      OPENSEARCH_JAVA_OPTS: ${{ matrix.entry.opts }}
+      OPENSEARCH_JAVA_OPTS: ${{ matrix.entry.opts }} -Xms8g -Xmx8g
 
     steps:
       - name: Checkout Repo
@@ -50,31 +59,43 @@ jobs:
           node-version: '20'
 
       - name: Install Dependencies
-        run: npm install
+        run: npm ci
 
       - name: Run OpenSearch Cluster
-        working-directory: .github/opensearch-cluster
+        working-directory: tests/${{ matrix.entry.tests || 'default' }}
         run: docker compose up -d
 
+      - name: Get Container ID
+        id: container
+        run: |
+          echo "CONTAINER_ID=$(docker ps -aqf "ancestor=opensearchproject/opensearch:${{ matrix.entry.version }}")" >> $GITHUB_OUTPUT
+
       - name: Run Tests
         run: |
           npm run test:spec -- \
             --opensearch-insecure --verbose\
             --opensearch-version=${{ matrix.entry.version }} \
-            --coverage coverage/test-spec-coverage-${{ matrix.entry.version }}.json
+            --coverage coverage/test-spec-coverage-${{ matrix.entry.version }}-${{ matrix.entry.tests || 'default' }}.json \
+            --tests=tests/${{ matrix.entry.tests || 'default' }}
+
+      - name: Get Container Logs
+        if: failure() && steps.container.outputs.CONTAINER_ID
+        run: |
+          echo Dumping logs from ${{ steps.container.outputs.CONTAINER_ID }} ...
+          docker logs ${{ steps.container.outputs.CONTAINER_ID }}
 
       - name: Upload Test Coverage Results
         uses: actions/upload-artifact@v4
         with:
-          name: coverage-${{ matrix.entry.version }}
-          path: coverage/test-spec-coverage-${{ matrix.entry.version }}.json
+          name: coverage-${{ matrix.entry.version }}-${{ hashFiles(format('tests/{0}', matrix.entry.tests || 'default')) }}
+          path: coverage/test-spec-coverage-${{ matrix.entry.version }}-${{ matrix.entry.tests || 'default' }}.json
 
   merge-coverage:
     runs-on: ubuntu-latest
     if: github.event_name == 'pull_request'
     needs: test-opensearch-spec
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Download Spec Coverage Data
         uses: actions/download-artifact@v4

.github/workflows/test-tools-integ.yml

@@ -24,15 +24,15 @@ jobs:
   test:
     runs-on: ubuntu-latest
     env:
-      OPENSEARCH_VERSION: 2.15.0
+      OPENSEARCH_VERSION: 2.16.0
       OPENSEARCH_PASSWORD: myStrongPassword123!
       OPENSEARCH_URL: https://localhost:9200
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v4
 
       - name: Run OpenSearch Cluster
-        working-directory: .github/opensearch-cluster
+        working-directory: tests/default
         run: |
           docker compose up -d
           sleep 15
@@ -43,7 +43,7 @@ jobs:
           node-version: '20'
 
       - name: Install Dependencies
-        run: npm install
+        run: npm ci
 
       - name: Tests
         run: |
@@ -52,4 +52,4 @@ jobs:
       - name: Upload coverage to Codecov
         uses: codecov/[email protected]
         with:
-          token: ${{ secrets.CODECOV_TOKEN }}
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/test-tools-unit.yml

@@ -33,7 +33,7 @@ jobs:
           node-version: '20'
 
       - name: Install Dependencies
-        run: npm install
+        run: npm ci
 
       - name: Tests
         run: |
@@ -42,4 +42,4 @@ jobs:
       - name: Upload coverage to Codecov
         uses: codecov/[email protected]
         with:
-          token: ${{ secrets.CODECOV_TOKEN }}
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/validate-spec.yml

@@ -25,7 +25,7 @@ jobs:
           node-version: '20'
 
       - name: Install Dependencies
-        run: npm install
+        run: npm ci
 
       - name: Lint Spec
         run: npm run lint:spec

.lycheeignore

@@ -1 +1 @@
-https://localhost:9200*
+https://localhost:*

CHANGELOG.md

@@ -41,7 +41,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added `concurrent_query_*` and `search_idle_reactivate_count_total` fields to `SearchStats` ([#395](https://github.com/opensearch-project/opensearch-api-specification/pull/395))
 - Added `remote_store` to `TranslogStats` ([#395](https://github.com/opensearch-project/opensearch-api-specification/pull/395))
 - Added `file` to `/_cache/clear` and `/{index}/_cache/clear` ([#396](https://github.com/opensearch-project/opensearch-api-specification/pull/396))
-- Add `strict_allow_templates` option for the dynamic mapping parameter ([#408](https://github.com/opensearch-project/opensearch-api-specification/pull/408))
+- Added `strict_allow_templates` option for the dynamic mapping parameter ([#408](https://github.com/opensearch-project/opensearch-api-specification/pull/408))
 - Added a workflow to run tests against the next version of OpenSearch ([#409](https://github.com/opensearch-project/opensearch-api-specification/pull/409))
 - Added support for skipping tests using semver range ([#410](https://github.com/opensearch-project/opensearch-api-specification/pull/410))
 - Added `cluster_manager_timeout` to `HEAD /{index}` ([#421](https://github.com/opensearch-project/opensearch-api-specification/pull/421))
@@ -54,12 +54,29 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added `plugins` to NodeInfoSettings ([#442](https://github.com/opensearch-project/opensearch-api-specification/pull/442)) 
 - Added test coverage ([#443](https://github.com/opensearch-project/opensearch-api-specification/pull/443))
 - Added `--opensearch-version` to `merger` that excludes schema elements per semver ([#428](https://github.com/opensearch-project/opensearch-api-specification/pull/428))
-- Added `retry` to `tester` to support asynchronous tasks ([453](https://github.com/opensearch-project/opensearch-api-specification/pull/453))
+- Added `retry` to `tester` to support asynchronous tasks ([#453](https://github.com/opensearch-project/opensearch-api-specification/pull/453))
 - Added passing OPENSEARCH_JAVA_OPTS into the docker container used for tests ([#454](https://github.com/opensearch-project/opensearch-api-specification/pull/454))
 - Added a warning on mulitple paths being tested in the same file ([#452](https://github.com/opensearch-project/opensearch-api-specification/pull/452))
+- Added validation of titles and descriptions in info and schema objects ([#463](https://github.com/opensearch-project/opensearch-api-specification/pull/463))
 - Added `/_plugins/_query/settings` ([#456](https://github.com/opensearch-project/opensearch-api-specification/pull/456))
 - Added `/_plugins/_ppl`, `explain` and `stats` ([#460](https://github.com/opensearch-project/opensearch-api-specification/pull/460))
-- Added `replication` namespace specs  ([464](https://github.com/opensearch-project/opensearch-api-specification/pull/464))
+- Added tests against OpenSearch 3.0 ([#459](https://github.com/opensearch-project/opensearch-api-specification/pull/459))
+- Added support for request headers in tests [#461](https://github.com/opensearch-project/opensearch-api-specification/pull/461)
+- Added metadata additionalProperties to `ErrorCause` ([#462](https://github.com/opensearch-project/opensearch-api-specification/pull/462))
+- Added `creation_date` field to `DanglingIndex` ([#462](https://github.com/opensearch-project/opensearch-api-specification/pull/462))
+- Added doc on `cluster create-index blocked` workaround ([#465](https://github.com/opensearch-project/opensearch-api-specification/pull/465))
+- Added `observability` namespace API specifications ([#474](https://github.com/opensearch-project/opensearch-api-specification/pull/474))
+- Added support for reusing output variables as keys in payload expectations ([#471](https://github.com/opensearch-project/opensearch-api-specification/pull/471))
+- Added support for running tests against Amazon OpenSearch ([#476](https://github.com/opensearch-project/opensearch-api-specification/pull/476))
+- Added API spec for security plugin  ([#271](https://github.com/opensearch-project/opensearch-api-specification/pull/271))
+- Added `/_plugins/_security/api/certificates/` ([#439](https://github.com/opensearch-project/opensearch-api-specification/pull/439))
+- Added `/_plugins/_ml/models/{model_id}/_deploy`, `_undeploy` and `knn_vector` type in `passage_embedding` ([#504](https://github.com/opensearch-project/opensearch-api-specification/pull/504))
+- Added `PersonalizeSearchRanking`, `RetrievalAugmentedGeneration`, `Rerank`, `Collapse`, `TruncateHits` and `SplitResponseProcessor` ([#505](https://github.com/opensearch-project/opensearch-api-specification/pull/505))
+- Added `/_plugins/_security/api/certificates/` to API spec  ([#439](https://github.com/opensearch-project/opensearch-api-specification/pull/439))
+- Added support for annotating and testing the API spec against multiple OpenSearch distributions ([#483](https://github.com/opensearch-project/opensearch-api-specification/pull/483))
+- Added `read_time`, `write_time`, `queue_size` and `io_time_in_millis` to `IoStatDevice` ([#483](https://github.com/opensearch-project/opensearch-api-specification/pull/483))
+- Added `total_rejections_breakup` to `ShardIndexingPressureStats` ([#483](https://github.com/opensearch-project/opensearch-api-specification/pull/483))
+- Added `cancelled_task_percentage` and `current_cancellation_eligible_tasks_count` to `ShardSearchBackpressureTaskCancellationStats` ([#483](https://github.com/opensearch-project/opensearch-api-specification/pull/483))
 
 ### Changed
 
@@ -72,6 +89,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Tester tool now provides better context for non-2XX responses when --verbose is used ([#359](https://github.com/opensearch-project/opensearch-api-specification/pull/359))
 - Lock testing for next release of OpenSearch to a specific SHA ([#431](https://github.com/opensearch-project/opensearch-api-specification/pull/431))
 - Replace nullable with null type ([#436](https://github.com/opensearch-project/opensearch-api-specification/pull/436))
+- Split test suite ([#472])(https://github.com/opensearch-project/opensearch-api-specification/pull/472)
 
 ### Deprecated
 
@@ -99,7 +117,11 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Fixed `/_mapping` with `index` in query ([#385](https://github.com/opensearch-project/opensearch-api-specification/pull/385))
 - Fixed duplicate `/_nodes/{node_id}` path ([#416](https://github.com/opensearch-project/opensearch-api-specification/pull/416))
 - Fixed `_source` accepting an array of fields in `/_search` ([#430](https://github.com/opensearch-project/opensearch-api-specification/pull/430))
-- Fixed `_update_by_query` with a simple term ([451](https://github.com/opensearch-project/opensearch-api-specification/pull/451))
+- Fixed `_update_by_query` with a simple term ([#451](https://github.com/opensearch-project/opensearch-api-specification/pull/451))
+- Fixed `Duration` to allow for non-integers ([#479](https://github.com/opensearch-project/opensearch-api-specification/pull/479))
+- Fixed accuracy of the index stats schemas ([#491](https://github.com/opensearch-project/opensearch-api-specification/pull/491))
+- Fixed security spec to add support for 400 and 403s ([#439](https://github.com/opensearch-project/opensearch-api-specification/pull/439))
+- Fixed required parameters in `NodeInfo` and `NodeOperatingSystemInfo` ([#483](https://github.com/opensearch-project/opensearch-api-specification/pull/483))
 
 ### Security