habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Restructure reference docs directory

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

71
docs/reference/cat-templates.asciidoc Normal file
View File

@ -0,0 +1,71 @@
[[reference-cat-templates]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.cat.templates]]
=== client.cat.templates
Returns information about index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.
{ref}/cat-templates.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(CatTemplatesRequest, options?): Promise<CatTemplatesResponse>
----
[discrete]
==== Request
[pass]
++++
<pre>
++++
interface CatTemplatesRequest extends <<CatCatRequestBase>> {
name?: <<Name>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
[pass]
++++
<pre>
++++
type CatTemplatesResponse = CatTemplatesTemplatesRecord[]
[pass]
++++
</pre>
++++