Added distributions/included and excluded. (#510)

* Added distributions/included and excluded. Signed-off-by: dblock <[email protected]> * Test distribution before version. Signed-off-by: dblock <[email protected]> * Passing npm run test:spec -- --opensearch-distribution=amazon-managed against Amazon OpenSearch 2.13. Signed-off-by: dblock <[email protected]> --------- Signed-off-by: dblock <[email protected]>
opensearch-project · Aug 14, 2024 · df34927 · df34927
1 parent 7dee041
commit df34927
Show file tree

Hide file tree

Showing 68 changed files with 610 additions and 81 deletions.
diff --git a/TESTING_GUIDE.md b/TESTING_GUIDE.md
@@ -228,13 +228,16 @@ OpenSearch consists of plugins that may or may not be present in various distrib
     description: Returns basic information about the cluster.
 ```
 
-Similarly, skip tests that are not applicable to a distribution by listing the distributions that support it.
+Similarly, skip tests that are not applicable to a distribution by listing the distributions that support or do not support it.
 
 ```yaml
 description: Test root endpoint.
 distributions:
-  - amazon-managed
-  - opensearch.org
+  included:
+    - amazon-managed
+    - opensearch.org
+  excluded:
+    - amazon-serverless
 chapters:
   - synopsis: Get server info.
     path: /

diff --git a/json_schemas/test_story.schema.yaml b/json_schemas/test_story.schema.yaml
@@ -111,6 +111,16 @@ definitions:
     type: string
 
   Distributions:
+    description: |
+      The list of distributions that support this API.
+    type: object
+    properties:
+      included:
+        $ref: '#/definitions/DistributionsList'
+      excluded:
+        $ref: '#/definitions/DistributionsList'
+
+  DistributionsList:
     description: |
       The list of distributions that support this API.
     type: array

diff --git a/spec/namespaces/cat.yaml b/spec/namespaces/cat.yaml
@@ -291,6 +291,9 @@ paths:
       operationId: cat.nodeattrs.0
       x-operation-group: cat.nodeattrs
       x-version-added: '1.0'
+      x-distributions-excluded:
+        - amazon-managed
+        - amazon-serverless
       description: Returns information about custom node attributes.
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/cat/cat-nodeattrs/

diff --git a/spec/namespaces/indices.yaml b/spec/namespaces/indices.yaml
@@ -189,6 +189,9 @@ paths:
       operationId: indices.clear_cache.0
       x-operation-group: indices.clear_cache
       x-version-added: '1.0'
+      x-distributions-excluded:
+        - amazon-managed
+        - amazon-serverless
       description: Clears all or specific caches for one or more indices.
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/
@@ -319,6 +322,9 @@ paths:
       operationId: indices.forcemerge.0
       x-operation-group: indices.forcemerge
       x-version-added: '1.0'
+      x-distributions-excluded:
+        - amazon-managed
+        - amazon-serverless
       description: Performs the force merge operation on one or more indices.
       externalDocs:
         url: https://opensearch.org/docs/latest
@@ -589,6 +595,9 @@ paths:
       operationId: indices.segments.0
       x-operation-group: indices.segments
       x-version-added: '1.0'
+      x-distributions-excluded:
+        - amazon-managed
+        - amazon-serverless
       description: Provides low-level information about segments in a Lucene index.
       externalDocs:
         url: https://opensearch.org/docs/latest
@@ -605,6 +614,9 @@ paths:
       operationId: indices.get_settings.0
       x-operation-group: indices.get_settings
       x-version-added: '1.0'
+      x-distributions-excluded:
+        - amazon-managed
+        - amazon-serverless
       description: Returns settings for one or more indices.
       externalDocs:
         url: https://opensearch.org/docs/latest/api-reference/index-apis/get-settings/
@@ -1564,6 +1576,9 @@ paths:
       operationId: indices.segments.1
       x-operation-group: indices.segments
       x-version-added: '1.0'
+      x-distributions-excluded:
+        - amazon-managed
+        - amazon-serverless
       description: Provides low-level information about segments in a Lucene index.
       externalDocs:
         url: https://opensearch.org/docs/latest