Backport missing 9 (#3706)

* [DOCS] Fix overlay for resolve cluster (#3670) * Update specification output * uppercase enum source mode (#3676) * [DOCS] Add overlays for CCR API examples (#3672) * Update inference.update.json with the correct verb (#3688) * Update specification output * [DOCS] Convert final examples from JSON to YAML (#3692) * Update specification output * Correcting the response format for ingest simulate (#3640) * Correcting the response format for ingest simulate * code review feedback * moving error to the correct place, and adding ignored_fields * Update specification/simulate/ingest/SimulateIngestResponse.ts Co-authored-by: Laura Trotta <[email protected]> --------- Co-authored-by: Laura Trotta <[email protected]> * Update specification output * Add text_embedding_bits to inference result output (#3698) * Update specification output * Improve `Analyzer` definitions and fix various classes (#3215) * Update specification output --------- Co-authored-by: Lisa Cawley <[email protected]> Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: Laura Trotta <[email protected]> Co-authored-by: David Kyle <[email protected]> Co-authored-by: Keith Massey <[email protected]> Co-authored-by: Ying Mao <[email protected]>
elastic · Feb 6, 2025 · 318b62b · 318b62b
1 parent 6e0d406
commit 318b62b
Show file tree

Hide file tree

Showing 75 changed files with 1,081 additions and 438 deletions.
diff --git a/docs/overlays/elasticsearch-openapi-overlays.yaml b/docs/overlays/elasticsearch-openapi-overlays.yaml
@@ -199,6 +199,96 @@ actions:
               examples:
                 resumeFollowIndexResponseExample1:
                   $ref: "../../specification/ccr/resume_follow/examples/response/ResumeFollowIndexResponseExample1.yaml"
+  - target: "$.paths['/{index}/_ccr/unfollow']['post']"
+    description: "Add examples for unfollow an index"
+    update: 
+      responses:
+        200:
+          content:
+            application/json:
+              examples:
+                ccrUnfollowIndexResponseExample1:
+                  $ref: "../../specification/ccr/unfollow/examples/response/UnfollowIndexResponseExample1.yaml"
+  - target: "$.paths['/_ccr/stats']['get']"
+    description: "Add examples for get ccr stats"
+    update: 
+      responses:
+        200:
+          content:
+            application/json:
+              examples:
+                ccrStatsResponseExample1:
+                  $ref: "../../specification/ccr/stats/examples/response/CcrStatsResponseExample1.yaml"
+  - target: "$.paths['/_ccr/auto_follow/{name}/resume']['post']"
+    description: "Add examples for resume auto-follow pattern"
+    update: 
+      responses:
+        200:
+          content:
+            application/json:
+              examples:
+                ccrResumeAutoFollowResponseExample1:
+                  $ref: "../../specification/ccr/resume_auto_follow_pattern/examples/response/ResumeAutoFollowPatternResponseExample1.yaml"
+  - target: "$.paths['/{index}/_ccr/pause_follow']['post']"
+    description: "Add examples for resume auto-follow pattern"
+    update: 
+      responses:
+        200:
+          content:
+            application/json:
+              examples:
+                ccrPauseFollowResponseExample1:
+                  $ref: "../../specification/ccr/pause_follow/examples/response/PauseFollowIndexResponseExample1.yaml"
+  - target: "$.paths['/_ccr/auto_follow/{name}/pause']['post']"
+    description: "Add examples for pause auto-follow pattern"
+    update: 
+      responses:
+        200:
+          content:
+            application/json:
+              examples:
+                ccrPauseAutoFollowPatternResponseExample1:
+                  $ref: "../../specification/ccr/pause_auto_follow_pattern/examples/response/PauseAutoFollowPatternResponseExample1.yaml"
+  - target: "$.components['responses']['ccr.get_auto_follow_pattern#200']"
+    description: "Add examples for get auto-follow pattern"
+    update: 
+      content:
+        application/json:
+          examples:
+            ccrPauseAutoFollowPatternResponseExample1:
+              $ref: "../../specification/ccr/get_auto_follow_pattern/examples/response/GetAutoFollowPatternResponseExample1.yaml"
+  - target: "$.paths['/{index}/_ccr/stats']['get']"
+    description: "Add examples for get follower stats"
+    update: 
+      responses:
+        200:
+          content:
+            application/json:
+              examples:
+                ccrFollowerStatsResponseExample1:
+                  $ref: "../../specification/ccr/follow_stats/examples/response/FollowIndexStatsResponseExample1.yaml"
+  - target: "$.paths['/{index}/_ccr/info']['get']"
+    description: "Add examples for get follower info"
+    update: 
+      responses:
+        200:
+          content:
+            application/json:
+              examples:
+                ccrFollowerInfoResponseExample1:
+                  $ref: "../../specification/ccr/follow_info/examples/response/FollowInfoResponseExample1.yaml"
+                ccrFollowerInfoResponseExample2:
+                  $ref: "../../specification/ccr/follow_info/examples/response/FollowInfoResponseExample2.yaml"
+  - target: "$.paths['/_ccr/auto_follow/{name}']['delete']"
+    description: "Add examples for delete auto follow pattern"
+    update: 
+      responses:
+        200:
+          content:
+            application/json:
+              examples:
+                ccrAutoFollowPatternDeleteResponseExample1:
+                  $ref: "../../specification/ccr/delete_auto_follow_pattern/examples/response/DeleteAutoFollowPatternResponseExample1.yaml"
 ## Examples for cluster
   - target: "$.components['requestBodies']['cluster.allocation_explain']"
     description: "Add examples for cluster allocation explain operation"
@@ -493,16 +583,16 @@ actions:
           examples:
             getIndicesRecoveryResponseExample1:
                   $ref: "../../specification/indices/recovery/examples/200_response/indicesRecoveryResponseExample1.yaml"
-  - target: "$.paths['/_resolve/cluster/{name}']['get']"
+  - target: "$.components['responses']['indices.resolve_cluster#200']"
     description: "Add examples for resolve cluster operation"
     update: 
-      responses:
-        200:
-          content:
-            application/json:
-              examples:
-                resolveClusterResponseExample1:
-                  $ref: "../../specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample1.yaml"
+      content:
+        application/json:
+          examples:
+            resolveClusterResponseExample1:
+              $ref: "../../specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample1.yaml"
+            resolveClusterResponseExample2:
+              $ref: "../../specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample2.yaml"
   - target: "$.components['requestBodies']['indices.shrink']"
     description: "Add example for shrink index request"
     update: 

diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml
@@ -2463,6 +2463,30 @@ actions:
           examples:
             asyncSearchSubmitResponseExample1:
               $ref: "../../specification/async_search/submit/examples/response/AsyncSearchSubmitResponseExample1.yaml"
+  - target: "$.paths['/_async_search/status/{id}']['get']"
+    description: "Add examples for get async search status"
+    update: 
+      responses:
+        200:
+          content:
+            application/json:
+              examples:
+                asyncSearchStatusResponseExample1:
+                  $ref: "../../specification/async_search/status/examples/response/AsyncSearchStatusResponseExample1.yaml"
+                asyncSearchStatusResponseExample2:
+                  $ref: "../../specification/async_search/status/examples/response/AsyncSearchStatusResponseExample2.yaml"
+                asyncSearchStatusResponseExample3:
+                  $ref: "../../specification/async_search/status/examples/response/AsyncSearchStatusResponseExample3.yaml"
+  - target: "$.paths['/_async_search/{id}']['get']"
+    description: "Add examples for get async search"
+    update: 
+      responses:
+        200:
+          content:
+            application/json:
+              examples:
+                asyncSearchResponseExample1:
+                  $ref: "../../specification/async_search/get/examples/response/AsyncSearchGetResponseExample1.yaml"
 ## Examples for search applications
   - target: "$.paths['/_application/search_application']['get']"
     description: "Add examples for get search applications operation"