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

Test run of new docs

Browse Source
This commit is contained in:
Josh Mock
2024-11-19 11:04:35 -06:00
parent f33aa8cccd
commit 8210607de0
503 changed files with 37166 additions and 12056 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
docs/reference-indices-get.asciidoc Normal file
View File

@ -0,0 +1,68 @@
[[reference-indices-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.indices.get
Get index information. Returns information about one or more indices. For data streams, the API returns information about the stream’s backing indices.
{ref}/indices-get-index.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(IndicesGetRequest, options?): Promise<IndicesGetResponse>
----
[discrete]
===== `IndicesGetRequest`
[source,ts]
----
interface IndicesGetRequest extends <<shared-type-request-base, RequestBase>> {
index: <<shared-type-indices, Indices>>
allow_no_indices?: boolean
expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
flat_settings?: boolean
ignore_unavailable?: boolean
include_defaults?: boolean
local?: boolean
master_timeout?: <<shared-type-duration, Duration>>
features?: IndicesGetFeatures
}
----
[discrete]
===== `IndicesGetResponse`
[source,ts]
----
type IndicesGetResponse = Record<<<shared-type-index-name, IndexName>>, IndicesIndexState>
----