@opensearch-project/opensearch/api/indices/putMapping.d.ts

The official OpenSearch client for Node.js

/*
 * Copyright OpenSearch Contributors
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 *
 */

/*
 * This file was generated from the OpenSearch API Spec. Do NOT edit it
 * manually. If you want to make changes, either update the spec or
 * modify the API generator.
 */

import { ApiResponse } from '../../lib/Transport'
import * as Common from '../_types/_common'
import * as Common_Mapping from '../_types/_common.mapping'
import * as Global from '../_types/_global'

export interface Indices_PutMapping_Request extends Global.Params {
  allow_no_indices?: boolean;
  body: Indices_PutMapping_RequestBody;
  cluster_manager_timeout?: Common.Duration;
  expand_wildcards?: Common.ExpandWildcards;
  ignore_unavailable?: boolean;
  index: Common.Indices;
  master_timeout?: Common.Duration;
  timeout?: Common.Duration;
  write_index_only?: boolean;
}

export type Indices_PutMapping_RequestBody = {
  _field_names?: Common_Mapping.FieldNamesField;
  _meta?: Common.Metadata;
  _routing?: Common_Mapping.RoutingField;
  _source?: Common_Mapping.SourceField;
  date_detection?: boolean;
  dynamic?: Common_Mapping.DynamicMapping;
  dynamic_date_formats?: string[];
  dynamic_templates?: Record<string, Common_Mapping.DynamicTemplate> | Record<string, Common_Mapping.DynamicTemplate>[];
  numeric_detection?: boolean;
  properties?: Record<string, Common_Mapping.Property>;
}

export interface Indices_PutMapping_Response extends ApiResponse {
  body: Indices_PutMapping_ResponseBody;
}

export type Indices_PutMapping_ResponseBody = Common.IndicesResponseBase