Add notifications API specs

model/_plugins/notifications/config.smithy

@@ -0,0 +1,82 @@
+//  SPDX-License-Identifier: Apache-2.0
+//
+//  The OpenSearch Contributors require contributions made to
+//  this file be licensed under the Apache-2.0 license or a
+//  compatible open source license.
+
+$version: "2"
+namespace OpenSearch
+
+structure NotificationsConfig {
+    config_id: String,
+    name: String,
+    config: NotificationsConfigItem
+}
+
+structure NotificationsConfigItem {
+    name: String,
+    description: String,
+    config_type: String,
+    is_enabled: Boolean,
+    details: NotificationConfigDetails
+}
+
+union NotificationConfigDetails {
+    sns: SnsItem,
+    slack: SlackItem,
+    chime: Chime,
+    webhook: Webhook,
+    smtp_account: SmtpAccount,
+    ses_account: SesAccount,
+    email_group: EmailGroup,
+    email: Email
+}
+
+structure SlackItem {
+    url: String
+}
+
+structure SnsItem {
+    topic_arn: String,
+    role_arn: String
+}
+
+structure Chime {
+    url: String
+}
+
+structure Webhook {
+    url: String
+}
+
+structure SmtpAccount {
+    host: String,
+    port: Integer,
+    method: String,
+    from_addess: String
+}
+
+structure SesAccount {
+    region: String,
+    role_arn: String,
+    from_addess: String
+}
+
+structure EmailGroup {
+    recipient_list: RecipientList,
+    role_arn: String,
+    from_addess: String
+}
+
+structure Email {
+    email_account_id: String,
+    recipient_list: RecipientList
+}
+
+list RecipientList {
+    member: RecipientListItem
+}
+
+structure RecipientListItem {
+    recipient: String
+}

model/_plugins/notifications/create_config/operations.smithy

@@ -0,0 +1,22 @@
+//  SPDX-License-Identifier: Apache-2.0
+//
+//  The OpenSearch Contributors require contributions made to
+//  this file be licensed under the Apache-2.0 license or a
+//  compatible open source license.
+
+$version: "2"
+namespace OpenSearch
+
+@externalDocumentation(
+    "API Reference": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#create-channel-configuration"
+)
+
+@xOperationGroup("notifications.create_config")
+@xVersionAdded("2.0")
+@suppress(["HttpUriConflict"])
+@http(method: "POST", uri: "/_plugins/_notifications/configs")
+@documentation("Create channel configuration.")
+operation NotificationsConfigs_Post {
+    input: NotificationsConfigs_Post_Input,
+    output: NotificationsConfigs_Post_Output
+}

model/_plugins/notifications/create_config/structures.smithy

@@ -0,0 +1,20 @@
+//  SPDX-License-Identifier: Apache-2.0
+//
+//  The OpenSearch Contributors require contributions made to
+//  this file be licensed under the Apache-2.0 license or a
+//  compatible open source license.
+
+$version: "2"
+namespace OpenSearch
+
+@input
+structure NotificationsConfigs_Post_Input {
+    @required
+    @httpPayload
+    content: NotificationsConfig
+}
+
+@output
+structure NotificationsConfigs_Post_Output {
+    config_id: String
+}

model/_plugins/notifications/delete_config/operations.smithy

@@ -0,0 +1,34 @@
+//  SPDX-License-Identifier: Apache-2.0
+//
+//  The OpenSearch Contributors require contributions made to
+//  this file be licensed under the Apache-2.0 license or a
+//  compatible open source license.
+
+$version: "2"
+namespace OpenSearch
+
+@externalDocumentation(
+    "API Reference": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#delete-channel-configuration"
+)
+
+@xOperationGroup("notifications.delete_config")
+@xVersionAdded("2.0")
+@idempotent
+@suppress(["HttpUriConflict"])
+@http(method: "DELETE", uri: "/_plugins/_notifications/configs/{config_id}")
+@documentation("Delete channel configuration.")
+operation NotificationsConfigs_Delete_WithPathParams {
+    input: NotificationsConfigs_Delete_WithPathParams_Input,
+    output: NotificationsConfigs_Delete_Output
+}
+
+@xOperationGroup("notifications.delete_config")
+@xVersionAdded("2.2")
+@idempotent
+@suppress(["HttpUriConflict"])
+@http(method: "DELETE", uri: "/_plugins/_notifications/configs")
+@documentation("Delete channel configuration.")
+operation NotificationsConfigs_Delete_WithQueryParams {
+    input: NotificationsConfigs_Delete_WithQueryParams_Input,
+    output: NotificationsConfigs_Delete_Output
+}

