Restructure reference docs directory

2024-12-02 16:58:55 -06:00
parent 647dac8069
commit c3e7619621
583 changed files with 1186 additions and 1305 deletions
--- a/docs/reference/get.asciidoc
+++ b/docs/reference/get.asciidoc
@ -0,0 +1,83 @@
+[[reference-get]]
+
+////////
+===========================================================================================================================
+||                                                                                                                       ||
+||                                                                                                                       ||
+||                                                                                                                       ||
+||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
+||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
+||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
+||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
+||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
+||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
+||                                                                                                                       ||
+||                                                                                                                       ||
+||    This file is autogenerated, DO NOT send pull requests that changes this file directly.                             ||
+||    You should update the script that does the generation, which can be found in:                                      ||
+||    https://github.com/elastic/elastic-client-generator-js                                                             ||
+||                                                                                                                       ||
+||    You can run the script with the following command:                                                                 ||
+||       npm run elasticsearch -- --version <version>                                                                    ||
+||                                                                                                                       ||
+||                                                                                                                       ||
+||                                                                                                                       ||
+===========================================================================================================================
+////////
+
+[discrete]
+[[client.get]]
+=== client.get
+
+Get a document by its ID. Retrieves the document with the specified ID from an index.
+
+{ref}/docs-get.html[{es} documentation]
+
+[discrete]
+==== Function signature
+
+[source,ts]
+----
+(GetRequest, options?): Promise<GetResponse>
+----
+
+[discrete]
+==== Request
+
+[pass]
++++
+<pre>
++++
+interface GetRequest extends <<RequestBase>> {
+  id: <<Id>>
+  index: <<IndexName>>
+  force_synthetic_source?: boolean
+  preference?: string
+  realtime?: boolean
+  refresh?: boolean
+  routing?: <<Routing>>
+  _source?: <<SearchSourceConfigParam>>
+  _source_excludes?: <<Fields>>
+  _source_includes?: <<Fields>>
+  stored_fields?: <<Fields>>
+  version?: <<VersionNumber>>
+  version_type?: <<VersionType>>
+}
+
+[pass]
++++
+</pre>
++++
+[discrete]
+==== Response
+
+[pass]
++++
+<pre>
++++
+type GetResponse<TDocument = unknown> = <<GetGetResult>><TDocument>
+
+[pass]
++++
+</pre>
++++