Restructure reference docs directory

This commit is contained in:
Josh Mock
2024-12-02 16:58:55 -06:00
parent 647dac8069
commit c3e7619621
583 changed files with 1186 additions and 1305 deletions

View File

@ -14,7 +14,8 @@ include::integrations.asciidoc[]
include::observability.asciidoc[]
include::transport.asciidoc[]
include::typescript.asciidoc[]
include::reference-main-index.asciidoc[]
include::reference.asciidoc[]
include::reference/index.asciidoc[]
include::examples/index.asciidoc[]
include::helpers.asciidoc[]
include::timeout-best-practices.asciidoc[]

View File

@ -1,84 +0,0 @@
[[reference-index]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.index]]
=== client.index
Index a document. Adds a JSON document to the specified data stream or index and makes it searchable. If the target is an index and the document already exists, the request updates the document and increments its version.
{ref}/docs-index_.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(IndexRequest, options?): Promise<IndexResponse>
----
[discrete]
==== Request
[pass]
++++
<pre>
++++
interface IndexRequest<TDocument = unknown> extends <<RequestBase>> {
id?: <<Id>>
index: <<IndexName>>
if_primary_term?: <<long>>
if_seq_no?: <<SequenceNumber>>
op_type?: <<OpType>>
pipeline?: string
refresh?: <<Refresh>>
routing?: <<Routing>>
timeout?: <<Duration>>
version?: <<VersionNumber>>
version_type?: <<VersionType>>
wait_for_active_shards?: <<WaitForActiveShards>>
require_alias?: boolean
document?: TDocument
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
[pass]
++++
<pre>
++++
type IndexResponse = <<WriteResponseBase>>
[pass]
++++
</pre>
++++

File diff suppressed because it is too large Load Diff

Some files were not shown because too many files have changed in this diff Show More