Add x-codeSamples to check document API (#3594)

(cherry picked from commit fcd7150)
elastic · Jan 30, 2025 · ec57e47 · ec57e47
1 parent fac42ef
commit ec57e47
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 0 deletions.
diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml
@@ -2381,3 +2381,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/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