Adding get random sample API

Author: masseyke

specification/indices/get_sample/GetRandomSamplesRequest.ts

@@ -0,0 +1,43 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { RequestBase } from '@_types/Base'
+
+/**
+ * Request for a random sample of raw documents ingested into the given index or data stream.
+ *
+ * @rest_spec_name indices.get_sample
+ * @availability stack since=9.3.0 stability=experimental
+ * @doc_id random_sample
+ * @doc_tag random_sample
+ */
+export interface Request extends RequestBase {
+  urls: [
+    {
+      path: '{index}/_data_stream'
+      methods: ['GET']
+    }
+  ]
+  path_parts: {
+    /**
+     * Single index or data stream name. Wildcards are not supported.
+     */
+    index: string
+  }
+}

specification/indices/get_sample/GetRandomSamplesResponse.ts

@@ -0,0 +1,28 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { RawDocument } from './_types/RawDocument'
+
+/**
+ * Response type for the get_random_samples API.
+ * It reuses the standard SearchResponse structure.
+ */
+export class Response {
+  body: { sample: RawDocument[] }
+}

specification/indices/get_sample/_types/RawDocument.ts

@@ -0,0 +1,35 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { Indices } from '@_types/common'
+
+export class RawDocument {
+  /**
+   * Name of the index for this raw document.
+   */
+  index: string
+  /**
+   * The original raw source.
+   */
+  source: Index
+}
+
+export class Index {
+  index: Indices
+}

specification/indices/get_sample/examples/200_response/GetRandomSampleResponse1.yaml

@@ -0,0 +1,35 @@
+# summary: ''
+description: A successful response for retrieving the random sample for an index or data stream.
+# type: response
+# response_code: 200
+value: |-
+  {
+    "sample": [
+      {
+        "index": "logs",
+        "source": {
+          "@timestamp": "2099-11-15T13:12:00",
+          "message": "Node 0 message",
+          "user": {
+            "id": "kimchy"
+          },
+          "network": {
+            "name": "Guest"
+          }
+        }
+      },
+      {
+        "index": "logs",
+        "source": {
+          "@timestamp": "2079-11-15T13:12:00",
+          "message": "Node 1 message",
+          "user": {
+            "id": "kimchy"
+          },
+          "network": {
+            "name": "Guest"
+          }
+        }
+      }
+    ]
+  }

specification/indices/get_sample/examples/request/GetRandomSampleRequest1.yaml

@@ -0,0 +1 @@
+method_request: GET /my-index-000001/_sample