model/_plugins/notifications/delete_config/structures.smithy

@@ -0,0 +1,30 @@
+//  SPDX-License-Identifier: Apache-2.0
+//
+//  The OpenSearch Contributors require contributions made to
+//  this file be licensed under the Apache-2.0 license or a
+//  compatible open source license.
+
+$version: "2"
+namespace OpenSearch
+
+@input
+structure NotificationsConfigs_Delete_WithPathParams_Input {
+    @required
+    @httpLabel
+    config_id: String
+}
+
+@input
+structure NotificationsConfigs_Delete_WithQueryParams_Input {
+    @httpQuery("config_id")
+    @documentation("A channel ID.")
+    config_id: String,
+
+    @httpQuery("config_id_list")
+    @documentation("A comma-separated list of channel IDs.")
+    config_id_list: String
+}
+
+// TODO: Fill in Output Structure (delete_response_list: object)
+structure NotificationsConfigs_Delete_Output {
+}

model/_plugins/notifications/get_configs/operations.smithy

@@ -0,0 +1,34 @@
+//  SPDX-License-Identifier: Apache-2.0
+//
+//  The OpenSearch Contributors require contributions made to
+//  this file be licensed under the Apache-2.0 license or a
+//  compatible open source license.
+
+$version: "2"
+namespace OpenSearch
+
+@externalDocumentation(
+    "API Reference": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#get-channel-configuration"
+)
+
+@xOperationGroup("notifications.get_config")
+@xVersionAdded("2.0")
+@readonly
+@suppress(["HttpUriConflict"])
+@http(method: "GET", uri: "/_plugins/_notifications/configs")
+@documentation("Get channel configuration.")
+operation NotificationsConfigs_Get {
+    input: NotificationsConfigs_Get_Input,
+    output: NotificationsConfigs_Get_Output
+}
+
+@xOperationGroup("notifications.get_config")
+@xVersionAdded("2.0")
+@readonly
+@suppress(["HttpUriConflict"])
+@http(method: "GET", uri: "/_plugins/_notifications/configs/{config_id}")
+@documentation("Get channel configuration.")
+operation NotificationsConfigsItem_Get {
+    input: NotificationsConfigsItem_Get_Input,
+    output: NotificationsConfigs_Get_Output
+}

model/_plugins/notifications/get_configs/structures.smithy

@@ -0,0 +1,37 @@
+//  SPDX-License-Identifier: Apache-2.0
+//
+//  The OpenSearch Contributors require contributions made to
+//  this file be licensed under the Apache-2.0 license or a
+//  compatible open source license.
+
+$version: "2"
+namespace OpenSearch
+
+@input
+structure NotificationsConfigs_Get_Input {
+}
+
+@input
+structure NotificationsConfigsItem_Get_Input {
+    @required
+    @httpLabel
+    config_id: String
+}
+
+structure NotificationsConfigs_Get_Output {
+    start_index: Integer,
+    total_hits: Integer,
+    total_hit_relation: String,
+    config_list: NotificationsConfigsList
+}
+
+list NotificationsConfigsList {
+    member: NotificationsConfigsOutputItem
+}
+
+structure NotificationsConfigsOutputItem {
+    config_id: String,
+    last_updated_time_ms: Integer,
+    created_time_ms: Integer,
+    config: NotificationsConfigItem
+}

model/_plugins/notifications/get_features/operations.smithy

