using common structures in replication schemes

Signed-off-by: Tokesh <[email protected]>
opensearch-project · Nov 17, 2024 · 0ab0105 · 0ab0105
1 parent 9e1e502
commit 0ab0105
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 48 deletions.
diff --git a/.github/workflows/test-spec.yml b/.github/workflows/test-spec.yml
@@ -36,10 +36,9 @@ jobs:
             tests: routing
           - version: 2.18.0
             tests: snapshot
-          - version: 2.16.0
+          - version: 2.18.0
             tests: plugins/replication
             url: http://localhost:9200
-          - version: 2.17.0
           - version: 2.18.0
             tests: plugins/streaming
           - version: 2.18.0

diff --git a/spec/namespaces/replication.yaml b/spec/namespaces/replication.yaml
@@ -248,34 +248,22 @@ components:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              acknowledged:
-                type: boolean
+            $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase'
     replication.stop@200:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              acknowledged:
-                type: boolean
+            $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase'
     replication.pause@200:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              acknowledged:
-                type: boolean
+            $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase'
     replication.resume@200:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              acknowledged:
-                type: boolean
+            $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase'
     replication.status@200:
       content:
         application/json:
@@ -300,23 +288,14 @@ components:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              acknowledged:
-                type: boolean
+            $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase'
     replication.create_replication_rule@200:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              acknowledged:
-                type: boolean
+            $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase'
     replication.delete_replication_rule@200:
       content:
         application/json:
           schema:
-            type: object
-            properties:
-              acknowledged:
-                type: boolean
+            $ref: '../schemas/_common.yaml#/components/schemas/AcknowledgedResponseBase'
diff --git a/spec/schemas/replication._common.yaml b/spec/schemas/replication._common.yaml
@@ -10,9 +10,9 @@ components:
       type: object
       properties:
         leader_alias:
-          type: string
+          $ref: '_common.yaml#/components/schemas/IndexAlias'
         leader_index:
-          type: string
+          $ref: '_common.yaml#/components/schemas/IndexName'
         use_roles:
           $ref: '#/components/schemas/UseRoles'
     UseRoles:
@@ -27,14 +27,19 @@ components:
       properties:
         status:
           type: string
+          enum:
+            - BOOTSTRAPPING
+            - PAUSED
+            - REPLICATION NOT IN PROGRESS
+            - SYNCING
         reason:
           type: string
         leader_alias:
-          type: string
+          $ref: '_common.yaml#/components/schemas/IndexAlias'
         leader_index:
-          type: string
+          $ref: '_common.yaml#/components/schemas/IndexName'
         follower_index:
-          type: string
+          $ref: '_common.yaml#/components/schemas/IndexName'
         syncing_details:
           $ref: '#/components/schemas/SyncingDetails'
     SyncingDetails:
@@ -45,7 +50,7 @@ components:
         follower_checkpoint:
           type: integer
         seq_no:
-          type: integer
+          $ref: '_common.yaml#/components/schemas/SequenceNumber'
     LeaderStatus:
       type: object
       properties:
@@ -54,17 +59,17 @@ components:
         operations_read:
           type: number
         translog_size_bytes:
-          type: number
+          $ref: '_common.yaml#/components/schemas/ByteCount'
         operations_read_lucene:
           type: number
         operations_read_translog:
           type: number
         total_read_time_lucene_millis:
-          type: number
+          $ref: '_common.yaml#/components/schemas/StringifiedEpochTimeUnitMillis'
         total_read_time_translog_millis:
-          type: number
+          $ref: '_common.yaml#/components/schemas/StringifiedEpochTimeUnitMillis'
         bytes_read:
-          type: number
+          $ref: '_common.yaml#/components/schemas/ByteCount'
         index_stats:
           type: object
           additionalProperties:
@@ -75,17 +80,17 @@ components:
         operations_read:
           type: number
         translog_size_bytes:
-          type: number
+          $ref: '_common.yaml#/components/schemas/ByteCount'
         operations_read_lucene:
           type: number
         operations_read_translog:
           type: number
         total_read_time_lucene_millis:
-          type: number
+          $ref: '_common.yaml#/components/schemas/StringifiedEpochTimeUnitMillis'
         total_read_time_translog_millis:
-          type: number
+          $ref: '_common.yaml#/components/schemas/StringifiedEpochTimeUnitMillis'
         bytes_read:
-          type: number
+          $ref: '_common.yaml#/components/schemas/ByteCount'
     FollowerStatus:
       type: object
       properties:
@@ -118,7 +123,7 @@ components:
         leader_checkpoint:
           type: number
         total_write_time_millis:
-          type: number
+          $ref: '_common.yaml#/components/schemas/StringifiedEpochTimeUnitMillis'
         index_stats:
           type: object
           additionalProperties:
@@ -143,7 +148,7 @@ components:
         leader_checkpoint:
           type: number
         total_write_time_millis:
-          type: number
+          $ref: '_common.yaml#/components/schemas/StringifiedEpochTimeUnitMillis'
     AutoFollowStatus:
       type: object
       properties:
@@ -208,7 +213,7 @@ components:
       type: object
       properties:
         leader_alias:
-          type: string
+          $ref: '_common.yaml#/components/schemas/IndexAlias'
         name:
           type: string
         pattern:
@@ -219,6 +224,6 @@ components:
       type: object
       properties:
         leader_alias:
-          type: string
+          $ref: '_common.yaml#/components/schemas/IndexAlias'
         name:
           type: string