Fixed schema validation for invalid properties in retry configuration. (

#758) * Fixed schema validation for invalid properties in retry configuration. Signed-off-by: Nathalie Jonathan <[email protected]> * Updated link to PR in CHANGELOG.md. Signed-off-by: Nathalie Jonathan <[email protected]> * Added a test for the invalid property. Signed-off-by: Nathalie Jonathan <[email protected]> --------- Signed-off-by: Nathalie Jonathan <[email protected]>
opensearch-project · Jan 2, 2025 · 24872ec · 24872ec
1 parent a3849b4
commit 24872ec
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -84,6 +84,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Fixed type in `_msearch/template` ([#735](https://github.com/opensearch-project/opensearch-api-specification/pull/735))
 - Fixed indices API schemas ([#750](https://github.com/opensearch-project/opensearch-api-specification/pull/750))
 - Fixed cluster API schemas ([#754](https://github.com/opensearch-project/opensearch-api-specification/pull/754))
+- Fixed schema validation for invalid properties in `retry` configuration ([#758](https://github.com/opensearch-project/opensearch-api-specification/pull/758))
 
 ### Changed
 - Changed `tasks._common:TaskInfo` and `tasks._common:TaskGroup` to be composed of a `tasks._common:TaskInfoBase` ([#683](https://github.com/opensearch-project/opensearch-api-specification/pull/683))

diff --git a/json_schemas/test_story.schema.yaml b/json_schemas/test_story.schema.yaml
@@ -155,17 +155,17 @@ definitions:
   Retry:
     description: |
       Number of times to retry on error.
-    oneOf:
-      - type: object
-        properties:
-          count: 
-            type: integer
-            description: Number of retries.
-          wait:
-            type: integer
-            description: Number of milliseconds to wait before retrying.
-        required:
-          - count
+    type: object
+    properties:
+      count: 
+        type: integer
+        description: Number of retries.
+      wait:
+        type: integer
+        description: Number of milliseconds to wait before retrying.
+    required:
+      - count
+    additionalProperties: false
 
   Request:
     type: object

diff --git a/tools/tests/tester/StoryValidator.test.ts b/tools/tests/tester/StoryValidator.test.ts
@@ -45,6 +45,13 @@ describe('StoryValidator', () => {
       "data/chapters/0/synopsis must match pattern \"^\\p{Lu}[\\s\\S]*\\.$|^\\p{Lu}[\\s\\S]*\\. \\[(GET|PUT|POST|DELETE|PATCH|HEAD|OPTIONS)\\]$\"")
   })
 
+  test('invalid property', () => {
+    const evaluation = validate('tools/tests/tester/fixtures/invalid_property.yaml')
+    expect(evaluation?.result).toBe('ERROR')
+    expect(evaluation?.message).toBe("Invalid Story: " +
+      "data/prologues/0/retry contains unsupported properties: until")
+  })
+
   test('valid story', () => {
     const evaluation = validate('tools/tests/tester/fixtures/valid_story.yaml')
     expect(evaluation).toBeUndefined()

diff --git a/tools/tests/tester/fixtures/invalid_property.yaml b/tools/tests/tester/fixtures/invalid_property.yaml
@@ -0,0 +1,20 @@
+$schema: ../../../../json_schemas/test_story.schema.yaml
+
+description: This story has invalid property for retry configuration when validated against test_story.schema.yaml.
+prologues:
+  - path: /{index}
+    method: GET
+    retry:
+      count: 5
+      wait: 30000
+      until: # invalid property
+        - path: payload.state
+          equal: COMPLETED
+epilogues:
+  - path: /{index}
+    method: DELETE
+    status: [200, 404]
+chapters:
+  - synopsis: Delete index.
+    path: /{index}
+    method: DELETE