@@ -0,0 +1,23 @@
+//  SPDX-License-Identifier: Apache-2.0
+//
+//  The OpenSearch Contributors require contributions made to
+//  this file be licensed under the Apache-2.0 license or a
+//  compatible open source license.
+
+$version: "2"
+namespace OpenSearch
+
+@externalDocumentation(
+    "API Reference": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#list-supported-channel-configurations"
+)
+
+@xOperationGroup("notifications.features")
+@xVersionAdded("2.0")
+@readonly
+@suppress(["HttpUriConflict"])
+@http(method: "GET", uri: "/_plugins/_notifications/features")
+@documentation("List supported channel configurations.")
+operation NotificationsFeatures_Get {
+    input: NotificationsFeatures_Get_Input,
+    output: NotificationsFeatures_Get_Output
+}

model/_plugins/notifications/get_features/structures.smithy

@@ -0,0 +1,39 @@
+//  SPDX-License-Identifier: Apache-2.0
+//
+//  The OpenSearch Contributors require contributions made to
+//  this file be licensed under the Apache-2.0 license or a
+//  compatible open source license.
+
+$version: "2"
+namespace OpenSearch
+
+@input
+structure NotificationsFeatures_Get_Input {
+}
+
+@output
+structure NotificationsFeatures_Get_Output {
+    allowed_config_type_list: NotificationsFeaturesList,
+    plugin_features: NotificationsPluginFeatures
+}
+
+list NotificationsFeaturesList {
+    member: NotificationsFeaturesListItem
+}
+
+@documentation("Limit the information for notifications features list.")
+enum NotificationsFeaturesListItem {
+    SLACK = "slack",
+    CHIME = "chime",
+    MICROSOFT_TEAMS = "microsoft_teams",
+    WEBHOOK = "webhook",
+    EMAIL = "email",
+    SNS = "sns",
+    SES_ACCOUNT = "ses_account",
+    SMTP_ACCOUNT = "smtp_account",
+    EMAIL_GROUP = "email_group"
+}
+
+structure NotificationsPluginFeatures {
+    tooltip_support: Boolean
+}

model/_plugins/notifications/test_feature/operations.smithy

@@ -0,0 +1,34 @@
+//  SPDX-License-Identifier: Apache-2.0
+//
+//  The OpenSearch Contributors require contributions made to
+//  this file be licensed under the Apache-2.0 license or a
+//  compatible open source license.
+
+$version: "2"
+namespace OpenSearch
+
+@externalDocumentation(
+    "API Reference": "https://opensearch.org/docs/latest/observing-your-data/notifications/api/#send-test-notification"
+)
+
+@xOperationGroup("notifications.feature.test")
+@xVersionAdded("2.0")
+@readonly
+@suppress(["HttpUriConflict"])
+@http(method: "GET", uri: "/_plugins/_notifications/feature/test/{config_id}")
+@documentation("Send a test notification.")
+operation NotificationsFeatureTest_Get {
+    input: NotificationsFeatureTest_Input,
+    output: NotificationsFeatureTest_Output
+}
+
+@xOperationGroup("notifications.feature.test")
+@xVersionAdded("2.0")
+@readonly
+@suppress(["HttpUriConflict"])
+@http(method: "POST", uri: "/_plugins/_notifications/feature/test/{config_id}")
+@documentation("Send a test notification.")
+operation NotificationsFeatureTest_Post {
+    input: NotificationsFeatureTest_Input,
+    output: NotificationsFeatureTest_Output
+}

model/_plugins/notifications/test_feature/structures.smithy

@@ -0,0 +1,18 @@
+//  SPDX-License-Identifier: Apache-2.0
+//
+//  The OpenSearch Contributors require contributions made to
+//  this file be licensed under the Apache-2.0 license or a
+//  compatible open source license.
+
+$version: "2"
+namespace OpenSearch
+
+structure NotificationsFeatureTest_Input {
+    @required
+    @httpLabel
+    config_id: String
+}
+
+// TODO: Fill in Output Structure
+structure NotificationsFeatureTest_Output {
+}