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

77
docs/reference-indices-put_mapping.asciidoc Normal file
View File

@ -0,0 +1,77 @@
[[reference-indices-put_mapping]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.putMapping
Update field mappings. Adds new fields to an existing data stream or index. You can also use this API to change the search settings of existing fields. For data streams, these changes are applied to all backing indices by default.
{ref}/indices-put-mapping.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(IndicesPutMappingRequest, options?): Promise<IndicesPutMappingResponse>
----
[discrete]
===== `IndicesPutMappingRequest`
[source,ts]
----
interface IndicesPutMappingRequest extends <<shared-type-request-base, RequestBase>> {
index: <<shared-type-indices, Indices>>
allow_no_indices?: boolean
expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
ignore_unavailable?: boolean
master_timeout?: <<shared-type-duration, Duration>>
timeout?: <<shared-type-duration, Duration>>
write_index_only?: boolean
date_detection?: boolean
dynamic?: MappingDynamicMapping
dynamic_date_formats?: string[]
dynamic_templates?: Record<string, MappingDynamicTemplate> | Record<string, MappingDynamicTemplate>[]
_field_names?: MappingFieldNamesField
_meta?: <<shared-type-metadata, Metadata>>
numeric_detection?: boolean
properties?: Record<<<shared-type-property-name, PropertyName>>, MappingProperty>
_routing?: MappingRoutingField
_source?: MappingSourceField
runtime?: MappingRuntimeFields
}
----
[discrete]
===== `IndicesPutMappingResponse`
[source,ts]
----
type IndicesPutMappingResponse = <<shared-type-indices-response-base, IndicesResponseBase>>
----