Merge branch 'main' into fix-simulate-ingest-spec

masseyke · web-flow · commit 43e6fa1f7466 · 2025-01-29T08:20:44.000-06:00
diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml
@@ -2169,3 +2169,13 @@ actions:
               examples:
                 updateTransformResponseExample1:
                   $ref: "../../specification/transform/update_transform/examples/response/UpdateTransformResponseExample1.yaml"
+## xCodeSamples
+  - target: "$.paths['/{index}/_doc/{id}']['head']"
+    description: "Add xCodeSamples for check document operation"
+    update: 
+      x-codeSamples:
+        - $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsConsoleExample1.yaml"
+        - $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsCurlExample1.yaml"
+        - $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsJavaScriptExample1.yaml"
+        - $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsPythonExample1.yaml"
+        - $ref: "../../specification/_global/exists/examples/xCodeSamples/DocumentExistsRubyExample1.yaml"
diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json
diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json
diff --git a/output/schema/schema-serverless.json b/output/schema/schema-serverless.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git a/output/typescript/types.ts b/output/typescript/types.ts
diff --git a/specification/_global/exists/examples/xCodeSamples/DocumentExistsConsoleExample1.yaml b/specification/_global/exists/examples/xCodeSamples/DocumentExistsConsoleExample1.yaml
@@ -0,0 +1,4 @@
+lang: Console
+# label:
+source: |
+  HEAD my-index-000001/_doc/0
diff --git a/specification/_global/exists/examples/xCodeSamples/DocumentExistsCurlExample1.yaml b/specification/_global/exists/examples/xCodeSamples/DocumentExistsCurlExample1.yaml
@@ -0,0 +1,4 @@
+lang: Curl
+# label:
+source: |
+  curl -I "localhost:9200/my-index-000001/_doc/0?pretty"
diff --git a/specification/_global/exists/examples/xCodeSamples/DocumentExistsJavaScriptExample1.yaml b/specification/_global/exists/examples/xCodeSamples/DocumentExistsJavaScriptExample1.yaml
@@ -0,0 +1,8 @@
+lang: JavaScript
+# label:
+source: |
+  const response = await client.exists({
+    index: "my-index-000001",
+    id: 0,
+  });
+  console.log(response);
diff --git a/specification/_global/exists/examples/xCodeSamples/DocumentExistsPythonExample1.yaml b/specification/_global/exists/examples/xCodeSamples/DocumentExistsPythonExample1.yaml
@@ -0,0 +1,8 @@
+lang: Python
+# label:
+source: |
+  resp = client.exists(
+    index="my-index-000001",
+    id="0",
+  )
+  print(resp)
diff --git a/specification/_global/exists/examples/xCodeSamples/DocumentExistsRubyExample1.yaml b/specification/_global/exists/examples/xCodeSamples/DocumentExistsRubyExample1.yaml
@@ -0,0 +1,8 @@
+lang: Ruby
+# label:
+source: |
+  response = client.exists(
+    index: 'my-index-000001',
+    id: 0
+  )
+  puts response
diff --git a/specification/_types/Binary.ts b/specification/_types/Binary.ts
@@ -20,8 +20,8 @@
 // Vector tile response
 export type MapboxVectorTiles = ArrayBuffer
 
-// ES|QL columns
-export type EsqlColumns = ArrayBuffer
+// ES|QL generic response
+export type EsqlResult = ArrayBuffer
 
 // Streaming endpoints response
 export type StreamResult = ArrayBuffer
diff --git a/specification/esql/async_query/AsyncQueryResponse.ts b/specification/esql/async_query/AsyncQueryResponse.ts
@@ -17,24 +17,8 @@
  * under the License.
  */
 
-import { EsqlColumns } from '@_types/Binary'
+import { EsqlResult } from '@_types/Binary'
 
 export class Response {
-  body: {
-    columns?: EsqlColumns
-    /**
-     * A query identifier that is provided only when one of the following conditions is met:
-     *
-     * * A query request does not return complete results during the period specified in the `wait_for_completion_timeout` parameter.
-     * * The `keep_on_completion` parameter value is true.
-     *
-     * You can use this ID with the `GET /_query/async/<id>` API to get the current status and available results for the query.
-     */
-    id?: string
-    /**
-     * Indicates whether the query is still running.
-     * If the value is false, the async query has finished and the results are returned.
-     */
-    is_running: boolean
-  }
+  body: EsqlResult
 }
diff --git a/specification/esql/async_query_get/AsyncQueryGetResponse.ts b/specification/esql/async_query_get/AsyncQueryGetResponse.ts
@@ -17,15 +17,8 @@
  * under the License.
  */
 
-import { EsqlColumns } from '@_types/Binary'
+import { EsqlResult } from '@_types/Binary'
 
 export class Response {
-  body: {
-    columns?: EsqlColumns
-    /**
-     * Indicates whether the query is still running.
-     * If the value is false, the async query has finished and the results are returned.
-     */
-    is_running: boolean
-  }
+  body: EsqlResult
 }
diff --git a/specification/esql/query/QueryResponse.ts b/specification/esql/query/QueryResponse.ts
@@ -17,9 +17,9 @@
  * under the License.
  */
 
-import { EsqlColumns } from '@_types/Binary'
+import { EsqlResult } from '@_types/Binary'
 
 export class Response {
   /** @codegen_name data */
-  body: EsqlColumns
+  body: EsqlResult
 }
