diff --git a/OpenSearch.openapi.json b/OpenSearch.openapi.json index aa4420c5a..5a5d33b98 100644 --- a/OpenSearch.openapi.json +++ b/OpenSearch.openapi.json @@ -13317,6 +13317,573 @@ "x-version-added": "1.0" } }, + "/_plugins/_notifications/configs": { + "delete": { + "description": "Delete channel configuration.", + "operationId": "NotificationsConfigs_Delete_WithQueryParams", + "parameters": [ + { + "name": "config_id", + "in": "query", + "description": "A channel ID.", + "schema": { + "type": "string", + "description": "A channel ID." + } + }, + { + "name": "config_id_list", + "in": "query", + "description": "A comma-separated list of channel IDs.", + "schema": { + "type": "string", + "description": "A comma-separated list of channel IDs." + } + } + ], + "responses": { + "200": { + "description": "NotificationsConfigs_Delete_WithQueryParams 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationsConfigs_Delete_WithQueryParamsResponseContent" + } + } + } + } + }, + "x-operation-group": "notifications.delete_config", + "x-version-added": "2.2" + }, + "get": { + "description": "Get channel configuration.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#get-channel-configuration" + }, + "operationId": "NotificationsConfigs_Get", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationsConfigs_GetRequestContent" + } + } + } + }, + "parameters": [ + { + "name": "last_updated_time_ms", + "in": "query", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "created_time_ms", + "in": "query", + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "config_type", + "in": "query", + "description": "Type of notification configuration.", + "schema": { + "$ref": "#/components/schemas/NotificationConfigType" + } + }, + { + "name": "email.email_account_id", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "email.email_group_id_list", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "smtp_account.method", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "ses_account.region", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "name", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "name.keyword", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "description", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "description.keyword", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "slack.url", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "slack.url.keyword", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "chime.url", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "chime.url.keyword", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "microsoft_teams.url", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "microsoft_teams.url.keyword", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "webhook.url", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "webhook.url.keyword", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "smtp_account.host", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "smtp_account.host.keyword", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "smtp_account.from_address", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "smtp_account.from_address.keyword", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "sns.topic_arn", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "sns.topic_arn.keyword", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "sns.role_arn", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "sns.role_arn.keyword", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "ses_account.role_arn", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "ses_account.role_arn.keyword", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "ses_account.from_address", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "ses_account.from_address.keyword", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "is_enabled", + "in": "query", + "schema": { + "type": "boolean" + } + }, + { + "name": "email.recipient_list.recipient", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "email.recipient_list.recipient.keyword", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "email_group.recipient_list.recipient", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "email_group.recipient_list.recipient.keyword", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "query", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "text_query", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "NotificationsConfigs_Get 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationsConfigs_GetResponseContent" + } + } + } + } + }, + "x-operation-group": "notifications.get_config", + "x-version-added": "2.0" + }, + "post": { + "description": "Create channel configuration.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#create-channel-configuration" + }, + "operationId": "NotificationsConfigs_Post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationsConfig" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "NotificationsConfigs_Post 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationsConfigs_PostResponseContent" + } + } + } + } + }, + "x-operation-group": "notifications.create_config", + "x-version-added": "2.0" + } + }, + "/_plugins/_notifications/configs/{config_id}": { + "delete": { + "description": "Delete channel configuration.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#delete-channel-configuration" + }, + "operationId": "NotificationsConfigs_Delete_WithPathParams", + "parameters": [ + { + "name": "config_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "NotificationsConfigs_Delete_WithPathParams 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationsConfigs_Delete_WithPathParamsResponseContent" + } + } + } + } + }, + "x-operation-group": "notifications.delete_config", + "x-version-added": "2.0" + }, + "get": { + "description": "Get channel configuration.", + "operationId": "NotificationsConfigsItem_Get", + "parameters": [ + { + "name": "config_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "NotificationsConfigsItem_Get 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationsConfigsItem_GetResponseContent" + } + } + } + } + }, + "x-operation-group": "notifications.get_config", + "x-version-added": "2.0" + }, + "put": { + "description": "Update channel configuration.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#update-channel-configuration" + }, + "operationId": "NotificationsConfigs_Put", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationsConfig" + } + } + }, + "required": true + }, + "parameters": [ + { + "name": "config_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "NotificationsConfigs_Put 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationsConfigs_PutResponseContent" + } + } + } + } + }, + "x-operation-group": "notifications.update_config", + "x-version-added": "2.0" + } + }, + "/_plugins/_notifications/feature/test/{config_id}": { + "get": { + "description": "Send a test notification.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#send-test-notification" + }, + "operationId": "NotificationsFeatureTest_Get", + "deprecated": true, + "parameters": [ + { + "name": "config_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "NotificationsFeatureTest_Get 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationsFeatureTest_GetResponseContent" + } + } + } + } + }, + "x-deprecation-message": "Use the POST method instead.", + "x-operation-group": "notifications.send_test", + "x-version-added": "2.0", + "x-version-deprecated": "2.3" + }, + "post": { + "description": "Send a test notification.", + "operationId": "NotificationsFeatureTest_Post", + "parameters": [ + { + "name": "config_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "NotificationsFeatureTest_Post 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationsFeatureTest_PostResponseContent" + } + } + } + } + }, + "x-operation-group": "notifications.send_test", + "x-version-added": "2.0" + } + }, + "/_plugins/_notifications/features": { + "get": { + "description": "List supported channel configurations.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#list-supported-channel-configurations" + }, + "operationId": "NotificationsFeatures_Get", + "responses": { + "200": { + "description": "NotificationsFeatures_Get 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotificationsFeatures_GetResponseContent" + } + } + } + } + }, + "x-operation-group": "notifications.list_features", + "x-version-added": "2.0" + } + }, "/_plugins/_security/api/account": { "get": { "description": "Returns account details for the current user.", @@ -16996,6 +17563,78 @@ "x-version-added": "1.0" } }, + "/_search/pipeline/{pipeline}": { + "get": { + "description": "Retrieves information about a specified search pipeline.", + "operationId": "GetSearchPipeline", + "parameters": [ + { + "name": "pipeline", + "in": "path", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "GetSearchPipeline 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchPipelineMap" + } + } + } + } + }, + "x-operation-group": "search_pipeline.get", + "x-version-added": "2.9" + }, + "put": { + "description": "Creates or replaces the specified search pipeline.", + "externalDocs": { + "description": "API Reference", + "url": "https://opensearch.org/docs/latest/search-plugins/search-pipelines/creating-search-pipeline/" + }, + "operationId": "CreateSearchPipeline", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchPipelineStructure" + } + } + }, + "required": true + }, + "parameters": [ + { + "name": "pipeline", + "in": "path", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "CreateSearchPipeline 200 response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateSearchPipelineResponseContent" + } + } + } + } + }, + "x-operation-group": "search_pipeline.create", + "x-version-added": "2.9" + } + }, "/_search/point_in_time": { "delete": { "description": "Deletes one or more point in time searches based on the IDs passed.", @@ -32453,6 +33092,17 @@ } } }, + "Chime": { + "type": "object", + "properties": { + "url": { + "type": "string" + } + }, + "required": [ + "url" + ] + }, "ClearScroll_BodyParams": { "type": "object", "description": "Comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter" @@ -32640,6 +33290,14 @@ } } }, + "CreateSearchPipelineResponseContent": { + "type": "object", + "properties": { + "acknowledged": { + "type": "boolean" + } + } + }, "CreateTenantParams": { "type": "object", "properties": { @@ -32807,6 +33465,12 @@ "pit_id" ] }, + "DeleteResponseList": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/RestStatus" + } + }, "DeleteRoleMappingResponseContent": { "type": "object", "properties": { @@ -32870,6 +33534,17 @@ } } }, + "DeliveryStatus": { + "type": "object", + "properties": { + "status_code": { + "type": "string" + }, + "status_text": { + "type": "string" + } + } + }, "DistinguishedNames": { "type": "object", "properties": { @@ -32887,45 +33562,144 @@ "$ref": "#/components/schemas/DistinguishedNames" } }, - "DynamicConfig": { + "DynamicConfig": { + "type": "object", + "properties": { + "dynamic": { + "$ref": "#/components/schemas/DynamicOptions" + } + } + }, + "DynamicOptions": { + "type": "object", + "properties": { + "filteredAliasMode": { + "type": "string" + }, + "disableRestAuth": { + "type": "boolean" + }, + "disableIntertransportAuth": { + "type": "boolean" + }, + "respectRequestIndicesOptions": { + "type": "boolean" + }, + "kibana": {}, + "http": {}, + "authc": {}, + "authz": {}, + "authFailureListeners": {}, + "doNotFailOnForbidden": { + "type": "boolean" + }, + "multiRolespanEnabled": { + "type": "boolean" + }, + "hostsResolverMode": { + "type": "string" + }, + "doNotFailOnForbiddenEmpty": { + "type": "boolean" + } + } + }, + "Email": { + "type": "object", + "properties": { + "email_account_id": { + "type": "string" + }, + "recipient_list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RecipientListItem" + } + } + }, + "required": [ + "email_account_id" + ] + }, + "EmailEncryptionMethod": { + "type": "string", + "enum": [ + "ssl", + "start_tls", + "none" + ] + }, + "EmailGroup": { + "type": "object", + "properties": { + "recipient_list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RecipientListItem" + } + }, + "email_group_id_list": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "recipient_list" + ] + }, + "EmailRecipientStatus": { "type": "object", "properties": { - "dynamic": { - "$ref": "#/components/schemas/DynamicOptions" + "recipient": { + "type": "string" + }, + "delivery_status": { + "$ref": "#/components/schemas/DeliveryStatus" } } }, - "DynamicOptions": { + "EventSource": { "type": "object", "properties": { - "filteredAliasMode": { + "title": { "type": "string" }, - "disableRestAuth": { - "type": "boolean" + "reference_id": { + "type": "string" }, - "disableIntertransportAuth": { - "type": "boolean" + "severity": { + "$ref": "#/components/schemas/SeverityType" }, - "respectRequestIndicesOptions": { - "type": "boolean" + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "EventStatus": { + "type": "object", + "properties": { + "config_id": { + "type": "string" }, - "kibana": {}, - "http": {}, - "authc": {}, - "authz": {}, - "authFailureListeners": {}, - "doNotFailOnForbidden": { - "type": "boolean" + "config_name": { + "type": "string" }, - "multiRolespanEnabled": { - "type": "boolean" + "config_type": { + "$ref": "#/components/schemas/NotificationConfigType" }, - "hostsResolverMode": { - "type": "string" + "email_recipient_status": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EmailRecipientStatus" + } }, - "doNotFailOnForbiddenEmpty": { - "type": "boolean" + "delivery_status": { + "$ref": "#/components/schemas/DeliveryStatus" } } }, @@ -32948,6 +33722,23 @@ "type": "object", "description": "An index filter specified with the Query DSL" }, + "FilterQueryRequestProcessor": { + "type": "object", + "properties": { + "tag": { + "type": "string" + }, + "description": { + "type": "string" + }, + "ignore_failure": { + "type": "boolean" + }, + "query": { + "$ref": "#/components/schemas/UserDefinedObjectStructure" + } + } + }, "FlushCacheResponseContent": { "type": "object", "properties": { @@ -33041,6 +33832,13 @@ "none" ] }, + "HeaderParamsMap": { + "type": "object", + "additionalProperties": { + "type": "integer", + "format": "int32" + } + }, "Health": { "type": "string", "description": "Health status ('green', 'yellow', or 'red') to filter only indices matching the specified health status.", @@ -33088,6 +33886,14 @@ } } }, + "HttpMethodType": { + "type": "string", + "enum": [ + "POST", + "PUT", + "PATCH" + ] + }, "IndexPermission": { "type": "object", "properties": { @@ -33385,54 +34191,353 @@ "type": "integer", "format": "int32" }, - "search_size": { + "search_size": { + "type": "integer", + "format": "int32" + }, + "description": { + "type": "string" + }, + "method": { + "type": "string" + } + }, + "required": [ + "dimension", + "method", + "training_field", + "training_index" + ] + }, + "Mget_BodyParams": { + "type": "object", + "description": "Document identifiers; can be either `docs` (containing full document information) or `ids` (when index is provided in the URL." + }, + "MicrosoftTeamsItem": { + "type": "object", + "properties": { + "url": { + "type": "string" + } + }, + "required": [ + "url" + ] + }, + "MsearchTemplate_BodyParams": { + "type": "object", + "description": "The request definitions (metadata-search request definition pairs), separated by newlines", + "x-serialize": "bulk" + }, + "Msearch_BodyParams": { + "type": "object", + "description": "The request definitions (metadata-search request definition pairs), separated by newlines", + "x-serialize": "bulk" + }, + "Mtermvectors_BodyParams": { + "type": "object", + "description": "Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation." + }, + "NeuralFieldMap": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "NeuralQueryEnricherRequestProcessor": { + "type": "object", + "properties": { + "tag": { + "type": "string" + }, + "description": { + "type": "string" + }, + "default_model_id": { + "type": "string" + }, + "neural_field_default_id": { + "$ref": "#/components/schemas/NeuralFieldMap" + } + } + }, + "NodesReloadSecureSettings_BodyParams": { + "type": "object", + "description": "An object containing the password for the opensearch keystore" + }, + "NodesStatLevel": { + "type": "string", + "description": "Return indices stats aggregated at index, node or shard level.", + "enum": [ + "indices", + "node", + "shards" + ] + }, + "NormalizationPhaseResultsProcessor": { + "type": "object", + "properties": { + "tag": { + "type": "string" + }, + "description": { + "type": "string" + }, + "ignore_failure": { + "type": "boolean" + }, + "normalization": { + "$ref": "#/components/schemas/ScoreNormalization" + }, + "combination": { + "$ref": "#/components/schemas/ScoreCombination" + } + } + }, + "NotificationConfigType": { + "type": "string", + "description": "Type of notification configuration.", + "enum": [ + "slack", + "chime", + "microsoft_teams", + "webhook", + "email", + "sns", + "ses_account", + "smtp_account", + "email_group" + ] + }, + "NotificationsConfig": { + "type": "object", + "properties": { + "config_id": { + "type": "string" + }, + "config": { + "$ref": "#/components/schemas/NotificationsConfigItem" + } + }, + "required": [ + "config" + ] + }, + "NotificationsConfigItem": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "config_type": { + "$ref": "#/components/schemas/NotificationConfigType" + }, + "is_enabled": { + "type": "boolean" + }, + "sns": { + "$ref": "#/components/schemas/SnsItem" + }, + "slack": { + "$ref": "#/components/schemas/SlackItem" + }, + "chime": { + "$ref": "#/components/schemas/Chime" + }, + "webhook": { + "$ref": "#/components/schemas/Webhook" + }, + "smtp_account": { + "$ref": "#/components/schemas/SmtpAccount" + }, + "ses_account": { + "$ref": "#/components/schemas/SesAccount" + }, + "email_group": { + "$ref": "#/components/schemas/EmailGroup" + }, + "email": { + "$ref": "#/components/schemas/Email" + }, + "microsoft_teams": { + "$ref": "#/components/schemas/MicrosoftTeamsItem" + } + }, + "required": [ + "config_type", + "name" + ] + }, + "NotificationsConfigsItem_GetResponseContent": { + "type": "object", + "properties": { + "start_index": { + "type": "integer", + "format": "int64" + }, + "total_hits": { + "type": "integer", + "format": "int64" + }, + "total_hit_relation": { + "$ref": "#/components/schemas/TotalHitRelation" + }, + "config_list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NotificationsConfigsOutputItem" + } + } + } + }, + "NotificationsConfigsOutputItem": { + "type": "object", + "properties": { + "config_id": { + "type": "string" + }, + "last_updated_time_ms": { + "type": "integer", + "format": "int64" + }, + "created_time_ms": { + "type": "integer", + "format": "int64" + }, + "config": { + "$ref": "#/components/schemas/NotificationsConfigItem" + } + } + }, + "NotificationsConfigs_Delete_WithPathParamsResponseContent": { + "type": "object", + "properties": { + "delete_response_list": { + "$ref": "#/components/schemas/DeleteResponseList" + } + } + }, + "NotificationsConfigs_Delete_WithQueryParamsResponseContent": { + "type": "object", + "properties": { + "delete_response_list": { + "$ref": "#/components/schemas/DeleteResponseList" + } + } + }, + "NotificationsConfigs_GetRequestContent": { + "type": "object", + "properties": { + "config_id_list": { + "type": "array", + "items": { + "type": "string" + } + }, + "sort_field": { + "type": "string" + }, + "sort_order": { + "type": "string" + }, + "from_index": { + "type": "integer", + "format": "int32" + }, + "max_items": { + "type": "integer", + "format": "int32" + } + } + }, + "NotificationsConfigs_GetResponseContent": { + "type": "object", + "properties": { + "start_index": { + "type": "integer", + "format": "int64" + }, + "total_hits": { "type": "integer", - "format": "int32" + "format": "int64" }, - "description": { - "type": "string" + "total_hit_relation": { + "$ref": "#/components/schemas/TotalHitRelation" }, - "method": { - "type": "string" + "config_list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NotificationsConfigsOutputItem" + } } - }, - "required": [ - "dimension", - "method", - "training_field", - "training_index" - ] + } }, - "Mget_BodyParams": { + "NotificationsConfigs_PostResponseContent": { "type": "object", - "description": "Document identifiers; can be either `docs` (containing full document information) or `ids` (when index is provided in the URL." + "properties": { + "config_id": { + "type": "string" + } + } }, - "MsearchTemplate_BodyParams": { + "NotificationsConfigs_PutResponseContent": { "type": "object", - "description": "The request definitions (metadata-search request definition pairs), separated by newlines", - "x-serialize": "bulk" + "properties": { + "config_id": { + "type": "string" + } + } }, - "Msearch_BodyParams": { + "NotificationsFeatureTest_GetResponseContent": { "type": "object", - "description": "The request definitions (metadata-search request definition pairs), separated by newlines", - "x-serialize": "bulk" + "properties": { + "event_source": { + "$ref": "#/components/schemas/EventSource" + }, + "status_list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EventStatus" + } + } + } }, - "Mtermvectors_BodyParams": { + "NotificationsFeatureTest_PostResponseContent": { "type": "object", - "description": "Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation." + "properties": { + "event_source": { + "$ref": "#/components/schemas/EventSource" + }, + "status_list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/EventStatus" + } + } + } }, - "NodesReloadSecureSettings_BodyParams": { + "NotificationsFeatures_GetResponseContent": { "type": "object", - "description": "An object containing the password for the opensearch keystore" + "properties": { + "allowed_config_type_list": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NotificationConfigType" + } + }, + "plugin_features": { + "$ref": "#/components/schemas/NotificationsPluginFeaturesMap" + } + } }, - "NodesStatLevel": { - "type": "string", - "description": "Return indices stats aggregated at index, node or shard level.", - "enum": [ - "indices", - "node", - "shards" - ] + "NotificationsPluginFeaturesMap": { + "type": "object", + "additionalProperties": { + "type": "string" + } }, "OpType": { "type": "string", @@ -33442,6 +34547,30 @@ "create" ] }, + "OversampleRequestProcessor": { + "type": "object", + "properties": { + "tag": { + "type": "string" + }, + "description": { + "type": "string" + }, + "ignore_failure": { + "type": "boolean" + }, + "sample_factor": { + "type": "number", + "format": "float" + }, + "content_prefix": { + "type": "string" + } + }, + "required": [ + "sample_factor" + ] + }, "PatchActionGroupInputPayload": { "type": "array", "items": { @@ -33696,6 +34825,22 @@ } } }, + "PhaseResultsProcessor": { + "oneOf": [ + { + "type": "object", + "title": "normalization-processor", + "properties": { + "normalization-processor": { + "$ref": "#/components/schemas/NormalizationPhaseResultsProcessor" + } + }, + "required": [ + "normalization-processor" + ] + } + ] + }, "PitDetail": { "type": "object", "properties": { @@ -33731,6 +34876,14 @@ "type": "object", "description": "The ranking evaluation search definition, including search requests, document ratings and ranking metric definition." }, + "RecipientListItem": { + "type": "object", + "properties": { + "recipient": { + "type": "string" + } + } + }, "RefreshEnum": { "type": "string", "description": "If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes.", @@ -33841,6 +34994,80 @@ "type": "object", "description": "The search definition template and its params" }, + "RequestProcessor": { + "oneOf": [ + { + "type": "object", + "title": "filter_query", + "properties": { + "filter_query": { + "$ref": "#/components/schemas/FilterQueryRequestProcessor" + } + }, + "required": [ + "filter_query" + ] + }, + { + "type": "object", + "title": "neural_query_enricher", + "properties": { + "neural_query_enricher": { + "$ref": "#/components/schemas/NeuralQueryEnricherRequestProcessor" + } + }, + "required": [ + "neural_query_enricher" + ] + }, + { + "type": "object", + "title": "script", + "properties": { + "script": { + "$ref": "#/components/schemas/SearchScriptRequestProcessor" + } + }, + "required": [ + "script" + ] + }, + { + "type": "object", + "title": "oversample", + "properties": { + "oversample": { + "$ref": "#/components/schemas/OversampleRequestProcessor" + } + }, + "required": [ + "oversample" + ] + } + ] + }, + "RestStatus": { + "type": "string", + "enum": [ + "continue", + "switching_protocols", + "ok", + "created", + "accepted", + "non_authoritative_information", + "no_content", + "reset_content", + "partial_content", + "multi_status", + "multiple_choices", + "moved_permanently", + "found", + "see_other", + "not_modified", + "use_proxy", + "temporary_redirect" + ] + }, "Role": { "type": "object", "properties": { @@ -33935,6 +35162,44 @@ "block" ] }, + "ScoreCombination": { + "type": "object", + "properties": { + "technique": { + "$ref": "#/components/schemas/ScoreCombinationTechnique" + }, + "parameters": { + "type": "array", + "items": { + "type": "number", + "format": "float" + } + } + } + }, + "ScoreCombinationTechnique": { + "type": "string", + "enum": [ + "arithmetic_mean", + "geometric_mean", + "harmonic_mean" + ] + }, + "ScoreNormalization": { + "type": "object", + "properties": { + "technique": { + "$ref": "#/components/schemas/ScoreNormalizationTechnique" + } + } + }, + "ScoreNormalizationTechnique": { + "type": "string", + "enum": [ + "min_max", + "l2" + ] + }, "ScriptsPainlessExecute_BodyParams": { "type": "object", "description": "The script to execute" @@ -33943,6 +35208,62 @@ "type": "object", "description": "The scroll ID if not passed by URL or query parameter." }, + "SearchPipelineMap": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/SearchPipelineStructure" + } + }, + "SearchPipelineStructure": { + "type": "object", + "properties": { + "version": { + "type": "integer", + "format": "int32" + }, + "request_processors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestProcessor" + } + }, + "response_processors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestProcessor" + } + }, + "phase_results_processors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PhaseResultsProcessor" + } + } + } + }, + "SearchScriptRequestProcessor": { + "type": "object", + "properties": { + "tag": { + "type": "string" + }, + "description": { + "type": "string" + }, + "ignore_failure": { + "type": "boolean" + }, + "source": { + "type": "string" + }, + "lang": { + "type": "string" + } + }, + "required": [ + "source" + ] + }, "SearchTemplate_BodyParams": { "type": "object", "description": "The search definition template and its params" @@ -34119,6 +35440,32 @@ } } }, + "SesAccount": { + "type": "object", + "properties": { + "region": { + "type": "string" + }, + "role_arn": { + "type": "string" + }, + "from_addess": { + "type": "string" + } + }, + "required": [ + "from_addess", + "region" + ] + }, + "SeverityType": { + "type": "string", + "enum": [ + "high", + "info", + "critical" + ] + }, "ShardStatistics": { "type": "object", "properties": { @@ -34140,6 +35487,41 @@ } } }, + "SlackItem": { + "type": "object", + "properties": { + "url": { + "type": "string" + } + }, + "required": [ + "url" + ] + }, + "SmtpAccount": { + "type": "object", + "properties": { + "host": { + "type": "string" + }, + "port": { + "type": "integer", + "format": "int32" + }, + "method": { + "$ref": "#/components/schemas/EmailEncryptionMethod" + }, + "from_addess": { + "type": "string" + } + }, + "required": [ + "from_addess", + "host", + "method", + "port" + ] + }, "SnapshotClone_BodyParams": { "type": "object", "description": "The snapshot clone definition" @@ -34156,6 +35538,20 @@ "type": "object", "description": "Details of what to restore" }, + "SnsItem": { + "type": "object", + "properties": { + "topic_arn": { + "type": "string" + }, + "role_arn": { + "type": "string" + } + }, + "required": [ + "topic_arn" + ] + }, "Status_Member": { "type": "string", "enum": [ @@ -34243,6 +35639,13 @@ } } }, + "TotalHitRelation": { + "type": "string", + "enum": [ + "eq", + "gte" + ] + }, "UpdateAuditConfigurationResponseContent": { "type": "object", "properties": { @@ -34511,6 +35914,23 @@ "yellow", "red" ] + }, + "Webhook": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "method": { + "$ref": "#/components/schemas/HttpMethodType" + }, + "header_params": { + "$ref": "#/components/schemas/HeaderParamsMap" + } + }, + "required": [ + "url" + ] } }, "securitySchemes": {