Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add summaries for root operations #2732

Merged
merged 6 commits into from
Jul 26, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions specification/_global/create/CreateRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import {
import { Duration } from '@_types/Time'

/**
* Index a document.
* Adds a JSON document to the specified data stream or index and makes it searchable.
* If the target is an index and the document already exists, the request updates the document and increments its version.
* @rest_spec_name create
Expand Down
1 change: 1 addition & 0 deletions specification/_global/delete/DeleteRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import { long } from '@_types/Numeric'
import { Duration } from '@_types/Time'

/**
* Delete a document.
* Removes a JSON document from the specified index.
* @rest_spec_name delete
* @availability stack stability=stable
Expand Down
3 changes: 2 additions & 1 deletion specification/_global/exists/DocumentExistsRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ import {
import { SourceConfigParam } from '@global/search/_types/SourceFilter'

/**
* Checks if a document in an index exists.
* Check a document.
* Checks if a specified document exists.
* @rest_spec_name exists
* @availability stack stability=stable
* @availability serverless stability=stable visibility=public
Expand Down
1 change: 1 addition & 0 deletions specification/_global/exists_source/SourceExistsRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import {
import { SourceConfigParam } from '@global/search/_types/SourceFilter'

/**
* Check for a document source.
* Checks if a document's `_source` is stored.
* @rest_spec_name exists_source
* @availability stack since=5.4.0 stability=stable
Expand Down
3 changes: 2 additions & 1 deletion specification/_global/explain/ExplainRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ import { SourceConfigParam } from '@global/search/_types/SourceFilter'
import { Operator } from '@_types/query_dsl/Operator'

/**
* Returns information about why a specific document matches (or doesn’t match) a query.
* Explain a document match result.
* Returns information about why a specific document matches, or doesn’t match, a query.
* @rest_spec_name explain
* @availability stack stability=stable
* @availability serverless stability=stable visibility=public
Expand Down
2 changes: 2 additions & 0 deletions specification/_global/get/GetRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ import {
import { SourceConfigParam } from '@global/search/_types/SourceFilter'

/**
* Get a document by its ID.
* Retrieves the document with the specified ID from an index.
* @rest_spec_name get
* @availability stack stability=stable
* @availability serverless stability=stable visibility=public
Expand Down
2 changes: 2 additions & 0 deletions specification/_global/get_source/SourceRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ import {
import { SourceConfigParam } from '@global/search/_types/SourceFilter'

/**
* Get a document's source.
* Returns the source of a document.
* @rest_spec_name get_source
* @availability stack stability=stable
* @availability serverless stability=stable visibility=public
Expand Down
1 change: 1 addition & 0 deletions specification/_global/index/IndexRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ import { long } from '@_types/Numeric'
import { Duration } from '@_types/Time'

/**
* Index a document.
* Adds a JSON document to the specified data stream or index and makes it searchable.
* If the target is an index and the document already exists, the request updates the document and increments its version.
* @rest_spec_name index
Expand Down
2 changes: 2 additions & 0 deletions specification/_global/info/RootNodeInfoRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
import { RequestBase } from '@_types/Base'

/**
* Get cluster info.
* Returns basic information about the cluster.
* @rest_spec_name info
* @availability stack stability=stable
* @availability serverless stability=stable visibility=public
Expand Down
2 changes: 2 additions & 0 deletions specification/_global/ping/PingRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
import { RequestBase } from '@_types/Base'

/**
* Ping the cluster.
* Returns whether the cluster is running.
* @rest_spec_name ping
* @availability stack stability=stable
* @availability serverless stability=stable visibility=public
Expand Down
2 changes: 2 additions & 0 deletions specification/_global/search_mvt/SearchMvtRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ import { ZoomLevel } from './_types/ZoomLevel'
import { TrackHits } from '@global/search/_types/hits'

/**
* Search a vector tile.
* Searches a vector tile for geospatial values.
* @rest_spec_name search_mvt
* @availability stack since=7.15.0 stability=stable
* @availability serverless stability=stable visibility=public
Expand Down
2 changes: 2 additions & 0 deletions specification/_global/termvectors/TermVectorsRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ import {
import { Filter } from './types'

/**
* Get term vector information.
* Returns information and statistics about terms in the fields of a particular document.
* @rest_spec_name termvectors
* @availability stack stability=stable
* @availability serverless stability=stable visibility=public
Expand Down
2 changes: 2 additions & 0 deletions specification/_global/update/UpdateRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ import { Script } from '@_types/Scripting'
import { Duration } from '@_types/Time'

/**
* Update a document.
* Updates a document by running a script or passing a partial document.
* @rest_spec_name update
* @availability stack stability=stable
* @availability serverless stability=stable visibility=public
Expand Down
2 changes: 2 additions & 0 deletions specification/cluster/info/ClusterInfoRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ import { RequestBase } from '@_types/Base'
import { ClusterInfoTargets } from '@_types/common'

/**
* Get cluster info.
* Returns basic information about the cluster.
* @rest_spec_name cluster.info
* @availability stack since=8.9.0 stability=stable
* @availability serverless stability=stable visibility=public
Expand Down
2 changes: 1 addition & 1 deletion specification/cluster/reroute/ClusterRerouteRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export interface Request extends RequestBase {
*/
metric?: Metrics
/**
* If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures.
* If true, then retries allocation of shards that are ed due to too many subsequent allocation failures.
shainaraskas marked this conversation as resolved.
Show resolved Hide resolved
* @server_default false
*/
retry_failed?: boolean
Expand Down
2 changes: 2 additions & 0 deletions specification/indices/add_block/IndicesAddBlockRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ import { ExpandWildcards, IndexName } from '@_types/common'
import { Duration } from '@_types/Time'

/**
* Add an index block.
* Limits the operations allowed on an index by blocking specific operation types.
* @rest_spec_name indices.add_block
* @availability stack since=7.9.0 stability=stable
* @availability serverless stability=stable visibility=public
Expand Down
1 change: 1 addition & 0 deletions specification/indices/create/IndicesCreateRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import { TypeMapping } from '@_types/mapping/TypeMapping'
import { Duration } from '@_types/Time'

/**
* Create an index.
* Creates a new index.
* @doc_id indices-create-index
* @rest_spec_name indices.create
Expand Down
1 change: 1 addition & 0 deletions specification/indices/delete/IndicesDeleteRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { ExpandWildcards, Indices } from '@_types/common'
import { Duration } from '@_types/Time'

/**
* Delete indices.
* Deletes one or more indices.
* @rest_spec_name indices.delete
* @availability stack stability=stable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { Indices, Names } from '@_types/common'
import { Duration } from '@_types/Time'

/**
* Delete an alias.
* Removes a data stream or index from an alias.
* @rest_spec_name indices.delete_alias
* @availability stack stability=stable
Expand Down
3 changes: 2 additions & 1 deletion specification/indices/exists/IndicesExistsRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ import { RequestBase } from '@_types/Base'
import { ExpandWildcards, Indices } from '@_types/common'

/**
* Checks if a data stream, index, or alias exists.
* Check indices.
* Checks if one or more indices, index aliases, or data streams exist.
* @rest_spec_name indices.exists
* @availability stack stability=stable
* @availability serverless stability=stable visibility=public
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base'
import { ExpandWildcards, Indices, Names } from '@_types/common'

/**
* Check aliases.
* Checks if an alias exists.
* @rest_spec_name indices.exists_alias
* @availability stack stability=stable
Expand Down
1 change: 1 addition & 0 deletions specification/indices/get/IndicesGetRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { ExpandWildcards, Indices } from '@_types/common'
import { Duration } from '@_types/Time'

/**
* Get index information.
* Returns information about one or more indices. For data streams, the API returns information about the
* stream’s backing indices.
* @rest_spec_name indices.get
Expand Down
1 change: 1 addition & 0 deletions specification/indices/get_alias/IndicesGetAliasRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base'
import { ExpandWildcards, Indices, Names } from '@_types/common'

/**
* Get alias information.
* Retrieves information for one or more aliases.
* @rest_spec_name indices.get_alias
* @availability stack stability=stable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { ExpandWildcards, Indices, Names } from '@_types/common'
import { Duration } from '@_types/Time'

/**
* Get index settings.
* Returns setting information for one or more indices. For data streams,
* returns setting information for the stream’s backing indices.
* @rest_spec_name indices.get_settings
Expand Down
1 change: 1 addition & 0 deletions specification/indices/put_alias/IndicesPutAliasRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import { QueryContainer } from '@_types/query_dsl/abstractions'
import { Duration } from '@_types/Time'

/**
* Create or update an alias.
* Adds a data stream or index to an alias.
* @rest_spec_name indices.put_alias
* @availability stack stability=stable
Expand Down
1 change: 1 addition & 0 deletions specification/indices/rollover/IndicesRolloverRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import { Duration } from '@_types/Time'
import { RolloverConditions } from './types'

/**
* Roll over an index.
* Creates a new index for a data stream or index alias.
* @doc_id indices-rollover-index
* @rest_spec_name indices.rollover
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { Duration } from '@_types/Time'
import { Action } from './types'

/**
* Update an alias.
* Adds a data stream or index to an alias.
* @rest_spec_name indices.update_aliases
* @availability stack since=1.3.0 stability=stable
Expand Down