From 2fd851253effafb6be82eaaf99d151cf8f434ef9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Thu, 7 Sep 2023 17:42:25 +0200 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Abdon Pijpelink --- specification/_global/exists/DocumentExistsRequest.ts | 4 ++-- specification/_global/exists_source/SourceExistsRequest.ts | 4 ++-- specification/_global/get/GetRequest.ts | 2 +- .../_global/msearch_template/MultiSearchTemplateRequest.ts | 4 ++-- specification/_global/reindex_rethrottle/types.ts | 3 --- 5 files changed, 7 insertions(+), 10 deletions(-) diff --git a/specification/_global/exists/DocumentExistsRequest.ts b/specification/_global/exists/DocumentExistsRequest.ts index 0500641230..b708d644f7 100644 --- a/specification/_global/exists/DocumentExistsRequest.ts +++ b/specification/_global/exists/DocumentExistsRequest.ts @@ -53,7 +53,7 @@ export interface Request extends RequestBase { */ preference?: string /** - * If true, the request is real-time as opposed to near-real-time. + * If `true`, the request is real-time as opposed to near-real-time. * @server_default true * @doc_id realtime */ @@ -69,7 +69,7 @@ export interface Request extends RequestBase { */ routing?: Routing /** - * True or false to return the _source field or not, or a list of fields to return. + * `true` or `false` to return the `_source` field or not, or a list of fields to return. */ _source?: SourceConfigParam /** diff --git a/specification/_global/exists_source/SourceExistsRequest.ts b/specification/_global/exists_source/SourceExistsRequest.ts index bae5912959..440eb819ef 100644 --- a/specification/_global/exists_source/SourceExistsRequest.ts +++ b/specification/_global/exists_source/SourceExistsRequest.ts @@ -29,7 +29,7 @@ import { import { SourceConfigParam } from '@global/search/_types/SourceFilter' /** - * Checks if a document is stored in the `source`. + * Checks if a document's `_source` is stored. * @rest_spec_name exists_source * @availability stack since=5.4.0 stability=stable * @availability serverless stability=stable visibility=public @@ -69,7 +69,7 @@ export interface Request extends RequestBase { */ routing?: Routing /** - * True or false to return the _source field or not, or a list of fields to return. + * `true` or `false` to return the `_source` field or not, or a list of fields to return. */ _source?: SourceConfigParam /** diff --git a/specification/_global/get/GetRequest.ts b/specification/_global/get/GetRequest.ts index 4fa0380ddf..16ef920076 100644 --- a/specification/_global/get/GetRequest.ts +++ b/specification/_global/get/GetRequest.ts @@ -46,7 +46,7 @@ export interface Request extends RequestBase { */ preference?: string /** - * If true, the request is real-time as opposed to near-real-time. + * If `true`, the request is real-time as opposed to near-real-time. * @server_default true * @doc_id realtime */ diff --git a/specification/_global/msearch_template/MultiSearchTemplateRequest.ts b/specification/_global/msearch_template/MultiSearchTemplateRequest.ts index 362e34ee77..e2ce4035e5 100644 --- a/specification/_global/msearch_template/MultiSearchTemplateRequest.ts +++ b/specification/_global/msearch_template/MultiSearchTemplateRequest.ts @@ -54,8 +54,8 @@ export interface Request extends RequestBase { */ search_type?: SearchType /** - * If `true`, the response returns hits.total as an integer. - * If `false`, it returns hits.total as an object. + * If `true`, the response returns `hits.total` as an integer. + * If `false`, it returns `hits.total` as an object. * @server_default false */ rest_total_hits_as_int?: boolean diff --git a/specification/_global/reindex_rethrottle/types.ts b/specification/_global/reindex_rethrottle/types.ts index 1057d6a429..5fd1f8dfe6 100644 --- a/specification/_global/reindex_rethrottle/types.ts +++ b/specification/_global/reindex_rethrottle/types.ts @@ -59,9 +59,6 @@ export class ReindexStatus { * The number of retries attempted by reindex. `bulk` is the number of bulk actions retried and `search` is the number of search actions retried. */ retries: Retries - /** - * - */ throttled?: Duration /** * Number of milliseconds the request slept to conform to `requests_per_second`.