From bda1c80ca2d52ae08db70dd607d1af9085c94ce6 Mon Sep 17 00:00:00 2001 From: Theo Truong Date: Tue, 14 Nov 2023 13:11:43 -0700 Subject: [PATCH 1/2] Added deprecation warnings for Index Template APIs Signed-off-by: Theo Truong --- CHANGELOG.md | 3 ++- api/api/indices.js | 2 +- api/new.d.ts | 17 +++++++++++++++++ index.d.ts | 40 ++++++++++++++++++++++++++++++++++++++++ 4 files changed, 60 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ef94ec202..2625215a0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) ## [Unreleased] ### Added +- Added deprecation warnings for Index Template APIs ### Dependencies - Bumps `@aws-sdk/types` from 3.418.0 to 3.433.0 - Bumps `@types/node` from 20.6.5 to 20.8.9 @@ -192,4 +193,4 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) ### Fixed -- Fix mutability of connection headers ([#291](https://github.com/opensearch-project/opensearch-js/issues/291)) \ No newline at end of file +- Fix mutability of connection headers ([#291](https://github.com/opensearch-project/opensearch-js/issues/291)) diff --git a/api/api/indices.js b/api/api/indices.js index 5e7ec6b25..eff491db9 100644 --- a/api/api/indices.js +++ b/api/api/indices.js @@ -1336,7 +1336,7 @@ IndicesApi.prototype.getTemplate = function indicesGetTemplateApi(params, option }; /** - * Returns a progress status of current upgrade. (Deprecated. Use API-Document#reindex instead) + * Returns a progress status of current upgrade. * * @memberOf API-Index * diff --git a/api/new.d.ts b/api/new.d.ts index cf6aaef67..366c3ce03 100644 --- a/api/new.d.ts +++ b/api/new.d.ts @@ -951,14 +951,17 @@ declare class Client { options: TransportRequestOptions, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use deleteIndexTemplate instead */ deleteTemplate( params: T.IndicesDeleteTemplateRequest, options?: TransportRequestOptions ): TransportRequestPromise>; + /** @deprecated use deleteIndexTemplate instead */ deleteTemplate( params: T.IndicesDeleteTemplateRequest, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use deleteIndexTemplate instead */ deleteTemplate( params: T.IndicesDeleteTemplateRequest, options: TransportRequestOptions, @@ -1017,14 +1020,17 @@ declare class Client { options: TransportRequestOptions, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use existsIndexTemplate instead */ existsTemplate( params: T.IndicesExistsTemplateRequest, options?: TransportRequestOptions ): TransportRequestPromise>; + /** @deprecated use existsIndexTemplate instead */ existsTemplate( params: T.IndicesExistsTemplateRequest, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use existsIndexTemplate instead */ existsTemplate( params: T.IndicesExistsTemplateRequest, options: TransportRequestOptions, @@ -1168,17 +1174,21 @@ declare class Client { options: TransportRequestOptions, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use getIndexTemplate instead */ getTemplate( params?: T.IndicesGetTemplateRequest, options?: TransportRequestOptions ): TransportRequestPromise>; + /** @deprecated use getIndexTemplate instead */ getTemplate( callback: callbackFn ): TransportRequestCallback; + /** @deprecated use getIndexTemplate instead */ getTemplate( params: T.IndicesGetTemplateRequest, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use getIndexTemplate instead */ getTemplate( params: T.IndicesGetTemplateRequest, options: TransportRequestOptions, @@ -1269,14 +1279,17 @@ declare class Client { options: TransportRequestOptions, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use putIndexTemplate instead */ putTemplate( params: T.IndicesPutTemplateRequest, options?: TransportRequestOptions ): TransportRequestPromise>; + /** @deprecated use putIndexTemplate instead */ putTemplate( params: T.IndicesPutTemplateRequest, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use putIndexTemplate instead */ putTemplate( params: T.IndicesPutTemplateRequest, options: TransportRequestOptions, @@ -1401,17 +1414,21 @@ declare class Client { options: TransportRequestOptions, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use simulateIndexTemplate instead */ simulateTemplate( params?: TODO, options?: TransportRequestOptions ): TransportRequestPromise>; + /** @deprecated use simulateIndexTemplate instead */ simulateTemplate( callback: callbackFn ): TransportRequestCallback; + /** @deprecated use simulateIndexTemplate instead */ simulateTemplate( params: TODO, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use simulateIndexTemplate instead */ simulateTemplate( params: TODO, options: TransportRequestOptions, diff --git a/index.d.ts b/index.d.ts index 324bbf6ed..f80d8f22d 100644 --- a/index.d.ts +++ b/index.d.ts @@ -2360,33 +2360,41 @@ declare class Client { options: TransportRequestOptions, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use delete_index_template instead */ delete_template, TContext = Context>( params?: RequestParams.IndicesDeleteTemplate, options?: TransportRequestOptions ): TransportRequestPromise>; + /** @deprecated use delete_index_template instead */ delete_template, TContext = Context>( callback: callbackFn ): TransportRequestCallback; + /** @deprecated use delete_index_template instead */ delete_template, TContext = Context>( params: RequestParams.IndicesDeleteTemplate, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use delete_index_template instead */ delete_template, TContext = Context>( params: RequestParams.IndicesDeleteTemplate, options: TransportRequestOptions, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use deleteIndexTemplate instead */ deleteTemplate, TContext = Context>( params?: RequestParams.IndicesDeleteTemplate, options?: TransportRequestOptions ): TransportRequestPromise>; + /** @deprecated use deleteIndexTemplate instead */ deleteTemplate, TContext = Context>( callback: callbackFn ): TransportRequestCallback; + /** @deprecated use deleteIndexTemplate instead */ deleteTemplate, TContext = Context>( params: RequestParams.IndicesDeleteTemplate, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use deleteIndexTemplate instead */ deleteTemplate, TContext = Context>( params: RequestParams.IndicesDeleteTemplate, options: TransportRequestOptions, @@ -2504,33 +2512,41 @@ declare class Client { options: TransportRequestOptions, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use exists_index_template instead */ exists_template( params?: RequestParams.IndicesExistsTemplate, options?: TransportRequestOptions ): TransportRequestPromise>; + /** @deprecated use exists_index_template instead */ exists_template( callback: callbackFn ): TransportRequestCallback; + /** @deprecated use exists_index_template instead */ exists_template( params: RequestParams.IndicesExistsTemplate, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use exists_index_template instead */ exists_template( params: RequestParams.IndicesExistsTemplate, options: TransportRequestOptions, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use existsIndexTemplate instead */ existsTemplate( params?: RequestParams.IndicesExistsTemplate, options?: TransportRequestOptions ): TransportRequestPromise>; + /** @deprecated use existsIndexTemplate instead */ existsTemplate( callback: callbackFn ): TransportRequestCallback; + /** @deprecated use existsIndexTemplate instead */ existsTemplate( params: RequestParams.IndicesExistsTemplate, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use existsIndexTemplate instead */ existsTemplate( params: RequestParams.IndicesExistsTemplate, options: TransportRequestOptions, @@ -2776,33 +2792,41 @@ declare class Client { options: TransportRequestOptions, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use get_index_template instead */ get_template, TContext = Context>( params?: RequestParams.IndicesGetTemplate, options?: TransportRequestOptions ): TransportRequestPromise>; + /** @deprecated use get_index_template instead */ get_template, TContext = Context>( callback: callbackFn ): TransportRequestCallback; + /** @deprecated use get_index_template instead */ get_template, TContext = Context>( params: RequestParams.IndicesGetTemplate, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use get_index_template instead */ get_template, TContext = Context>( params: RequestParams.IndicesGetTemplate, options: TransportRequestOptions, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use getIndexTemplate instead */ getTemplate, TContext = Context>( params?: RequestParams.IndicesGetTemplate, options?: TransportRequestOptions ): TransportRequestPromise>; + /** @deprecated use getIndexTemplate instead */ getTemplate, TContext = Context>( callback: callbackFn ): TransportRequestCallback; + /** @deprecated use getIndexTemplate instead */ getTemplate, TContext = Context>( params: RequestParams.IndicesGetTemplate, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use getIndexTemplate instead */ getTemplate, TContext = Context>( params: RequestParams.IndicesGetTemplate, options: TransportRequestOptions, @@ -3112,6 +3136,7 @@ declare class Client { options: TransportRequestOptions, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use put_index_template instead */ put_template< TResponse = Record, TRequestBody extends RequestBody = Record, @@ -3120,6 +3145,7 @@ declare class Client { params?: RequestParams.IndicesPutTemplate, options?: TransportRequestOptions ): TransportRequestPromise>; + /** @deprecated use put_index_template instead */ put_template< TResponse = Record, TRequestBody extends RequestBody = Record, @@ -3127,6 +3153,7 @@ declare class Client { >( callback: callbackFn ): TransportRequestCallback; + /** @deprecated use put_index_template instead */ put_template< TResponse = Record, TRequestBody extends RequestBody = Record, @@ -3135,6 +3162,7 @@ declare class Client { params: RequestParams.IndicesPutTemplate, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use put_index_template instead */ put_template< TResponse = Record, TRequestBody extends RequestBody = Record, @@ -3144,6 +3172,7 @@ declare class Client { options: TransportRequestOptions, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use putIndexTemplate instead */ putTemplate< TResponse = Record, TRequestBody extends RequestBody = Record, @@ -3152,6 +3181,7 @@ declare class Client { params?: RequestParams.IndicesPutTemplate, options?: TransportRequestOptions ): TransportRequestPromise>; + /** @deprecated use putIndexTemplate instead */ putTemplate< TResponse = Record, TRequestBody extends RequestBody = Record, @@ -3159,6 +3189,7 @@ declare class Client { >( callback: callbackFn ): TransportRequestCallback; + /** @deprecated use putIndexTemplate instead */ putTemplate< TResponse = Record, TRequestBody extends RequestBody = Record, @@ -3167,6 +3198,7 @@ declare class Client { params: RequestParams.IndicesPutTemplate, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use putIndexTemplate instead */ putTemplate< TResponse = Record, TRequestBody extends RequestBody = Record, @@ -3416,6 +3448,7 @@ declare class Client { options: TransportRequestOptions, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use simulate_index_template instead */ simulate_template< TResponse = Record, TRequestBody extends RequestBody = Record, @@ -3424,6 +3457,7 @@ declare class Client { params?: RequestParams.IndicesSimulateTemplate, options?: TransportRequestOptions ): TransportRequestPromise>; + /** @deprecated use simulate_index_template instead */ simulate_template< TResponse = Record, TRequestBody extends RequestBody = Record, @@ -3431,6 +3465,7 @@ declare class Client { >( callback: callbackFn ): TransportRequestCallback; + /** @deprecated use simulate_index_template instead */ simulate_template< TResponse = Record, TRequestBody extends RequestBody = Record, @@ -3439,6 +3474,7 @@ declare class Client { params: RequestParams.IndicesSimulateTemplate, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use simulate_index_template instead */ simulate_template< TResponse = Record, TRequestBody extends RequestBody = Record, @@ -3448,6 +3484,7 @@ declare class Client { options: TransportRequestOptions, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use simulateIndexTemplate instead */ simulateTemplate< TResponse = Record, TRequestBody extends RequestBody = Record, @@ -3456,6 +3493,7 @@ declare class Client { params?: RequestParams.IndicesSimulateTemplate, options?: TransportRequestOptions ): TransportRequestPromise>; + /** @deprecated use simulateIndexTemplate instead */ simulateTemplate< TResponse = Record, TRequestBody extends RequestBody = Record, @@ -3463,6 +3501,7 @@ declare class Client { >( callback: callbackFn ): TransportRequestCallback; + /** @deprecated use simulateIndexTemplate instead */ simulateTemplate< TResponse = Record, TRequestBody extends RequestBody = Record, @@ -3471,6 +3510,7 @@ declare class Client { params: RequestParams.IndicesSimulateTemplate, callback: callbackFn ): TransportRequestCallback; + /** @deprecated use simulateIndexTemplate instead */ simulateTemplate< TResponse = Record, TRequestBody extends RequestBody = Record, From a3c6ec946230cfadef5b3c83d1f57cfc05f12a56 Mon Sep 17 00:00:00 2001 From: Theo Truong Date: Wed, 15 Nov 2023 11:39:28 -0700 Subject: [PATCH 2/2] # Added PR link Signed-off-by: Theo Truong --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2625215a0..fc1cc958e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) ## [Unreleased] ### Added -- Added deprecation warnings for Index Template APIs +- Added deprecation warnings for Index Template APIs ([654](https://github.com/opensearch-project/opensearch-js/pull/645)) ### Dependencies - Bumps `@aws-sdk/types` from 3.418.0 to 3.433.0 - Bumps `@types/node` from 20.6.5 to 20.8.9