Fixed /_cat/pit_segments/{pit_id}, /_cat/cluster_manager, `/_cat/…

…allocation`, `/_cat/shards`, and `/_cat/thread_pool`. Signed-off-by: dblock <[email protected]>
opensearch-project · Jul 2, 2024 · 89b2e32 · 89b2e32
1 parent d25459f
commit 89b2e32
Show file tree

Hide file tree

Showing 30 changed files with 490 additions and 21 deletions.
diff --git a/.github/opensearch-cluster/docker-compose.yml b/.github/opensearch-cluster/docker-compose.yml
@@ -8,4 +8,5 @@ services:
       - "9600:9600"
     environment:
       - discovery.type=single-node
-      - "OPENSEARCH_INITIAL_ADMIN_PASSWORD=${OPENSEARCH_PASSWORD:-myStrongPassword123!}"
+      - "OPENSEARCH_INITIAL_ADMIN_PASSWORD=${OPENSEARCH_PASSWORD:-myStrongPassword123!}"
+      - "path.repo=/tmp/opensearch/repo"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -58,6 +58,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Fixed `pages_processed` in `/_plugins/_rollup` ([#341](https://github.com/opensearch-project/opensearch-api-specification/pull/341))
 - Fixed `_bulk` spec request and response types ([#355](https://github.com/opensearch-project/opensearch-api-specification/pull/355))
 - Fixed `text/plain` response in `/_cat` ([#357](https://github.com/opensearch-project/opensearch-api-specification/pull/357))
+- Fixed `/_cat/cluster_manager`, `/_cat/allocation`, `/_cat/shards`, and `/_cat/thread_pool` ([#373](https://github.com/opensearch-project/opensearch-api-specification/pull/373))
 
 ### Security
 

diff --git a/spec/namespaces/cat.yaml b/spec/namespaces/cat.yaml
@@ -818,6 +818,14 @@ components:
               $ref: '../schemas/cat.allocation.yaml#/components/schemas/AllocationRecord'
     cat.cluster_manager@200:
       description: ''
+      content:
+        text/plain:
+          type: string
+        application/json:
+          schema:
+            type: array
+            items:
+              $ref: '../schemas/cat.cluster_manager.yaml#/components/schemas/ClusterManagerRecord'
     cat.count@200:
       description: ''
       content:
@@ -1768,7 +1776,7 @@ components:
       name: full_id
       description: If `true`, return the full node ID. If `false`, return the shortened node ID.
       schema:
-        oneOf:
+        anyOf:
           - type: boolean
           - type: string
         default: false

diff --git a/spec/schemas/cat.allocation.yaml b/spec/schemas/cat.allocation.yaml
@@ -16,7 +16,7 @@ components:
           description: |-
             Disk space used by the node’s shards. Does not include disk space for the translog or unassigned shards.
             IMPORTANT: This metric double-counts disk space for hard-linked files, such as those created when shrinking, splitting, or cloning an index.
-          oneOf:
+          anyOf:
             - $ref: '_common.yaml#/components/schemas/ByteSize'
             - nullable: true
               type: string
@@ -26,7 +26,7 @@ components:
             OpenSearch retrieves this metric from the node’s operating system (OS).
             The metric includes disk space for: OpenSearch, including the translog and unassigned shards; the node’s operating system; any other applications or files on the node.
             Unlike `disk.indices`, this metric does not double-count disk space for hard-linked files.
-          oneOf:
+          anyOf:
             - $ref: '_common.yaml#/components/schemas/ByteSize'
             - nullable: true
               type: string
@@ -35,31 +35,31 @@ components:
             Free disk space available to OpenSearch.
             OpenSearch retrieves this metric from the node’s operating system.
             Disk-based shard allocation uses this metric to assign shards to nodes based on available disk space.
-          oneOf:
+          anyOf:
             - $ref: '_common.yaml#/components/schemas/ByteSize'
             - nullable: true
               type: string
         disk.total:
           description: Total disk space for the node, including in-use and available space.
-          oneOf:
+          anyOf:
             - $ref: '_common.yaml#/components/schemas/ByteSize'
             - nullable: true
               type: string
         disk.percent:
           description: Total percentage of disk space in use. Calculated as `disk.used / disk.total`.
-          oneOf:
+          anyOf:
             - $ref: '_common.yaml#/components/schemas/Percentage'
             - nullable: true
               type: string
         host:
           description: Network host for the node. Set using the `network.host` setting.
-          oneOf:
+          anyOf:
             - $ref: '_common.yaml#/components/schemas/Host'
             - nullable: true
               type: string
         ip:
           description: IP address and port for the node.
-          oneOf:
+          anyOf:
             - $ref: '_common.yaml#/components/schemas/Ip'
             - nullable: true
               type: string

diff --git a/spec/schemas/cat.cluster_manager.yaml b/spec/schemas/cat.cluster_manager.yaml
@@ -0,0 +1,23 @@
+openapi: 3.1.0
+info:
+  title: Schemas of cat.cluster_manager category
+  description: Schemas of cat.cluster_manager category
+  version: 1.0.0
+paths: {}
+components:
+  schemas:
+    ClusterManagerRecord:
+      type: object
+      properties:
+        id:
+          description: node id
+          type: string
+        host:
+          description: host name
+          type: string
+        ip:
+          description: ip address
+          type: string
+        node:
+          description: node name
+          type: string
diff --git a/spec/schemas/cat.shards.yaml b/spec/schemas/cat.shards.yaml
@@ -29,19 +29,19 @@ components:
           type: string
         docs:
           description: The number of documents in the shard.
-          oneOf:
+          anyOf:
             - type: string
             - nullable: true
               type: string
         store:
           description: The disk space used by the shard.
-          oneOf:
+          anyOf:
             - type: string
             - nullable: true
               type: string
         ip:
           description: The IP address of the node.
-          oneOf:
+          anyOf:
             - type: string
             - nullable: true
               type: string
@@ -50,7 +50,7 @@ components:
           type: string
         node:
           description: The name of node.
-          oneOf:
+          anyOf:
             - type: string
             - nullable: true
               type: string

diff --git a/spec/schemas/cat.templates.yaml b/spec/schemas/cat.templates.yaml
@@ -19,7 +19,7 @@ components:
           type: string
         version:
           description: The template version.
-          oneOf:
+          anyOf:
             - $ref: '_common.yaml#/components/schemas/VersionString'
             - nullable: true
               type: string

diff --git a/spec/schemas/cat.thread_pool.yaml b/spec/schemas/cat.thread_pool.yaml
@@ -60,25 +60,25 @@ components:
           type: string
         core:
           description: The core number of active threads allowed in a scaling thread pool.
-          oneOf:
+          anyOf:
             - type: string
             - nullable: true
               type: string
         max:
           description: The maximum number of active threads allowed in a scaling thread pool.
-          oneOf:
+          anyOf:
             - type: string
             - nullable: true
               type: string
         size:
           description: The number of active threads allowed in a fixed thread pool.
-          oneOf:
+          anyOf:
             - type: string
             - nullable: true
               type: string
         keep_alive:
           description: The thread keep alive time.
-          oneOf:
+          anyOf:
             - type: string
             - nullable: true
               type: string
diff --git a/tests/_core/aliases.yaml b/tests/_core/aliases.yaml
@@ -0,0 +1,75 @@
+$schema: ../../json_schemas/test_story.schema.yaml
+
+description: Test aliases endpoints.
+epilogues:
+  - path: /games
+    method: DELETE
+    status: [200, 404]
+prologues:
+  - path: /{index}
+    method: PUT
+    parameters:
+      index: games
+chapters:
+  - synopsis: Create an alias.
+    path: /{index}/_aliases/{name}
+    method: PUT
+    parameters:
+      index: games
+      name: jeux
+  - synopsis: Get an alias from index.
+    method: GET
+    path: /{index}/_alias/{name}
+    parameters:
+      index: games
+      name: jeux
+    response:
+      status: 200
+      content_type: application/json
+      payload:
+        games:
+          aliases:
+            jeux: {}
+  - synopsis: Get an alias from _aliases.
+    method: GET
+    path: /_alias/{name}
+    parameters:
+      name: jeux
+    response:
+      status: 200
+      content_type: application/json
+      payload:
+        games:
+          aliases:
+            jeux: {}
+  - synopsis: Multiple alias operations.
+    path: /_aliases
+    method: POST
+    request_body:
+      payload:
+        actions:
+          - remove:
+              index: games
+              alias: jeux 
+          - add:
+              index: games
+              alias: plays1
+          - add:
+              index: games
+              alias: plays2
+    response:
+      status: 200
+      payload:
+        acknowledged: true
+  - synopsis: Delete an alias from _aliases.
+    path: /{index}/_aliases/{name}
+    method: DELETE
+    parameters:
+      index: games
+      name: plays1
+  - synopsis: Delete an alias from _alias.
+    path: /{index}/_alias/{name}
+    method: DELETE
+    parameters:
+      index: games
+      name: plays2
diff --git a/tests/cat/aliases.yaml b/tests/cat/aliases.yaml
@@ -1,6 +1,20 @@
 $schema: ../../json_schemas/test_story.schema.yaml
 
 description: Test cat/aliases endpoints.
+epilogues:
+  - path: /games
+    method: DELETE
+    status: [200, 404]
+prologues:
+  - path: /{index}
+    method: PUT
+    parameters:
+      index: games
+  - path: /{index}/_aliases/{name}
+    method: PUT
+    parameters:
+      index: games
+      name: jeux
 chapters:
   - synopsis: Cat with a text response.
     path: /_cat/aliases
@@ -16,4 +30,6 @@ chapters:
     response:
       status: 200
       content_type: application/json
-      payload: []
+      payload:
+        - alias: jeux
+          index: games
diff --git a/tests/cat/allocation.yaml b/tests/cat/allocation.yaml
@@ -0,0 +1,11 @@
+$schema: ../../json_schemas/test_story.schema.yaml
+
+description: Test cat/allocation endpoints.
+chapters:
+  - synopsis: Cat with a json response.
+    path: /_cat/allocation
+    method: GET
+    parameters:
+      format: json
+    response:
+      status: 200
diff --git a/tests/cat/cluster_manager.yaml b/tests/cat/cluster_manager.yaml
@@ -0,0 +1,11 @@
+$schema: ../../json_schemas/test_story.schema.yaml
+
+description: Test cat/cluster_manager endpoints.
+chapters:
+  - synopsis: Cat with a json response.
+    path: /_cat/cluster_manager
+    method: GET
+    parameters:
+      format: json
+    response:
+      status: 200
diff --git a/tests/cat/count.yaml b/tests/cat/count.yaml
@@ -0,0 +1,11 @@
+$schema: ../../json_schemas/test_story.schema.yaml
+
+description: Test cat/count endpoints.
+chapters:
+  - synopsis: Cat with a json response.
+    path: /_cat/count
+    method: GET
+    parameters:
+      format: json
+    response:
+      status: 200
diff --git a/tests/cat/fielddata.yaml b/tests/cat/fielddata.yaml
@@ -0,0 +1,13 @@
+$schema: ../../json_schemas/test_story.schema.yaml
+
+description: Test cat/fielddata endpoints.
+chapters:
+  - synopsis: Cat with a json response.
+    path: /_cat/fielddata
+    method: GET
+    parameters:
+      format: json
+    response:
+      status: 200
+      payload:
+        - field: log_types # from security-analytics
diff --git a/tests/cat/nodeattrs.yaml b/tests/cat/nodeattrs.yaml
@@ -0,0 +1,14 @@
+$schema: ../../json_schemas/test_story.schema.yaml
+
+description: Test cat/nodeattrs endpoints.
+chapters:
+  - synopsis: Cat with a json response.
+    path: /_cat/nodeattrs
+    method: GET
+    parameters:
+      format: json
+    response:
+      status: 200
+      payload:
+        - attr: shard_indexing_pressure_enabled
+          value: 'true'
diff --git a/tests/cat/nodes.yaml b/tests/cat/nodes.yaml
@@ -0,0 +1,13 @@
+$schema: ../../json_schemas/test_story.schema.yaml
+
+description: Test cat/nodes endpoints.
+chapters:
+  - synopsis: Cat with a json response.
+    path: /_cat/nodes
+    method: GET
+    parameters:
+      format: json
+    response:
+      status: 200
+      payload:
+        - cluster_manager: '*'
diff --git a/tests/cat/pending_tasks.yaml b/tests/cat/pending_tasks.yaml
@@ -0,0 +1,11 @@
+$schema: ../../json_schemas/test_story.schema.yaml
+
+description: Test cat/pending_tasks endpoints.
+chapters:
+  - synopsis: Cat with a json response.
+    path: /_cat/pending_tasks
+    method: GET
+    parameters:
+      format: json
+    response:
+      status: 200