From b96a3f3a75a28d226da8e194cc556c92c1c6c5fa Mon Sep 17 00:00:00 2001 From: nhtruong <644650+nhtruong@users.noreply.github.com> Date: Sun, 23 Feb 2025 00:10:17 +0000 Subject: [PATCH] Updated opensearch-js to reflect the latest OpenSearch API spec (2025-02-23) Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- api/_types/_common.analysis.d.ts | 12 +- api/_types/_core.search.d.ts | 141 +++++++++++++++++++- api/_types/search_pipeline._common.d.ts | 62 +-------- api/security/authinfo.js | 6 +- api/security/authtoken.js | 2 +- api/security/configUpgradeCheck.js | 2 +- api/security/configUpgradePerform.js | 2 +- api/security/createAllowlist.js | 2 +- api/security/createRole.js | 2 +- api/security/createRoleMapping.js | 2 +- api/security/createTenant.js | 2 +- api/security/createUpdateTenancyConfig.js | 2 +- api/security/createUser.js | 2 +- api/security/createUserLegacy.js | 2 +- api/security/deleteActionGroup.js | 2 +- api/security/deleteDistinguishedName.js | 4 +- api/security/deleteRole.js | 2 +- api/security/deleteRoleMapping.js | 2 +- api/security/deleteTenant.js | 2 +- api/security/deleteUser.js | 2 +- api/security/flushCache.js | 2 +- api/security/generateOboToken.js | 2 +- api/security/generateUserToken.js | 4 +- api/security/generateUserTokenLegacy.js | 2 +- api/security/getAccountDetails.js | 2 +- api/security/getAllCertificates.js | 4 +- api/security/getAllowlist.js | 2 +- api/security/getConfiguration.js | 2 +- api/security/getDashboardsInfo.js | 2 +- api/security/getDistinguishedName.js | 6 +- api/security/getDistinguishedNames.js | 4 +- api/security/getNodeCertificates.js | 8 +- api/security/getPermissionsInfo.js | 2 +- api/security/getRole.js | 2 +- api/security/getRoleMapping.js | 4 +- api/security/getSslinfo.js | 4 +- api/security/getTenancyConfig.js | 2 +- api/security/getTenant.js | 2 +- api/security/getUser.js | 2 +- api/security/health.js | 4 +- api/security/migrate.js | 2 +- api/security/patchActionGroup.js | 2 +- api/security/patchActionGroups.js | 2 +- api/security/patchAllowlist.js | 2 +- api/security/patchAuditConfiguration.js | 2 +- api/security/patchConfiguration.js | 2 +- api/security/patchDistinguishedName.js | 4 +- api/security/patchDistinguishedNames.js | 2 +- api/security/patchRole.js | 2 +- api/security/patchRoleMapping.js | 4 +- api/security/patchRoleMappings.js | 2 +- api/security/patchTenant.js | 2 +- api/security/patchTenants.js | 2 +- api/security/patchUser.js | 2 +- api/security/patchUsers.js | 2 +- api/security/postDashboardsInfo.js | 2 +- api/security/reloadHttpCertificates.js | 2 +- api/security/reloadTransportCertificates.js | 2 +- api/security/tenantInfo.js | 2 +- api/security/updateConfiguration.js | 2 +- api/security/updateDistinguishedName.js | 4 +- api/security/validate.js | 2 +- api/security/whoAmI.js | 2 +- api/security/whoAmIProtected.js | 2 +- 64 files changed, 225 insertions(+), 146 deletions(-) diff --git a/api/_types/_common.analysis.d.ts b/api/_types/_common.analysis.d.ts index 72a9d1567..402dd5dd8 100644 --- a/api/_types/_common.analysis.d.ts +++ b/api/_types/_common.analysis.d.ts @@ -493,6 +493,16 @@ export type SimpleAnalyzer = { version?: Common.VersionString; } +export type SimplePatternSplitTokenizer = TokenizerBase & { + pattern?: string; + type: 'simple_pattern_split'; +} + +export type SimplePatternTokenizer = TokenizerBase & { + pattern?: string; + type: 'simple_pattern'; +} + export type SmartcnAnalyzer = { type?: 'smartcn'; } @@ -598,7 +608,7 @@ export type TokenizerBase = { version?: Common.VersionString; } -export type TokenizerDefinition = CharGroupTokenizer | EdgeNGramTokenizer | KeywordTokenizer | LetterTokenizer | LowercaseTokenizer | NGramTokenizer | NoriTokenizer | PathHierarchyTokenizer | StandardTokenizer | UaxEmailUrlTokenizer | WhitespaceTokenizer | KuromojiTokenizer | PatternTokenizer | IcuTokenizer | SmartcnTokenizer +export type TokenizerDefinition = CharGroupTokenizer | EdgeNGramTokenizer | KeywordTokenizer | LetterTokenizer | LowercaseTokenizer | NGramTokenizer | NoriTokenizer | PathHierarchyTokenizer | StandardTokenizer | UaxEmailUrlTokenizer | WhitespaceTokenizer | KuromojiTokenizer | PatternTokenizer | SimplePatternTokenizer | SimplePatternSplitTokenizer | IcuTokenizer | SmartcnTokenizer export type TrimTokenFilter = TokenFilterBase & { type: 'trim'; diff --git a/api/_types/_core.search.d.ts b/api/_types/_core.search.d.ts index fcbd4cc77..313db9aa1 100644 --- a/api/_types/_core.search.d.ts +++ b/api/_types/_core.search.d.ts @@ -52,21 +52,16 @@ export type AggregationProfileDebug = { collection_strategy?: string; deferred_aggregators?: string[]; delegate?: string; - delegate_debug?: AggregationProfileDebug; + delegate_debug?: AggregationProfileDelegateDebug; empty_collectors_used?: number; extract_count?: number; extract_ns?: number; - filters?: AggregationProfileDelegateDebugFilter[]; has_filter?: boolean; map_reducer?: string; numeric_collectors_used?: number; ordinals_collectors_overhead_too_high?: number; ordinals_collectors_used?: number; result_strategy?: string; - segments_collected?: number; - segments_counted?: number; - segments_with_deleted_docs?: number; - segments_with_doc_count_field?: number; segments_with_multi_valued_ords?: number; segments_with_single_valued_ords?: number; string_hashing_collectors_used?: number; @@ -75,6 +70,14 @@ export type AggregationProfileDebug = { values_fetched?: number; } +export type AggregationProfileDelegateDebug = { + filters?: AggregationProfileDelegateDebugFilter[]; + segments_collected?: number; + segments_counted?: number; + segments_with_deleted_docs?: number; + segments_with_doc_count_field?: number; +} + export type AggregationProfileDelegateDebugFilter = { query?: string; results_from_metadata?: number; @@ -93,10 +96,25 @@ export type Collector = { time_in_nanos: Common.DurationValueUnitNanos; } +export type CompletionContext = Context | { + boost?: number; + context: Context; + neighbours?: Common.GeoHashPrecision[]; + precision?: Common.GeoHashPrecision; + prefix?: boolean; +} + export type CompletionSuggest = SuggestBase & { options: CompletionSuggestOption | CompletionSuggestOption[]; } +export type CompletionSuggester = SuggesterBase & { + contexts?: Record; + fuzzy?: SuggestFuzziness; + regex?: string; + skip_duplicates?: boolean; +} + export type CompletionSuggestOption = { _id?: string; _index?: Common.IndexName; @@ -112,6 +130,20 @@ export type CompletionSuggestOption = { export type Context = string | Common.GeoLocation +export type DirectGenerator = { + field: string; + max_edits?: number; + max_inspections?: number; + max_term_freq?: number; + min_doc_freq?: number; + min_word_length?: number; + post_filter?: string; + pre_filter?: string; + prefix_length?: number; + size?: number; + suggest_mode?: Common.SuggestMode; +} + export type FetchProfile = { breakdown: FetchProfileBreakdown; children?: FetchProfile[]; @@ -143,6 +175,15 @@ export type FieldCollapse = { max_concurrent_group_searches?: number; } +export type FieldSuggester = { + completion?: CompletionSuggester; + phrase?: PhraseSuggester; + prefix?: string; + regex?: string; + term?: TermSuggester; + text?: string; +} + export type Highlight = HighlightBase & { encoder?: HighlighterEncoder; fields: Record; @@ -240,6 +281,16 @@ export type InnerHitsResult = { hits: HitsMetadata; } +export type LaplaceSmoothingModel = { + alpha: number; +} + +export type LinearInterpolationSmoothingModel = { + bigram_lambda: number; + trigram_lambda: number; + unigram_lambda: number; +} + export type NestedIdentity = { _nested?: NestedIdentity; field: Common.Field; @@ -250,6 +301,38 @@ export type PhraseSuggest = SuggestBase & { options: PhraseSuggestOption | PhraseSuggestOption[]; } +export type PhraseSuggestCollate = { + params?: Record; + prune?: boolean; + query: PhraseSuggestCollateQuery; +} + +export type PhraseSuggestCollateQuery = { + id?: string; + source?: string; +} + +export type PhraseSuggester = SuggesterBase & { + collate?: PhraseSuggestCollate; + confidence?: number; + direct_generator?: DirectGenerator[]; + force_unigrams?: boolean; + gram_size?: number; + highlight?: PhraseSuggestHighlight; + max_errors?: number; + real_word_error_likelihood?: number; + separator?: string; + shard_size?: number; + smoothing?: SmoothingModel; + text?: string; + token_limit?: number; +} + +export type PhraseSuggestHighlight = { + post_tag: string; + pre_tag: string; +} + export type PhraseSuggestOption = { collate_match?: boolean; highlighted?: string; @@ -340,6 +423,12 @@ export type ShardProfile = { searches: SearchProfile[]; } +export type SmoothingModel = { + laplace?: LaplaceSmoothingModel; + linear_interpolation?: LinearInterpolationSmoothingModel; + stupid_backoff?: StupidBackoffSmoothingModel; +} + export type SourceConfig = boolean | SourceFilter export type SourceConfigParam = boolean | Common.Fields @@ -349,6 +438,12 @@ export type SourceFilter = Common.Fields | { includes?: Common.Fields; } +export type StringDistance = 'damerau_levenshtein' | 'internal' | 'jaro_winkler' | 'levenshtein' | 'ngram' + +export type StupidBackoffSmoothingModel = { + discount: number; +} + export type Suggest = CompletionSuggest | PhraseSuggest | TermSuggest export type SuggestBase = { @@ -359,15 +454,47 @@ export type SuggestBase = { export type Suggester = { text?: string; + [key: string]: any | FieldSuggester; +} + +export type SuggesterBase = { + analyzer?: string; + field: string; + size?: number; } +export type SuggestFuzziness = { + fuzziness: string; + min_length: number; + prefix_length: number; + transpositions: boolean; + unicode_aware: boolean; +} + +export type SuggestSort = 'frequency' | 'score' + export type TermSuggest = SuggestBase & { options: TermSuggestOption | TermSuggestOption[]; } +export type TermSuggester = SuggesterBase & { + lowercase_terms?: boolean; + max_edits?: number; + max_inspections?: number; + max_term_freq?: number; + min_doc_freq?: number; + min_word_length?: number; + prefix_length?: number; + shard_size?: number; + sort?: SuggestSort; + string_distance?: StringDistance; + suggest_mode?: Common.SuggestMode; + text?: string; +} + export type TermSuggestOption = { collate_match?: boolean; - freq: number; + freq?: number; highlighted?: string; score: number; text: string; diff --git a/api/_types/search_pipeline._common.d.ts b/api/_types/search_pipeline._common.d.ts index 9607bd416..11a6e0341 100644 --- a/api/_types/search_pipeline._common.d.ts +++ b/api/_types/search_pipeline._common.d.ts @@ -14,6 +14,7 @@ * modify the API generator. */ +import * as Common_QueryDsl from './_common.query_dsl' export type CollapseResponseProcessor = { context_prefix?: string; @@ -26,7 +27,7 @@ export type CollapseResponseProcessor = { export type FilterQueryRequestProcessor = { description?: string; ignore_failure?: boolean; - query?: UserDefinedObjectStructure; + query?: Common_QueryDsl.QueryContainer; tag?: string; } @@ -188,62 +189,3 @@ export type TruncateHitsResponseProcessor = { target_size?: number; } -export type UserDefinedObjectStructure = { - bool?: any; - boosting?: any; - combined_fields?: any; - constant_score?: any; - dis_max?: any; - distance_feature?: any; - exists?: any; - field_masking_span?: any; - function_score?: any; - fuzzy?: UserDefinedValueMap; - geo_bounding_box?: any; - geo_distance?: any; - geo_polygon?: any; - geo_shape?: any; - has_child?: any; - has_parent?: any; - ids?: any; - intervals?: UserDefinedValueMap; - knn?: any; - match?: UserDefinedValueMap; - match_all?: any; - match_bool_prefix?: UserDefinedValueMap; - match_none?: any; - match_phrase?: UserDefinedValueMap; - match_phrase_prefix?: UserDefinedValueMap; - more_like_this?: any; - multi_match?: any; - nested?: any; - parent_id?: any; - percolate?: any; - pinned?: any; - prefix?: UserDefinedValueMap; - query_string?: any; - range?: UserDefinedValueMap; - rank_feature?: any; - regexp?: UserDefinedValueMap; - script?: any; - script_score?: any; - shape?: any; - simple_query_string?: any; - span_containing?: any; - span_first?: any; - span_multi?: any; - span_near?: any; - span_not?: any; - span_or?: any; - span_term?: UserDefinedValueMap; - span_within?: any; - term?: UserDefinedValueMap; - terms?: any; - terms_set?: UserDefinedValueMap; - wildcard?: UserDefinedValueMap; - wrapper?: any; -} - -export type UserDefinedValueMap = { -} - diff --git a/api/security/authinfo.js b/api/security/authinfo.js index 54f77d79a..f95701f5e 100644 --- a/api/security/authinfo.js +++ b/api/security/authinfo.js @@ -19,14 +19,14 @@ const { normalizeArguments } = require('../utils'); /** - * Returns the authentication information. + * Returns or updates authentication information for the currently authenticated user. *
See Also: {@link undefined - security.authinfo} * * @memberOf API-Security * * @param {object} [params] - * @param {string} [params.auth_type] - The type of current authentication request. - * @param {boolean} [params.verbose] - Indicates whether a verbose response should be returned. + * @param {string} [params.auth_type] - The type of the current authentication request. + * @param {boolean} [params.verbose] - Whether to return a verbose response. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/security/authtoken.js b/api/security/authtoken.js index f653bf4af..e7fcc78a2 100644 --- a/api/security/authtoken.js +++ b/api/security/authtoken.js @@ -19,7 +19,7 @@ const { normalizeArguments } = require('../utils'); /** - * Returns the authorization token. + * Returns the authorization token for the current user. *
See Also: {@link undefined - security.authtoken} * * @memberOf API-Security diff --git a/api/security/configUpgradeCheck.js b/api/security/configUpgradeCheck.js index ead2a570f..bd19da0a8 100644 --- a/api/security/configUpgradeCheck.js +++ b/api/security/configUpgradeCheck.js @@ -19,7 +19,7 @@ const { normalizeArguments } = require('../utils'); /** - * Check whether or not an upgrade can be performed and what resources can be updated. + * Checks whether or not an upgrade can be performed and which security resources can be updated. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#configuration-upgrade-check - security.config_upgrade_check} * * @memberOf API-Security diff --git a/api/security/configUpgradePerform.js b/api/security/configUpgradePerform.js index 076edec4b..9812b6a6c 100644 --- a/api/security/configUpgradePerform.js +++ b/api/security/configUpgradePerform.js @@ -19,7 +19,7 @@ const { normalizeArguments } = require('../utils'); /** - * Helps cluster operator upgrade missing defaults and stale default definitions. + * Assists the cluster operator with upgrading missing default values and stale default definitions. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#configuration-upgrade - security.config_upgrade_perform} * * @memberOf API-Security diff --git a/api/security/createAllowlist.js b/api/security/createAllowlist.js index c504ae7eb..534d27730 100644 --- a/api/security/createAllowlist.js +++ b/api/security/createAllowlist.js @@ -19,7 +19,7 @@ const { normalizeArguments, handleMissingParam } = require('../utils'); /** - * Creates or replaces the permitted APIs. Accessible using Super Admin certificate or REST API permission. + * Creates or replaces APIs permitted for users on the allow list. Requires a super admin certificate or REST API permissions. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api - security.create_allowlist} * * @memberOf API-Security diff --git a/api/security/createRole.js b/api/security/createRole.js index d47049b3f..29f413343 100644 --- a/api/security/createRole.js +++ b/api/security/createRole.js @@ -25,7 +25,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Security * * @param {object} params - * @param {string} params.role - The name of the role to be created. + * @param {string} params.role - The name of the role to create. * @param {object} params.body * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/security/createRoleMapping.js b/api/security/createRoleMapping.js index ae6856378..447aa14b5 100644 --- a/api/security/createRoleMapping.js +++ b/api/security/createRoleMapping.js @@ -25,7 +25,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Security * * @param {object} params - * @param {string} params.role - The name of the role to create a role mapping for. + * @param {string} params.role - The name of the role for which to create a role mapping. * @param {object} params.body * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/security/createTenant.js b/api/security/createTenant.js index 9f4c9600c..55fdd6b7c 100644 --- a/api/security/createTenant.js +++ b/api/security/createTenant.js @@ -25,7 +25,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Security * * @param {object} params - * @param {string} params.tenant - The name of the tenant to be created. + * @param {string} params.tenant - The name of the tenant to create. * @param {object} params.body * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/security/createUpdateTenancyConfig.js b/api/security/createUpdateTenancyConfig.js index 29ba08cef..972103ccc 100644 --- a/api/security/createUpdateTenancyConfig.js +++ b/api/security/createUpdateTenancyConfig.js @@ -19,7 +19,7 @@ const { normalizeArguments, handleMissingParam } = require('../utils'); /** - * Creates or replaces the multi-tenancy configuration. Only accessible to admins and users with REST API permissions. + * Creates or replaces the multi-tenancy configuration. Requires super admin or REST API permissions. *
See Also: {@link https://opensearch.org/docs/latest/security/multi-tenancy/dynamic-config/#configuring-multi-tenancy-with-the-rest-api - security.create_update_tenancy_config} * * @memberOf API-Security diff --git a/api/security/createUser.js b/api/security/createUser.js index 83f6debf2..0fbfc2faa 100644 --- a/api/security/createUser.js +++ b/api/security/createUser.js @@ -25,7 +25,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Security * * @param {object} params - * @param {string} params.username - The name of the user to be created. + * @param {string} params.username - The name of the user to create. * @param {object} params.body * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/security/createUserLegacy.js b/api/security/createUserLegacy.js index 73fccdcc7..a6843f5a3 100644 --- a/api/security/createUserLegacy.js +++ b/api/security/createUserLegacy.js @@ -25,7 +25,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Security * * @param {object} params - * @param {string} params.username - The name of the user to be created. + * @param {string} params.username - The name of the user to create. * @param {object} params.body * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/security/deleteActionGroup.js b/api/security/deleteActionGroup.js index 47662f76f..b5203ee99 100644 --- a/api/security/deleteActionGroup.js +++ b/api/security/deleteActionGroup.js @@ -19,7 +19,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Delete a specified action group. + * Deletes the specified action group. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group - security.delete_action_group} * * @memberOf API-Security diff --git a/api/security/deleteDistinguishedName.js b/api/security/deleteDistinguishedName.js index 817b98907..4020a1e79 100644 --- a/api/security/deleteDistinguishedName.js +++ b/api/security/deleteDistinguishedName.js @@ -19,13 +19,13 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Deletes all distinguished names in the specified cluster or node allow list. Only accessible to super-admins and with rest-api permissions when enabled. + * Deletes all distinguished names in the specified cluster or node allowlist. Requires super admin or REST API permissions. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#delete-distinguished-names - security.delete_distinguished_name} * * @memberOf API-Security * * @param {object} params - * @param {string} params.cluster_name - The cluster-name to delete from list of distinguished names. + * @param {string} params.cluster_name - The cluster name to delete from list of distinguished names. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/security/deleteRole.js b/api/security/deleteRole.js index d37514d92..ba70367ad 100644 --- a/api/security/deleteRole.js +++ b/api/security/deleteRole.js @@ -19,7 +19,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Delete the specified role. + * Deletes the specified role. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#delete-role - security.delete_role} * * @memberOf API-Security diff --git a/api/security/deleteRoleMapping.js b/api/security/deleteRoleMapping.js index 07c3f10ec..463999b1a 100644 --- a/api/security/deleteRoleMapping.js +++ b/api/security/deleteRoleMapping.js @@ -25,7 +25,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Security * * @param {object} params - * @param {string} params.role - The name of the role whose mapping needs to delete. + * @param {string} params.role - The name of the role for which to delete the role's mappings. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/security/deleteTenant.js b/api/security/deleteTenant.js index 08fabbaa1..5a7c4f850 100644 --- a/api/security/deleteTenant.js +++ b/api/security/deleteTenant.js @@ -19,7 +19,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Delete the specified tenant. + * Deletes the specified tenant. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group - security.delete_tenant} * * @memberOf API-Security diff --git a/api/security/deleteUser.js b/api/security/deleteUser.js index d17365f2a..c74b7ed13 100644 --- a/api/security/deleteUser.js +++ b/api/security/deleteUser.js @@ -19,7 +19,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Delete the specified user. + * Deletes the specified internal user. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#delete-user - security.delete_user} * * @memberOf API-Security diff --git a/api/security/flushCache.js b/api/security/flushCache.js index 3f33de039..bb66ae575 100644 --- a/api/security/flushCache.js +++ b/api/security/flushCache.js @@ -19,7 +19,7 @@ const { normalizeArguments } = require('../utils'); /** - * Flushes the Security plugin user, authentication, and authorization cache. + * Flushes the Security plugin's user, authentication, and authorization cache. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#flush-cache - security.flush_cache} * * @memberOf API-Security diff --git a/api/security/generateOboToken.js b/api/security/generateOboToken.js index b64b8ae31..62e360f62 100644 --- a/api/security/generateOboToken.js +++ b/api/security/generateOboToken.js @@ -19,7 +19,7 @@ const { normalizeArguments, handleMissingParam } = require('../utils'); /** - * Generates On-Behalf-Of token for the current user. + * Generates a `On-Behalf-Of` token for the current user. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/authentication-tokens/#api-endpoint - security.generate_obo_token} * * @memberOf API-Security diff --git a/api/security/generateUserToken.js b/api/security/generateUserToken.js index 15f388256..a62447f07 100644 --- a/api/security/generateUserToken.js +++ b/api/security/generateUserToken.js @@ -19,13 +19,13 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Generates authorization token for the given user. + * Generates an authorization token for the specified user. *
See Also: {@link undefined - security.generate_user_token} * * @memberOf API-Security * * @param {object} params - * @param {string} params.username - The name of the user for whom an auth token is to be vended. + * @param {string} params.username - The name of the user for whom to issue an authorization token. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/security/generateUserTokenLegacy.js b/api/security/generateUserTokenLegacy.js index f03514ff4..ca90aaef3 100644 --- a/api/security/generateUserTokenLegacy.js +++ b/api/security/generateUserTokenLegacy.js @@ -25,7 +25,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Security * * @param {object} params - * @param {string} params.username - The name of the user for whom an auth token is to be vended. + * @param {string} params.username - The name of the user for whom to issue an authorization token. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/security/getAccountDetails.js b/api/security/getAccountDetails.js index b64dbd3a9..6c91c9ad3 100644 --- a/api/security/getAccountDetails.js +++ b/api/security/getAccountDetails.js @@ -19,7 +19,7 @@ const { normalizeArguments } = require('../utils'); /** - * Returns account details for the current user. + * Returns account information for the current user. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#get-account-details - security.get_account_details} * * @memberOf API-Security diff --git a/api/security/getAllCertificates.js b/api/security/getAllCertificates.js index ee61df943..e66447a80 100644 --- a/api/security/getAllCertificates.js +++ b/api/security/getAllCertificates.js @@ -25,8 +25,8 @@ const { normalizeArguments } = require('../utils'); * @memberOf API-Security * * @param {object} [params] - * @param {string} [params.cert_type] - The type of certificates (HTTP, TRANSPORT, ALL) to retrieve from all nodes. - * @param {string} [params.timeout] - The maximum duration, in seconds, to be spent to retrieve certificates from all nodes. + * @param {string} [params.cert_type] - The type of certificates (`HTTP`, `TRANSPORT`, or `ALL`) to retrieve from all nodes. + * @param {string} [params.timeout] - The maximum duration, in seconds, to spend retrieving certificates from all nodes before a timeout. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/security/getAllowlist.js b/api/security/getAllowlist.js index 9d639fef4..32d506df4 100644 --- a/api/security/getAllowlist.js +++ b/api/security/getAllowlist.js @@ -19,7 +19,7 @@ const { normalizeArguments } = require('../utils'); /** - * Retrieves the current list of allowed API accessible to normal user. + * Retrieves the current list of allowed APIs accessible to a normal user. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api - security.get_allowlist} * * @memberOf API-Security diff --git a/api/security/getConfiguration.js b/api/security/getConfiguration.js index b769754d9..1f4c5d32d 100644 --- a/api/security/getConfiguration.js +++ b/api/security/getConfiguration.js @@ -19,7 +19,7 @@ const { normalizeArguments } = require('../utils'); /** - * Returns the current Security plugin configuration in JSON format. + * Returns the current Security plugin configuration in a JSON format. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#get-configuration - security.get_configuration} * * @memberOf API-Security diff --git a/api/security/getDashboardsInfo.js b/api/security/getDashboardsInfo.js index 58b12849a..6352779f8 100644 --- a/api/security/getDashboardsInfo.js +++ b/api/security/getDashboardsInfo.js @@ -19,7 +19,7 @@ const { normalizeArguments } = require('../utils'); /** - * Retrieves the current security-dashboards plugin configuration. + * Retrieves the current values for dynamic security settings for OpenSearch Dashboards. *
See Also: {@link undefined - security.get_dashboards_info} * * @memberOf API-Security diff --git a/api/security/getDistinguishedName.js b/api/security/getDistinguishedName.js index 7aed4c130..700f2b39e 100644 --- a/api/security/getDistinguishedName.js +++ b/api/security/getDistinguishedName.js @@ -19,14 +19,14 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Retrieves distinguished names. Only accessible to super-admins and with rest-api permissions when enabled. + * Retrieves all node distinguished names. Requires super admin or REST API permissions. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names - security.get_distinguished_name} * * @memberOf API-Security * * @param {object} params - * @param {boolean} [params.show_all] - A Boolean flag to include/exclude static nodes DN from final result. - * @param {string} params.cluster_name - The cluster-name to retrieve nodes DN setting for. + * @param {boolean} [params.show_all] - Whether to include or exclude any static node's DN settings from the final result. + * @param {string} params.cluster_name - The name of the cluster to retrieve that cluster's nodes DN settings. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/security/getDistinguishedNames.js b/api/security/getDistinguishedNames.js index d1fac0047..c0383838f 100644 --- a/api/security/getDistinguishedNames.js +++ b/api/security/getDistinguishedNames.js @@ -19,13 +19,13 @@ const { normalizeArguments } = require('../utils'); /** - * Retrieves distinguished names. Only accessible to super-admins and with rest-api permissions when enabled. + * Retrieves all node distinguished names. Requires super admin or REST API permissions. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names - security.get_distinguished_names} * * @memberOf API-Security * * @param {object} [params] - * @param {boolean} [params.show_all] - A Boolean flag to include/exclude static nodes DN from final result. + * @param {boolean} [params.show_all] - Whether to include or exclude any static node's DN settings from the final result. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/security/getNodeCertificates.js b/api/security/getNodeCertificates.js index 0370db242..dc2a883fa 100644 --- a/api/security/getNodeCertificates.js +++ b/api/security/getNodeCertificates.js @@ -19,15 +19,15 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Retrieves the given node's security certificates. + * Retrieves the specified node's security certificates. *
See Also: {@link undefined - security.get_node_certificates} * * @memberOf API-Security * * @param {object} params - * @param {string} [params.cert_type] - The type of certificates (HTTP, TRANSPORT, ALL) to retrieve for a node. - * @param {string} [params.timeout] - The maximum duration, in seconds, to be spent to retrieve a node's certificates. - * @param {string} params.node_id - The full-id of the node to retrieve certificates. + * @param {string} [params.cert_type] - The type of certificates (`HTTP`, `TRANSPORT`, or `ALL`) to retrieve from a node. + * @param {string} [params.timeout] - The maximum duration, in seconds, to spend retrieving certificates from all nodes before a timeout. + * @param {string} params.node_id - The node ID to retrieve certificates for. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/security/getPermissionsInfo.js b/api/security/getPermissionsInfo.js index 9868152db..ee2751381 100644 --- a/api/security/getPermissionsInfo.js +++ b/api/security/getPermissionsInfo.js @@ -19,7 +19,7 @@ const { normalizeArguments } = require('../utils'); /** - * Gets the evaluated REST API permissions for the currently logged in user. + * Retrieves the evaluated REST API permissions for the currently logged in user. *
See Also: {@link undefined - security.get_permissions_info} * * @memberOf API-Security diff --git a/api/security/getRole.js b/api/security/getRole.js index 4dd03e2fc..e8f0c8f79 100644 --- a/api/security/getRole.js +++ b/api/security/getRole.js @@ -25,7 +25,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../u * @memberOf API-Security * * @param {object} params - * @param {string} params.role + * @param {string} params.role - The name of the role to retrieve. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/security/getRoleMapping.js b/api/security/getRoleMapping.js index cafc07775..dbc5237d1 100644 --- a/api/security/getRoleMapping.js +++ b/api/security/getRoleMapping.js @@ -19,13 +19,13 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Retrieves one role mapping. + * Retrieves the specified role mapping. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#get-role-mapping - security.get_role_mapping} * * @memberOf API-Security * * @param {object} params - * @param {string} params.role + * @param {string} params.role - The name of the role mapping to retrieve. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/security/getSslinfo.js b/api/security/getSslinfo.js index eb35a9652..5ce540133 100644 --- a/api/security/getSslinfo.js +++ b/api/security/getSslinfo.js @@ -19,13 +19,13 @@ const { normalizeArguments } = require('../utils'); /** - * Retrieves the SSL configuration information. + * Retrieves information about the SSL configuration. *
See Also: {@link undefined - security.get_sslinfo} * * @memberOf API-Security * * @param {object} [params] - * @param {boolean | string} [params.show_dn] - A Boolean flag to indicate whether all domain names should be returned. + * @param {boolean | string} [params.show_dn] - Whether to include all domain names in the response. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/security/getTenancyConfig.js b/api/security/getTenancyConfig.js index 10d865908..cd17f69e0 100644 --- a/api/security/getTenancyConfig.js +++ b/api/security/getTenancyConfig.js @@ -19,7 +19,7 @@ const { normalizeArguments } = require('../utils'); /** - * Retrieves multi-tenancy configuration. Only accessible to admins and users with REST API permissions. + * Retrieves the multi-tenancy configuration. Requires super admin or REST API permissions. *
See Also: {@link https://opensearch.org/docs/latest/security/multi-tenancy/dynamic-config/#configuring-multi-tenancy-with-the-rest-api - security.get_tenancy_config} * * @memberOf API-Security diff --git a/api/security/getTenant.js b/api/security/getTenant.js index 417108645..ebfbd1638 100644 --- a/api/security/getTenant.js +++ b/api/security/getTenant.js @@ -19,7 +19,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Retrieves one tenant. + * Retrieves the specified tenant. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#get-tenant - security.get_tenant} * * @memberOf API-Security diff --git a/api/security/getUser.js b/api/security/getUser.js index da612887c..8778c5d32 100644 --- a/api/security/getUser.js +++ b/api/security/getUser.js @@ -19,7 +19,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Retrieve one internal user. + * Retrieve information about the specified internal user. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#get-user - security.get_user} * * @memberOf API-Security diff --git a/api/security/health.js b/api/security/health.js index 1d7e7f263..8f655f025 100644 --- a/api/security/health.js +++ b/api/security/health.js @@ -19,13 +19,13 @@ const { normalizeArguments } = require('../utils'); /** - * Checks to see if the Security plugin is up and running. + * Checks to see if the Security plugin is running. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#health-check - security.health} * * @memberOf API-Security * * @param {object} [params] - * @param {string} [params.mode] - A flag to indicate whether service should consider security-plugin's status before returning health response. `strict` mode indicates service should check Security plugin status. + * @param {string} [params.mode] - A flag that determines whether to consider the security status before returning a response for a health query response. For example, `strict` mode indicates service should check the Security plugin status. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/security/migrate.js b/api/security/migrate.js index a80ba7d38..48d364d3b 100644 --- a/api/security/migrate.js +++ b/api/security/migrate.js @@ -19,7 +19,7 @@ const { normalizeArguments } = require('../utils'); /** - * Migrates security configuration from v6 to v7. + * Migrates the security configuration from v6 to v7. *
See Also: {@link undefined - security.migrate} * * @memberOf API-Security diff --git a/api/security/patchActionGroup.js b/api/security/patchActionGroup.js index b5446624b..9b7f5838e 100644 --- a/api/security/patchActionGroup.js +++ b/api/security/patchActionGroup.js @@ -19,7 +19,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Updates individual attributes of an action group. + * Updates the individual attributes of an action group. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#patch-action-group - security.patch_action_group} * * @memberOf API-Security diff --git a/api/security/patchActionGroups.js b/api/security/patchActionGroups.js index 45cfeb730..c02ac1c34 100644 --- a/api/security/patchActionGroups.js +++ b/api/security/patchActionGroups.js @@ -19,7 +19,7 @@ const { normalizeArguments, handleMissingParam } = require('../utils'); /** - * Creates, updates, or deletes multiple action groups in a single call. + * Creates, updates, or deletes multiple action groups in a single request. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#patch-action-groups - security.patch_action_groups} * * @memberOf API-Security diff --git a/api/security/patchAllowlist.js b/api/security/patchAllowlist.js index c3f2df2bc..8e40497b1 100644 --- a/api/security/patchAllowlist.js +++ b/api/security/patchAllowlist.js @@ -19,7 +19,7 @@ const { normalizeArguments, handleMissingParam } = require('../utils'); /** - * Updates the current list of allowed API accessible to normal user. + * Updates the current list of APIs accessible for users on the allow list. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api - security.patch_allowlist} * * @memberOf API-Security diff --git a/api/security/patchAuditConfiguration.js b/api/security/patchAuditConfiguration.js index a8124c645..7faf7e884 100644 --- a/api/security/patchAuditConfiguration.js +++ b/api/security/patchAuditConfiguration.js @@ -19,7 +19,7 @@ const { normalizeArguments, handleMissingParam } = require('../utils'); /** - * A PATCH call is used to update specified fields in the audit configuration. + * Updates the specified fields in the audit configuration. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#audit-logs - security.patch_audit_configuration} * * @memberOf API-Security diff --git a/api/security/patchConfiguration.js b/api/security/patchConfiguration.js index d88a58078..048bb536d 100644 --- a/api/security/patchConfiguration.js +++ b/api/security/patchConfiguration.js @@ -19,7 +19,7 @@ const { normalizeArguments, handleMissingParam } = require('../utils'); /** - * A `PATCH` call is used to update the existing configuration using the REST API. Only accessible by admins and users with REST API access and only when put or patch is enabled. + * Updates the existing security configuration using the REST API. Requires super admin or REST API permissions. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#patch-configuration - security.patch_configuration} * * @memberOf API-Security diff --git a/api/security/patchDistinguishedName.js b/api/security/patchDistinguishedName.js index 1a47e2949..9d92fdd41 100644 --- a/api/security/patchDistinguishedName.js +++ b/api/security/patchDistinguishedName.js @@ -19,13 +19,13 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Updates a distinguished cluster name for a specific cluster. Only accessible to super-admins and with rest-api permissions when enabled. + * Updates the distinguished cluster name for the specified cluster. Requires super admin or REST API permissions. *
See Also: {@link undefined - security.patch_distinguished_name} * * @memberOf API-Security * * @param {object} params - * @param {string} params.cluster_name - The cluster name to update `nodesDn` value. + * @param {string} params.cluster_name - The cluster name to update the `nodesDn` value. * @param {array} [params.body] * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/security/patchDistinguishedNames.js b/api/security/patchDistinguishedNames.js index 9bd211b24..6cbb6b6ef 100644 --- a/api/security/patchDistinguishedNames.js +++ b/api/security/patchDistinguishedNames.js @@ -19,7 +19,7 @@ const { normalizeArguments, handleMissingParam } = require('../utils'); /** - * Bulk update of distinguished names. Only accessible to super-admins and with rest-api permissions when enabled. + * Bulk updates specified node distinguished names. Requires super admin or REST API permissions. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#update-all-distinguished-names - security.patch_distinguished_names} * * @memberOf API-Security diff --git a/api/security/patchRole.js b/api/security/patchRole.js index b63dce2c0..f2d96288d 100644 --- a/api/security/patchRole.js +++ b/api/security/patchRole.js @@ -19,7 +19,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Updates individual attributes of a role. + * Updates the individual attributes of a role. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#patch-role - security.patch_role} * * @memberOf API-Security diff --git a/api/security/patchRoleMapping.js b/api/security/patchRoleMapping.js index 8822bb751..9239e88cf 100644 --- a/api/security/patchRoleMapping.js +++ b/api/security/patchRoleMapping.js @@ -19,13 +19,13 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Updates individual attributes of a role mapping. + * Updates the individual attributes of a role mapping. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mapping - security.patch_role_mapping} * * @memberOf API-Security * * @param {object} params - * @param {string} params.role - The name of the role to update role-mapping for. + * @param {string} params.role - The name of the role to update a role mapping for * @param {array} params.body * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/security/patchRoleMappings.js b/api/security/patchRoleMappings.js index 0c981e57e..690142b9d 100644 --- a/api/security/patchRoleMappings.js +++ b/api/security/patchRoleMappings.js @@ -19,7 +19,7 @@ const { normalizeArguments, handleMissingParam } = require('../utils'); /** - * Creates or updates multiple role mappings in a single call. + * Creates or updates multiple role mappings in a single request. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mappings - security.patch_role_mappings} * * @memberOf API-Security diff --git a/api/security/patchTenant.js b/api/security/patchTenant.js index d0b9c5f7f..5161b839b 100644 --- a/api/security/patchTenant.js +++ b/api/security/patchTenant.js @@ -19,7 +19,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Add, delete, or modify a single tenant. + * Adds, deletes, or modifies a single tenant. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#patch-tenant - security.patch_tenant} * * @memberOf API-Security diff --git a/api/security/patchTenants.js b/api/security/patchTenants.js index b5cbe3b46..0bea5e0b6 100644 --- a/api/security/patchTenants.js +++ b/api/security/patchTenants.js @@ -19,7 +19,7 @@ const { normalizeArguments, handleMissingParam } = require('../utils'); /** - * Add, delete, or modify multiple tenants in a single call. + * Adds, deletes, or modifies multiple tenants in a single request. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#patch-tenants - security.patch_tenants} * * @memberOf API-Security diff --git a/api/security/patchUser.js b/api/security/patchUser.js index 8ae3e87de..5591eeeff 100644 --- a/api/security/patchUser.js +++ b/api/security/patchUser.js @@ -19,7 +19,7 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Updates individual attributes of an internal user. + * Updates individual attributes for an internal user. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#patch-user - security.patch_user} * * @memberOf API-Security diff --git a/api/security/patchUsers.js b/api/security/patchUsers.js index 32dd42158..b8cbc28ff 100644 --- a/api/security/patchUsers.js +++ b/api/security/patchUsers.js @@ -19,7 +19,7 @@ const { normalizeArguments, handleMissingParam } = require('../utils'); /** - * Creates, updates, or deletes multiple internal users in a single call. + * Creates, updates, or deletes multiple internal users in a single request. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#patch-users - security.patch_users} * * @memberOf API-Security diff --git a/api/security/postDashboardsInfo.js b/api/security/postDashboardsInfo.js index 631becac5..02490ac80 100644 --- a/api/security/postDashboardsInfo.js +++ b/api/security/postDashboardsInfo.js @@ -19,7 +19,7 @@ const { normalizeArguments } = require('../utils'); /** - * Updates the current security-dashboards plugin configuration. + * Retrieves the current values for dynamic security settings for OpenSearch Dashboards. *
See Also: {@link undefined - security.post_dashboards_info} * * @memberOf API-Security diff --git a/api/security/reloadHttpCertificates.js b/api/security/reloadHttpCertificates.js index 49e0a8603..35efe4b60 100644 --- a/api/security/reloadHttpCertificates.js +++ b/api/security/reloadHttpCertificates.js @@ -19,7 +19,7 @@ const { normalizeArguments } = require('../utils'); /** - * Reload HTTP layer communication certificates. + * Reloads the HTTP communication certificates. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#reload-http-certificates - security.reload_http_certificates} * * @memberOf API-Security diff --git a/api/security/reloadTransportCertificates.js b/api/security/reloadTransportCertificates.js index ea25c7536..32c70f968 100644 --- a/api/security/reloadTransportCertificates.js +++ b/api/security/reloadTransportCertificates.js @@ -19,7 +19,7 @@ const { normalizeArguments } = require('../utils'); /** - * Reload Transport layer communication certificates. + * Reloads the transport communication certificates. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#reload-transport-certificates - security.reload_transport_certificates} * * @memberOf API-Security diff --git a/api/security/tenantInfo.js b/api/security/tenantInfo.js index e725aa9f8..1fb646670 100644 --- a/api/security/tenantInfo.js +++ b/api/security/tenantInfo.js @@ -19,7 +19,7 @@ const { normalizeArguments } = require('../utils'); /** - * Retrieves the tenant names if any exist. Only accessible to super admins or kibanaserver user. + * Retrieves the names of current tenants. Requires super admin or `kibanaserver` permissions. *
See Also: {@link undefined - security.tenant_info} * * @memberOf API-Security diff --git a/api/security/updateConfiguration.js b/api/security/updateConfiguration.js index 91b9ba2cd..e49734a1b 100644 --- a/api/security/updateConfiguration.js +++ b/api/security/updateConfiguration.js @@ -19,7 +19,7 @@ const { normalizeArguments, handleMissingParam } = require('../utils'); /** - * Adds or updates the existing configuration using the REST API. Only accessible by admins and users with REST API access and only when put or patch is enabled. + * Updates the settings for an existing security configuration. Requires super admin or REST API permissions. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#update-configuration - security.update_configuration} * * @memberOf API-Security diff --git a/api/security/updateDistinguishedName.js b/api/security/updateDistinguishedName.js index 33769b45e..5d9336d03 100644 --- a/api/security/updateDistinguishedName.js +++ b/api/security/updateDistinguishedName.js @@ -19,13 +19,13 @@ const { normalizeArguments, parsePathParam, handleMissingParam } = require('../utils'); /** - * Adds or updates the specified distinguished names in the cluster or node allow list. Only accessible to super-admins and with rest-api permissions when enabled. + * Adds or updates the specified distinguished names in the cluster or node allowlist. Requires super admin or REST API permissions. *
See Also: {@link https://opensearch.org/docs/latest/security/access-control/api/#update-distinguished-names - security.update_distinguished_name} * * @memberOf API-Security * * @param {object} params - * @param {string} params.cluster_name - The cluster-name to create/update `nodesDn` value for. + * @param {string} params.cluster_name - The name of the cluster containing the `nodesDn` value to create or update. * @param {object} [params.body] * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} diff --git a/api/security/validate.js b/api/security/validate.js index 53e716f37..44760613d 100644 --- a/api/security/validate.js +++ b/api/security/validate.js @@ -25,7 +25,7 @@ const { normalizeArguments } = require('../utils'); * @memberOf API-Security * * @param {object} [params] - * @param {boolean} [params.accept_invalid] - A Boolean flag to indicate whether invalid v6 configuration should be allowed. + * @param {boolean} [params.accept_invalid] - Whether an invalid v6 configuration should be allowed. * * @param {TransportRequestOptions} [options] - Options for {@link Transport#request} * @param {function} [callback] - Callback that handles errors and response diff --git a/api/security/whoAmI.js b/api/security/whoAmI.js index 89aabe4dc..350776802 100644 --- a/api/security/whoAmI.js +++ b/api/security/whoAmI.js @@ -19,7 +19,7 @@ const { normalizeArguments } = require('../utils'); /** - * Gets the user identity related information for currently logged in user. + * Gets the identity information for the user currently logged in. *
See Also: {@link undefined - security.who_am_i} * * @memberOf API-Security diff --git a/api/security/whoAmIProtected.js b/api/security/whoAmIProtected.js index d6adf18d9..2ae1277c9 100644 --- a/api/security/whoAmIProtected.js +++ b/api/security/whoAmIProtected.js @@ -19,7 +19,7 @@ const { normalizeArguments } = require('../utils'); /** - * Gets the user identity related information for currently logged in user. User needs to have access to this endpoint when authorization at REST layer is enabled. + * Gets the identity information for the user currently logged in. To use this operation, you must have access to this endpoint when authorization at REST layer is enabled. *
See Also: {@link undefined - security.who_am_i_protected} * * @memberOf API-Security