From ac9c431ec04149d9048f2b8f9731e3c2f7f38754 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
 <41898282+github-actions[bot]@users.noreply.github.com>
Date: Thu, 12 Oct 2023 09:05:15 +0200
Subject: [PATCH] additional counters in _clusters response (#2301) (#2311)

Updates the spec for the response objects for `POST _async_search`,
`GET _async_search/:id`, `GET _async_search/status/:id` and `GET _search`.

In `8.11` we are adding counters in the `_details` section of both async and
synchronous search responses. The counters added are: `running`, `partial`
and `failed`. https://github.com/elastic/elasticsearch/pull/99566

(cherry picked from commit 0f7969a4e10ecb4423057d4ad29744c4a7c3c67b)

Co-authored-by: Matteo Piergiovanni <134913285+piergm@users.noreply.github.com>
---
 output/schema/schema.json     | 81 ++++++++++++++++++++++++-----------
 output/typescript/types.ts    |  3 ++
 specification/_types/Stats.ts |  3 ++
 3 files changed, 63 insertions(+), 24 deletions(-)

diff --git a/output/schema/schema.json b/output/schema/schema.json
index 285f7e96dd..e76480f932 100644
--- a/output/schema/schema.json
+++ b/output/schema/schema.json
@@ -40159,7 +40159,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L65-L75"
+      "specLocation": "_types/Stats.ts#L68-L78"
     },
     {
       "docId": "byte-units",
@@ -40340,7 +40340,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L42-L49"
+      "specLocation": "_types/Stats.ts#L45-L52"
     },
     {
       "kind": "enum",
@@ -40420,7 +40420,7 @@
         "name": "ClusterSearchStatus",
         "namespace": "_types"
       },
-      "specLocation": "_types/Stats.ts#L34-L40"
+      "specLocation": "_types/Stats.ts#L37-L43"
     },
     {
       "kind": "interface",
@@ -40462,6 +40462,39 @@
             }
           }
         },
+        {
+          "name": "running",
+          "required": true,
+          "type": {
+            "kind": "instance_of",
+            "type": {
+              "name": "integer",
+              "namespace": "_types"
+            }
+          }
+        },
+        {
+          "name": "partial",
+          "required": true,
+          "type": {
+            "kind": "instance_of",
+            "type": {
+              "name": "integer",
+              "namespace": "_types"
+            }
+          }
+        },
+        {
+          "name": "failed",
+          "required": true,
+          "type": {
+            "kind": "instance_of",
+            "type": {
+              "name": "integer",
+              "namespace": "_types"
+            }
+          }
+        },
         {
           "name": "details",
           "required": false,
@@ -40485,7 +40518,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L27-L32"
+      "specLocation": "_types/Stats.ts#L27-L35"
     },
     {
       "kind": "interface",
@@ -40541,7 +40574,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L77-L87"
+      "specLocation": "_types/Stats.ts#L80-L90"
     },
     {
       "kind": "enum",
@@ -40893,7 +40926,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L94-L106"
+      "specLocation": "_types/Stats.ts#L97-L109"
     },
     {
       "description": "A duration. Units can be `nanos`, `micros`, `ms` (milliseconds), `s` (seconds), `m` (minutes), `h` (hours) and\n`d` (days). Also accepts \"0\" without a unit and \"-1\" to indicate an unspecified value.",
@@ -41351,7 +41384,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L115-L118"
+      "specLocation": "_types/Stats.ts#L118-L121"
     },
     {
       "kind": "interface",
@@ -41383,7 +41416,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L89-L92"
+      "specLocation": "_types/Stats.ts#L92-L95"
     },
     {
       "kind": "interface",
@@ -41618,7 +41651,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L108-L113"
+      "specLocation": "_types/Stats.ts#L111-L116"
     },
     {
       "kind": "type_alias",
@@ -41711,7 +41744,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L120-L125"
+      "specLocation": "_types/Stats.ts#L123-L128"
     },
     {
       "docId": "fuzziness",
@@ -42305,7 +42338,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L127-L138"
+      "specLocation": "_types/Stats.ts#L130-L141"
     },
     {
       "kind": "enum",
@@ -42745,7 +42778,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L140-L156"
+      "specLocation": "_types/Stats.ts#L143-L159"
     },
     {
       "kind": "type_alias",
@@ -43475,7 +43508,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L158-L175"
+      "specLocation": "_types/Stats.ts#L161-L178"
     },
     {
       "kind": "type_alias",
@@ -44358,7 +44391,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L177-L187"
+      "specLocation": "_types/Stats.ts#L180-L190"
     },
     {
       "kind": "type_alias",
@@ -44479,7 +44512,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L189-L223"
+      "specLocation": "_types/Stats.ts#L192-L226"
     },
     {
       "kind": "type_alias",
@@ -44618,7 +44651,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L225-L230"
+      "specLocation": "_types/Stats.ts#L228-L233"
     },
     {
       "esQuirk": "This is a boolean that evolved into an enum. ES also accepts plain booleans for true and false.",
@@ -44732,7 +44765,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L232-L239"
+      "specLocation": "_types/Stats.ts#L235-L242"
     },
     {
       "kind": "type_alias",
@@ -44853,7 +44886,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L241-L247"
+      "specLocation": "_types/Stats.ts#L244-L250"
     },
     {
       "kind": "enum",
@@ -45552,7 +45585,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L249-L268"
+      "specLocation": "_types/Stats.ts#L252-L271"
     },
     {
       "kind": "interface",
@@ -45909,7 +45942,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L270-L363"
+      "specLocation": "_types/Stats.ts#L273-L366"
     },
     {
       "kind": "type_alias",
@@ -46074,7 +46107,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L51-L63"
+      "specLocation": "_types/Stats.ts#L54-L66"
     },
     {
       "kind": "interface",
@@ -46474,7 +46507,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L365-L392"
+      "specLocation": "_types/Stats.ts#L368-L395"
     },
     {
       "kind": "interface",
@@ -47003,7 +47036,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L394-L402"
+      "specLocation": "_types/Stats.ts#L397-L405"
     },
     {
       "kind": "type_alias",
@@ -47305,7 +47338,7 @@
           }
         }
       ],
-      "specLocation": "_types/Stats.ts#L404-L409"
+      "specLocation": "_types/Stats.ts#L407-L412"
     },
     {
       "kind": "interface",
diff --git a/output/typescript/types.ts b/output/typescript/types.ts
index 40a1a0717b..f3ec2ba03a 100644
--- a/output/typescript/types.ts
+++ b/output/typescript/types.ts
@@ -2076,6 +2076,9 @@ export interface ClusterStatistics {
   skipped: integer
   successful: integer
   total: integer
+  running: integer
+  partial: integer
+  failed: integer
   details?: Record<ClusterAlias, ClusterDetails>
 }
 
diff --git a/specification/_types/Stats.ts b/specification/_types/Stats.ts
index c6bad2c0cd..143edc2a2f 100644
--- a/specification/_types/Stats.ts
+++ b/specification/_types/Stats.ts
@@ -28,6 +28,9 @@ export class ClusterStatistics {
   skipped: integer
   successful: integer
   total: integer
+  running: integer
+  partial: integer
+  failed: integer
   details?: Dictionary<ClusterAlias, ClusterDetails>
 }