Add cat response examples (#3419)

Author: lcawl

docs/overlays/elasticsearch-shared-overlays.yaml

@@ -1360,6 +1360,293 @@ actions:
           examples:
             getBehavioralAnalyticsCollectionsResponseExample1:
               $ref: "../../specification/search_application/get_behavioral_analytics/examples/200_response/BehavioralAnalyticsGetResponseExample1.yaml"
+## Examples for cat
+  - target: "$.components['responses']['cat.aliases#200']"
+    description: "Add example for cat aliases response"
+    update: 
+      content:
+        text/plain:
+          schema:
+            type: string
+          examples:
+            catAliasesResponseExample1:
+              $ref: "../../specification/cat/aliases/examples/200_response/CatAliasesResponseExample1.yaml"
+  - target: "$.components['responses']['cat.allocation#200']"
+    description: "Add example for cat allocation response"
+    update: 
+      content:
+        text/plain:
+          schema:
+            type: string
+          examples:
+            catAllocationResponseExample1:
+              $ref: "../../specification/cat/allocation/examples/200_response/CatAllocationResponseExample1.yaml"
+  - target: "$.components['responses']['cat.component_templates#200']"
+    description: "Add example for cat component templates response"
+    update: 
+      content:
+        text/plain:
+          schema:
+            type: string
+          examples:
+            catComponentTemplatesResponseExample1:
+              $ref: "../../specification/cat/component_templates/examples/200_response/CatComponentTemplatesResponseExample1.yaml"
+  - target: "$.components['responses']['cat.count#200']"
+    description: "Add example for cat count response"
+    update: 
+      content:
+        text/plain:
+          schema:
+            type: string
+          examples:
+            catCountResponseExample1:
+              $ref: "../../specification/cat/count/examples/200_response/CatCountResponseExample1.yaml"
+            catCountResponseExample2:
+              $ref: "../../specification/cat/count/examples/200_response/CatCountResponseExample2.yaml" 
+  - target: "$.components['responses']['cat.fielddata#200']"
+    description: "Add example for cat fielddata response"
+    update: 
+      content:
+        text/plain:
+          schema:
+            type: string
+          examples:
+            catFieldDataResponseExample1:
+              $ref: "../../specification/cat/fielddata/examples/200_response/CatFielddataResponseExample1.yaml"
+            catFieldDataResponseExample2:
+              $ref: "../../specification/cat/fielddata/examples/200_response/CatFielddataResponseExample2.yaml" 
+  - target: "$.components['responses']['cat.indices#200']"
+    description: "Add example for cat indices response"
+    update: 
+      content:
+        text/plain:
+          schema:
+            type: string
+          examples:
+            catIndicesResponseExample1:
+              $ref: "../../specification/cat/indices/examples/200_response/CatIndicesResponseExample1.yaml" 
+  - target: "$.components['responses']['cat.ml_datafeeds#200']"
+    description: "Add example for cat datafeeds response"
+    update: 
+      content:
+        text/plain:
+          schema:
+            type: string
+          examples:
+            catDatafeedsResponseExample1:
+              $ref: "../../specification/cat/ml_datafeeds/examples/200_response/CatDatafeedsResponseExample1.yaml"
+  - target: "$.components['responses']['cat.ml_data_frame_analytics#200']"
+    description: "Add example for cat data frame analytics response"
+    update: 
+      content:
+        text/plain:
+          schema:
+            type: string
+          examples:
+            catDataFrameAnalyticsResponseExample1:
+              $ref: "../../specification/cat/ml_data_frame_analytics/examples/200_response/CatDataFrameAnalyticsResponseExample1.yaml" 
+  - target: "$.components['responses']['cat.ml_jobs#200']"
+    description: "Add example for cat anomaly detectors response"
+    update: 
+      content:
+        text/plain:
+          schema:
+            type: string
+          examples:
+            catAnomalyDetectorsResponseExample1:
+              $ref: "../../specification/cat/ml_jobs/examples/200_response/CatJobsResponseExample1.yaml"
+  - target: "$.components['responses']['cat.ml_trained_models#200']"
+    description: "Add example for cat trained models response"
+    update: 
+      content:
+        text/plain:
+          schema:
+            type: string
+          examples:
+            catTrainedModelsResponseExample1:
+              $ref: "../../specification/cat/ml_trained_models/examples/200_response/CatTrainedModelsResponseExample1.yaml"
+  - target: "$.components['responses']['cat.recovery#200']"
+    description: "Add example for cat recovery response"
+    update: 
+      content:
+        text/plain:
+          schema:
+            type: string
+          examples:
+            catRecoveryResponseExample1:
+              $ref: "../../specification/cat/recovery/examples/200_response/CatRecoveryResponseExample1.yaml"
+            catRecoveryResponseExample2:
+              $ref: "../../specification/cat/recovery/examples/200_response/CatRecoveryResponseExample2.yaml"
+            catRecoveryResponseExample3:
+              $ref: "../../specification/cat/recovery/examples/200_response/CatRecoveryResponseExample3.yaml"
+  - target: "$.components['responses']['cat.segments#200']"
+    description: "Add example for cat segments response"
+    update: 
+      content:
+        text/plain:
+          schema:
+            type: string
+          examples:
+            catSegmentsResponseExample1:
+              $ref: "../../specification/cat/segments/examples/200_response/CatSegmentsResponseExample1.yaml"
+  - target: "$.components['responses']['cat.shards#200']"
+    description: "Add example for cat shards response"
+    update: 
+      content:
+        text/plain:
+          schema:
+            type: string
+          examples:
+            catShardsResponseExample1:
+              $ref: "../../specification/cat/shards/examples/200_response/CatShardsResponseExample1.yaml"
+            catShardsResponseExample2:
+              $ref: "../../specification/cat/shards/examples/200_response/CatShardsResponseExample2.yaml"
+            catShardsResponseExample3:
+              $ref: "../../specification/cat/shards/examples/200_response/CatShardsResponseExample3.yaml"
+            catShardsResponseExample4:
+              $ref: "../../specification/cat/shards/examples/200_response/CatShardsResponseExample4.yaml"
+            catShardsResponseExample5:
+              $ref: "../../specification/cat/shards/examples/200_response/CatShardsResponseExample5.yaml"
+  - target: "$.components['responses']['cat.snapshots#200']"
+    description: "Add example for cat snapshot response"
+    update: 
+      content:
+        text/plain:
+          schema:
+            type: string
+          examples:
+            catSnapshotsResponseExample1:
+              $ref: "../../specification/cat/snapshots/examples/200_response/CatSnapshotsResponseExample1.yaml"
+  - target: "$.components['responses']['cat.templates#200']"
+    description: "Add example for cat templates response"
+    update: 
+      content:
+        text/plain:
+          schema:
+            type: string
+          examples:
+            catTemplatesResponseExample1:
+              $ref: "../../specification/cat/templates/examples/200_response/CatTemplatesResponseExample1.yaml"
+  - target: "$.components['responses']['cat.thread_pool#200']"
+    description: "Add example for cat thread pool response"
+    update: 
+      content:
+        text/plain:
+          schema:
+            type: string
+          examples:
+            catThreadPoolResponseExample1:
+              $ref: "../../specification/cat/thread_pool/examples/200_response/CatThreadPoolResponseExample1.yaml"
+            catThreadPoolResponseExample2:
+              $ref: "../../specification/cat/thread_pool/examples/200_response/CatThreadPoolResponseExample2.yaml"
+  - target: "$.components['responses']['cat.transforms#200']"
+    description: "Add example for cat transforms response"
+    update: 
+      content:
+        application/json:
+          examples:
+            catTransformsResponseExample1:
+              $ref: "../../specification/cat/transforms/examples/200_response/CatTransformsResponseExample1.yaml"
+  - target: "$.paths['/_cat/health']['get']"
+    description: "Add examples for cat health operation"
+    update: 
+      responses:
+        200: 
+          content:
+            text/plain:
+              schema:
+                type: string
+              examples:
+                catMasterResponseExample1: 
+                  $ref: "../../specification/cat/health/examples/200_response/CatHealthResponseExample1.yaml"
+  - target: "$.paths['/_cat/master']['get']"
+    description: "Add examples for cat master operation"
+    update: 
+      responses:
+        200: 
+          content:
+            text/plain:
+              schema:
+                type: string
+              examples:
+                catMasterResponseExample1: 
+                  $ref: "../../specification/cat/master/examples/200_response/CatMasterResponseExample1.yaml"
+  - target: "$.paths['/_cat/nodeattrs']['get']"
+    description: "Add examples for cat node attributes operation"
+    update: 
+      responses:
+        200: 
+          content:
+            text/plain:
+              schema:
+                type: string
+              examples:
+                catNodeAttributesResponseExample1: 
+                  $ref: "../../specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample1.yaml"
+                catNodeAttributesResponseExample2: 
+                  $ref: "../../specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample2.yaml"
+  - target: "$.paths['/_cat/nodes']['get']"
+    description: "Add examples for cat nodes operation"
+    update: 
+      responses:
+        200: 
+          content:
+            text/plain:
+              schema:
+                type: string
+              examples:
+                catNodesResponseExample1: 
+                  $ref: "../../specification/cat/nodes/examples/200_response/CatNodesResponseExample1.yaml"
+                catNodesResponseExample2: 
+                  $ref: "../../specification/cat/nodes/examples/200_response/CatNodesResponseExample2.yaml"
+  - target: "$.paths['/_cat/pending_tasks']['get']"
+    description: "Add examples for cat pending tasks operation"
+    update: 
+      responses:
+        200: 
+          content:
+            text/plain:
+              schema:
+                type: string
+              examples:
+                catPendingTasksResponseExample1: 
+                  $ref: "../../specification/cat/pending_tasks/examples/200_response/CatPendingTasksResponseExample1.yaml"
+  - target: "$.paths['/_cat/plugins']['get']"
+    description: "Add examples for cat plugins operation"
+    update: 
+      responses:
+        200: 
+          content:
+            text/plain:
+              schema:
+                type: string
+              examples:
+                catPluginsResponseExample1: 
+                  $ref: "../../specification/cat/plugins/examples/200_response/CatPluginsResponseExample1.yaml"
+  - target: "$.paths['/_cat/repositories']['get']"
+    description: "Add examples for cat repositories operation"
+    update: 
+      responses:
+        200: 
+          content:
+            text/plain:
+              schema:
+                type: string
+              examples:
+                catRepositoriesResponseExample1: 
+                  $ref: "../../specification/cat/repositories/examples/200_response/CatRepositoriesResponseExample1.yaml"
+  - target: "$.paths['/_cat/tasks']['get']"
+    description: "Add examples for cat tasks operation"
+    update: 
+      responses:
+        200: 
+          content:
+            text/plain:
+              schema:
+                type: string
+              examples:
+                catTasksResponseExample1: 
+                  $ref: "../../specification/cat/tasks/examples/200_response/CatTasksResponseExample1.yaml"
 ## Examples for licensing
   - target: "$.paths['/_license']['get']"
     description: "Add example for get license response"
@@ -1408,4 +1695,4 @@ actions:
         application/json:
           examples:
             searchApplicationSearchRequestExample1:
-              $ref: "../../specification/search_application/search/examples/request/SearchApplicationsSearchRequestExample1.yaml"
+              $ref: "../../specification/search_application/search/examples/request/SearchApplicationsSearchRequestExample1.yaml"