IndicesPutMappingRequest.ts

/*
 * Licensed to Elasticsearch B.V. under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch B.V. licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import { Dictionary, SingleKeyDictionary } from '@spec_utils/Dictionary'
import { RequestBase } from '@_types/Base'
import {
  ExpandWildcards,
  Indices,
  Metadata,
  PropertyName
} from '@_types/common'
import {
  DynamicMapping,
  DynamicTemplate
} from '@_types/mapping/dynamic-template'
import {
  FieldNamesField,
  RoutingField,
  SourceField
} from '@_types/mapping/meta-fields'
import { Property } from '@_types/mapping/Property'
import { RuntimeFields } from '@_types/mapping/RuntimeFields'
import { Duration } from '@_types/Time'

/**
 * Update field mappings.
 * Add new fields to an existing data stream or index.
 * You can also use this API to change the search settings of existing fields and add new properties to existing object fields.
 * For data streams, these changes are applied to all backing indices by default.
 *
 * **Add multi-fields to an existing field**
 *
 * Multi-fields let you index the same field in different ways.
 * You can use this API to update the fields mapping parameter and enable multi-fields for an existing field.
 * WARNING: If an index (or data stream) contains documents when you add a multi-field, those documents will not have values for the new multi-field.
 * You can populate the new multi-field with the update by query API.
 *
 * **Change supported mapping parameters for an existing field**
 *
 * The documentation for each mapping parameter indicates whether you can update it for an existing field using this API.
 * For example, you can use the update mapping API to update the `ignore_above` parameter.
 *
 * **Change the mapping of an existing field**
 *
 * Except for supported mapping parameters, you can't change the mapping or field type of an existing field.
 * Changing an existing field could invalidate data that's already indexed.
 *
 * If you need to change the mapping of a field in a data stream's backing indices, refer to documentation about modifying data streams.
 * If you need to change the mapping of a field in other indices, create a new index with the correct mapping and reindex your data into that index.
 *
 * **Rename a field**
 *
 * Renaming a field would invalidate data already indexed under the old field name.
 * Instead, add an alias field to create an alternate field name.
 * @rest_spec_name indices.put_mapping
 * @availability stack stability=stable
 * @availability serverless stability=stable visibility=public
 * @doc_id indices-put-mapping
 * @ext_doc_id mapping-params
 * @index_privileges manage
 */
export interface Request extends RequestBase {
  urls: [
    {
      path: '/{index}/_mapping'
      methods: ['PUT', 'POST']
    }
  ]
  path_parts: {
    index: Indices
  }
  query_parameters: {
    /**
     * If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
     * This behavior applies even if the request targets other open indices.
     * @server_default true
     */
    allow_no_indices?: boolean
    /**
     * Type of index that wildcard patterns can match.
     * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
     * Supports comma-separated values, such as `open,hidden`.
     * Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
     * @server_default open
     */
    expand_wildcards?: ExpandWildcards
    /**
     * If `false`, the request returns an error if it targets a missing or closed index.
     * @server_default false
     */
    ignore_unavailable?: boolean
    /**
     * Period to wait for a connection to the master node.
     * If no response is received before the timeout expires, the request fails and returns an error.
     * @server_default 30s
     */
    master_timeout?: Duration
    /**
     * Period to wait for a response.
     * If no response is received before the timeout expires, the request fails and returns an error.
     * @server_default 30s
     */
    timeout?: Duration
    /**
     * If `true`, the mappings are applied only to the current write index for the target.
     * @server_default false
     */
    write_index_only?: boolean
  }
  body: {
    /**
     * Controls whether dynamic date detection is enabled.
     */
    date_detection?: boolean
    /**
     * Controls whether new fields are added dynamically.
     */
    dynamic?: DynamicMapping
    /**
     * If date detection is enabled then new string fields are checked
     * against 'dynamic_date_formats' and if the value matches then
     * a new date field is added instead of string.
     */
    dynamic_date_formats?: string[]
    /**
     * Specify dynamic templates for the mapping.
     */
    dynamic_templates?: SingleKeyDictionary<string, DynamicTemplate>[]
    /**
     * Control whether field names are enabled for the index.
     */
    _field_names?: FieldNamesField
    /**
     * A mapping type can have custom meta data associated with it. These are
     * not used at all by Elasticsearch, but can be used to store
     * application-specific metadata.
     */
    _meta?: Metadata
    /**
     * Automatically map strings into numeric data types for all fields.
     * @server_default false
     */
    numeric_detection?: boolean
    /**
     * Mapping for a field. For new fields, this mapping can include:
     *
     * - Field name
     * - Field data type
     * - Mapping parameters
     */
    properties?: Dictionary<PropertyName, Property>
    /**
     * Enable making a routing value required on indexed documents.
     */
    _routing?: RoutingField
    /**
     * Control whether the _source field is enabled on the index.
     */
    _source?: SourceField
    /**
     * Mapping of runtime fields for the index.
     */
    runtime?: RuntimeFields
  }
}