specification/indices/get/IndicesGetRequest.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 { RequestBase } from '@_types/Base'
import { ExpandWildcards, Indices } from '@_types/common'
import { Duration } from '@_types/Time'

/**
 * Get index information.
 * Get information about one or more indices. For data streams, the API returns information about the
 * stream’s backing indices.
 * @rest_spec_name indices.get
 * @availability stack stability=stable
 * @availability serverless stability=stable visibility=public
 * @index_privileges view_index_metadata, manage
 * @doc_id indices-get-index
 */
export interface Request extends RequestBase {
  urls: [
    {
      path: '/{index}'
      methods: ['GET']
    }
  ]
  path_parts: {
    /**
     * Comma-separated list of data streams, indices, and index aliases used to limit the request.
     * Wildcard expressions (*) are supported.
     */
    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. For example,
     * a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.
     * @server_default true
     */
    allow_no_indices?: boolean
    /**
     * Type of index that wildcard expressions 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.
     * @server_default open
     */
    expand_wildcards?: ExpandWildcards
    /**
     * If true, returns settings in flat format.
     * @server_default false
     */
    flat_settings?: boolean
    /**
     * If false, requests that target a missing index return an error.
     * @server_default false
     */
    ignore_unavailable?: boolean
    /**
     * If true, return all default settings in the response.
     * @server_default false
     */
    include_defaults?: boolean
    /**
     * If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
     * @server_default false
     */
    local?: 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
    /**
     * Return only information on specified index features
     * @server_default ['aliases', 'mappings', 'settings']
     * @availability stack since=8.1.0
     * @availability serverless
     */
    features?: Features
  }
}

export enum Feature {
  'aliases',
  'mappings',
  'settings'
}
export type Features = Feature | Feature[]