# Pre Update

Signed-off-by: Theo Truong <[email protected]>
opensearch-project · Dec 18, 2024 · 96a8666 · 96a8666
1 parent ce4a17f
commit 96a8666
Show file tree

Hide file tree

Showing 12 changed files with 15 additions and 8 deletions.
diff --git a/api/_core/reindexRethrottle.js b/api/_core/reindexRethrottle.js
@@ -19,7 +19,7 @@
 const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils');
 
 /**
- * Changes the number of requests per second for a particular Reindex operation.
+ * Changes the number of requests per second for a particular reindex operation.
  * <br/> See Also: {@link https://opensearch.org/docs/latest - reindex_rethrottle}
  *
  * @memberOf API-Core

diff --git a/api/_core/scroll.d.ts b/api/_core/scroll.d.ts
@@ -28,7 +28,7 @@ export type Scroll_Request = Global.Params & {
 
 export type Scroll_RequestBody = {
   scroll?: Common.Duration;
-  scroll_id: Common.ScrollId;
+  scroll_id?: Common.ScrollId;
 }
 
 export type Scroll_Response = ApiResponse & {

diff --git a/api/_core/scroll.js b/api/_core/scroll.js
@@ -28,7 +28,7 @@ const { normalizeArguments, parsePathParam } = require('../utils');
  * @param {boolean} [params.rest_total_hits_as_int=false] - If `true`, the API response's `hit.total` property is returned as an integer. If `false`, the API response's `hit.total` property is returned as an object.
  * @param {string} [params.scroll] - Period to retain the search context for scrolling.
  * @param {string} [params.scroll_id] DEPRECATED - The scroll ID
- * @param {object} [params.body] - The scroll ID if not passed by URL or query parameter.
+ * @param {object} [params.body] 
  *
  * @param {TransportRequestOptions} [options] - Options for {@link Transport#request}
  * @param {function} [callback] - Callback that handles errors and response

diff --git a/api/_core/termvectors.d.ts b/api/_core/termvectors.d.ts
@@ -47,8 +47,9 @@ export type Termvectors_Response = ApiResponse & {
 }
 
 export type Termvectors_ResponseBody = {
-  _id: Common.Id;
+  _id?: Common.Id;
   _index: Common.IndexName;
+  _type?: Common.Type;
   _version: Common.VersionNumber;
   found: boolean;
   term_vectors?: Record<string, Core_Termvectors.TermVector>;

diff --git a/api/_types/_core.msearch_template.d.ts b/api/_types/_core.msearch_template.d.ts
@@ -22,7 +22,7 @@ export type RequestItem = Core_Msearch.MultisearchHeader | TemplateConfig
 export type TemplateConfig = {
   explain?: boolean;
   id?: Common.Id;
-  params?: Record<string, Record<string, any>>;
+  params?: Record<string, string | Record<string, any>>;
   profile?: boolean;
   source?: string;
 }

diff --git a/api/_types/_core.mtermvectors.d.ts b/api/_types/_core.mtermvectors.d.ts
@@ -36,6 +36,7 @@ export type Operation = {
 export type TermVectorsResult = {
   _id: Common.Id;
   _index: Common.IndexName;
+  _type?: Common.Type;
   _version?: Common.VersionNumber;
   error?: Common.ErrorCause;
   found?: boolean;

diff --git a/api/_types/_core.reindex_rethrottle.d.ts b/api/_types/_core.reindex_rethrottle.d.ts
@@ -39,10 +39,12 @@ export type ReindexStatus = {
 export type ReindexTask = {
   action: string;
   cancellable: boolean;
+  cancelled?: boolean;
   description: string;
   headers: Common.HttpHeaders;
   id: number;
   node: Common.Name;
+  resource_stats?: Common.ResourceStats;
   running_time_in_nanos: Common.DurationValueUnitNanos;
   start_time_in_millis: Common.EpochTimeUnitMillis;
   status: ReindexStatus;

diff --git a/api/_types/security._common.d.ts b/api/_types/security._common.d.ts
@@ -247,6 +247,8 @@ export type PatchOperation = {
   value?: Record<string, any>;
 }
 
+export type PatchOperations = PatchOperation[]
+
 export type PermissionsInfo = {
   disabled_endpoints?: Record<string, any>;
   has_api_access?: boolean;

diff --git a/api/_types/tasks._common.d.ts b/api/_types/tasks._common.d.ts
@@ -43,6 +43,7 @@ export type TaskInfo = TaskInfoBase & Record<string, any>
 export type TaskInfoBase = {
   action: string;
   cancellable: boolean;
+  cancellation_time_millis?: Common.EpochTimeUnitMillis;
   cancelled?: boolean;
   description?: string;
   headers: Record<string, string>;

diff --git a/api/security/getDistinguishedName.d.ts b/api/security/getDistinguishedName.d.ts
@@ -27,5 +27,5 @@ export type Security_GetDistinguishedName_Response = ApiResponse & {
   body: Security_GetDistinguishedName_ResponseBody;
 }
 
-export type Security_GetDistinguishedName_ResponseBody = Security_Common.DistinguishedNames
+export type Security_GetDistinguishedName_ResponseBody = Security_Common.DistinguishedNamesMap
 
diff --git a/api/security/patchDistinguishedName.d.ts b/api/security/patchDistinguishedName.d.ts
@@ -19,7 +19,7 @@ import * as Global from '../_types/_global'
 import * as Security_Common from '../_types/security._common'
 
 export type Security_PatchDistinguishedName_Request = Global.Params & {
-  body?: Security_Common.PatchOperation;
+  body?: Security_Common.PatchOperations;
   cluster_name: string;
 }
 

diff --git a/api/security/patchDistinguishedName.js b/api/security/patchDistinguishedName.js
@@ -26,7 +26,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u
  *
  * @param {object} params
  * @param {string} params.cluster_name - The cluster name to update `nodesDn` value.
- * @param {object} [params.body] 
+ * @param {array} [params.body] 
  *
  * @param {TransportRequestOptions} [options] - Options for {@link Transport#request}
  * @param {function} [callback] - Callback that handles errors and response