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

Auto-generated API code (#2852)

Browse Source
This commit is contained in:
Elastic Machine
2025-05-27 18:14:45 +03:00
committed by GitHub
parent cdebf1aebf
commit 42a6fe0f3b
4 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/reference.asciidoc
View File

@ -5914,6 +5914,7 @@ client.indices.deleteIndexTemplate({ name })
[discrete] [discrete]
==== delete_template ==== delete_template
Delete a legacy index template. Delete a legacy index template.
IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
{ref}/indices-delete-template-v1.html[Endpoint documentation] {ref}/indices-delete-template-v1.html[Endpoint documentation]
[source,ts] [source,ts]
@ -6500,7 +6501,7 @@ error.
[discrete] [discrete]
==== get_template ==== get_template
Get index templates. Get legacy index templates.
Get information about one or more index templates. Get information about one or more index templates.
IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
@ -6924,7 +6925,7 @@ error.
[discrete] [discrete]
==== put_template ==== put_template
Create or update an index template. Create or update a legacy index template.
Index templates define settings, mappings, and aliases that can be applied automatically to new indices. Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
Elasticsearch applies templates to new indices based on an index pattern that matches the index name. Elasticsearch applies templates to new indices based on an index pattern that matches the index name.

6
src/api/api/indices.ts
View File

@ -531,7 +531,7 @@ export default class Indices {
} }
/** /**
* Delete a legacy index template. * Delete a legacy index template. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-delete-template-v1.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-delete-template-v1.html | Elasticsearch API documentation}
*/ */
async deleteTemplate (this: That, params: T.IndicesDeleteTemplateRequest | TB.IndicesDeleteTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesDeleteTemplateResponse> async deleteTemplate (this: That, params: T.IndicesDeleteTemplateRequest | TB.IndicesDeleteTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesDeleteTemplateResponse>
@ -1261,7 +1261,7 @@ export default class Indices {
} }
/** /**
* Get index templates. Get information about one or more index templates. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. * Get legacy index templates. Get information about one or more index templates. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-get-template-v1.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-get-template-v1.html | Elasticsearch API documentation}
*/ */
async getTemplate (this: That, params?: T.IndicesGetTemplateRequest | TB.IndicesGetTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesGetTemplateResponse> async getTemplate (this: That, params?: T.IndicesGetTemplateRequest | TB.IndicesGetTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesGetTemplateResponse>
@ -1666,7 +1666,7 @@ export default class Indices {
} }
/** /**
* Create or update an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. Elasticsearch applies templates to new indices based on an index pattern that matches the index name. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. Composable templates always take precedence over legacy templates. If no composable template matches a new index, matching legacy templates are applied according to their order. Index templates are only applied during index creation. Changes to index templates do not affect existing indices. Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. You can use C-style `/* *\/` block comments in index templates. You can include comments anywhere in the request body, except before the opening curly bracket. **Indices matching multiple templates** Multiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index. The order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them. NOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order. * Create or update a legacy index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. Elasticsearch applies templates to new indices based on an index pattern that matches the index name. IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. Composable templates always take precedence over legacy templates. If no composable template matches a new index, matching legacy templates are applied according to their order. Index templates are only applied during index creation. Changes to index templates do not affect existing indices. Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. You can use C-style `/* *\/` block comments in index templates. You can include comments anywhere in the request body, except before the opening curly bracket. **Indices matching multiple templates** Multiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index. The order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them. NOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-templates-v1.html | Elasticsearch API documentation} * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-templates-v1.html | Elasticsearch API documentation}
*/ */
async putTemplate (this: That, params: T.IndicesPutTemplateRequest | TB.IndicesPutTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesPutTemplateResponse> async putTemplate (this: That, params: T.IndicesPutTemplateRequest | TB.IndicesPutTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesPutTemplateResponse>

4
src/api/types.ts
View File

@ -1709,7 +1709,7 @@ export interface SearchShardProfile {
index: IndexName index: IndexName
node_id: NodeId node_id: NodeId
searches: SearchSearchProfile[] searches: SearchSearchProfile[]
shard_id: long shard_id: integer
} }
export interface SearchSmoothingModelContainer { export interface SearchSmoothingModelContainer {
@ -19251,7 +19251,7 @@ export interface SnapshotSnapshotShardFailure {
index: IndexName index: IndexName
node_id?: Id node_id?: Id
reason: string reason: string
shard_id: Id shard_id: integer
index_uuid: Id index_uuid: Id
status: string status: string
} }

4
src/api/typesWithBodyKey.ts
View File

@ -1768,7 +1768,7 @@ export interface SearchShardProfile {
index: IndexName index: IndexName
node_id: NodeId node_id: NodeId
searches: SearchSearchProfile[] searches: SearchSearchProfile[]
shard_id: long shard_id: integer
} }
export interface SearchSmoothingModelContainer { export interface SearchSmoothingModelContainer {
@ -19767,7 +19767,7 @@ export interface SnapshotSnapshotShardFailure {
index: IndexName index: IndexName
node_id?: Id node_id?: Id
reason: string reason: string
shard_id: Id shard_id: integer
index_uuid: Id index_uuid: Id
status: string status: string
} }