Add ObservabilityPipelineWebsocketSource to schema (#1776)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v2/openapi.yaml

@@ -64152,6 +64152,7 @@ components:
         - $ref: "#/components/schemas/ObservabilityPipelineSplunkTcpSource"
         - $ref: "#/components/schemas/ObservabilityPipelineSumoLogicSource"
         - $ref: "#/components/schemas/ObservabilityPipelineSyslogNgSource"
+        - $ref: "#/components/schemas/ObservabilityPipelineWebsocketSource"
         - $ref: "#/components/schemas/ObservabilityPipelineOpentelemetrySource"
     ObservabilityPipelineCrowdStrikeNextGenSiemDestination:
       description: |-
@@ -68808,6 +68809,128 @@ components:
       required:
         - crt_file
       type: object
+    ObservabilityPipelineWebsocketSource:
+      description: |-
+        The `websocket` source ingests logs from a WebSocket server using the `ws://` or `wss://` protocol.
+
+        **Supported pipeline types:** logs.
+      properties:
+        auth_strategy:
+          $ref: "#/components/schemas/ObservabilityPipelineWebsocketSourceAuthStrategy"
+        custom_key:
+          description: Name of the environment variable or secret that holds the custom authorization header value. Used when `auth_strategy` is `custom`.
+          example: WS_AUTH_CUSTOM_HEADER
+          type: string
+        decoding:
+          $ref: "#/components/schemas/ObservabilityPipelineDecoding"
+        id:
+          description: The unique identifier for this component.
+          example: websocket-source
+          type: string
+        password_key:
+          description: Name of the environment variable or secret that holds the password. Used when `auth_strategy` is `basic`.
+          example: WS_AUTH_PASSWORD
+          type: string
+        tls:
+          $ref: "#/components/schemas/ObservabilityPipelineWebsocketSourceTls"
+        token_key:
+          description: Name of the environment variable or secret that holds the bearer token. Used when `auth_strategy` is `bearer`.
+          example: WS_BEARER_TOKEN
+          type: string
+        type:
+          $ref: "#/components/schemas/ObservabilityPipelineWebsocketSourceType"
+        uri_key:
+          description: Name of the environment variable or secret that holds the WebSocket server URI (`ws://` or `wss://`).
+          example: WS_URI
+          type: string
+        username_key:
+          description: Name of the environment variable or secret that holds the username. Used when `auth_strategy` is `basic`.
+          example: WS_AUTH_USERNAME
+          type: string
+      required:
+        - id
+        - type
+        - decoding
+        - auth_strategy
+      type: object
+      x-pipeline-types: [logs]
+    ObservabilityPipelineWebsocketSourceAuthStrategy:
+      description: Authentication strategy for the WebSocket source connection.
+      enum:
+        - none
+        - basic
+        - bearer
+        - custom
+      example: bearer
+      type: string
+      x-enum-varnames:
+        - NONE
+        - BASIC
+        - BEARER
+        - CUSTOM
+    ObservabilityPipelineWebsocketSourceTls:
+      description: TLS configuration for the WebSocket source. Use `enabled` for standard `wss://` connections, or `with_client_cert` to present a client certificate for mutual TLS.
+      oneOf:
+        - $ref: "#/components/schemas/ObservabilityPipelineWebsocketSourceTlsEnabled"
+        - $ref: "#/components/schemas/ObservabilityPipelineWebsocketSourceTlsWithClientCert"
+    ObservabilityPipelineWebsocketSourceTlsEnabled:
+      description: TLS configuration that enables encryption without a client certificate. Use this for standard `wss://` connections that do not require mutual TLS.
+      properties:
+        mode:
+          $ref: "#/components/schemas/ObservabilityPipelineWebsocketSourceTlsEnabledMode"
+      required:
+        - mode
+      type: object
+    ObservabilityPipelineWebsocketSourceTlsEnabledMode:
+      description: TLS mode. Must be `enabled`.
+      enum:
+        - enabled
+      example: enabled
+      type: string
+      x-enum-varnames:
+        - ENABLED
+    ObservabilityPipelineWebsocketSourceTlsWithClientCert:
+      description: TLS configuration that enables encryption and presents a client certificate for mutual TLS authentication.
+      properties:
+        ca_file:
+          description: Path to the Certificate Authority (CA) file used to validate the remote server's TLS certificate.
+          example: /path/to/ca.crt
+          type: string
+        crt_file:
+          description: Path to the TLS client certificate file used to identify this source to the remote server.
+          example: /path/to/client.crt
+          type: string
+        key_file:
+          description: Path to the private key file associated with the client certificate.
+          example: /path/to/client.key
+          type: string
+        key_pass_key:
+          description: Name of the environment variable or secret that holds the passphrase for the private key file.
+          example: WS_TLS_KEY_PASSPHRASE
+          type: string
+        mode:
+          $ref: "#/components/schemas/ObservabilityPipelineWebsocketSourceTlsWithClientCertMode"
+      required:
+        - mode
+        - crt_file
+      type: object
+    ObservabilityPipelineWebsocketSourceTlsWithClientCertMode:
+      description: TLS mode. Must be `with_client_cert`.
+      enum:
+        - with_client_cert
+      example: with_client_cert
+      type: string
+      x-enum-varnames:
+        - WITH_CLIENT_CERT
+    ObservabilityPipelineWebsocketSourceType:
+      default: websocket
+      description: The source type. The value should always be `websocket`.
+      enum:
+        - websocket
+      example: websocket
+      type: string
+      x-enum-varnames:
+        - WEBSOCKET
     OktaAPIToken:
       description: The definition of the `OktaAPIToken` object.
       properties:

examples/v2_observability-pipelines_ValidatePipeline_337125830.rs

@@ -0,0 +1,102 @@
+// Validate an observability pipeline with websocket source bearer auth returns
+// "OK" response
+use datadog_api_client::datadog;
+use datadog_api_client::datadogV2::api_observability_pipelines::ObservabilityPipelinesAPI;
+use datadog_api_client::datadogV2::model::ObservabilityPipelineConfig;
+use datadog_api_client::datadogV2::model::ObservabilityPipelineConfigDestinationItem;
+use datadog_api_client::datadogV2::model::ObservabilityPipelineConfigProcessorGroup;
+use datadog_api_client::datadogV2::model::ObservabilityPipelineConfigProcessorItem;
+use datadog_api_client::datadogV2::model::ObservabilityPipelineConfigSourceItem;
+use datadog_api_client::datadogV2::model::ObservabilityPipelineDataAttributes;
+use datadog_api_client::datadogV2::model::ObservabilityPipelineDatadogLogsDestination;
+use datadog_api_client::datadogV2::model::ObservabilityPipelineDatadogLogsDestinationType;
+use datadog_api_client::datadogV2::model::ObservabilityPipelineDecoding;
+use datadog_api_client::datadogV2::model::ObservabilityPipelineFilterProcessor;
+use datadog_api_client::datadogV2::model::ObservabilityPipelineFilterProcessorType;
+use datadog_api_client::datadogV2::model::ObservabilityPipelineSpec;
+use datadog_api_client::datadogV2::model::ObservabilityPipelineSpecData;
+use datadog_api_client::datadogV2::model::ObservabilityPipelineWebsocketSource;
+use datadog_api_client::datadogV2::model::ObservabilityPipelineWebsocketSourceAuthStrategy;
+use datadog_api_client::datadogV2::model::ObservabilityPipelineWebsocketSourceTls;
+use datadog_api_client::datadogV2::model::ObservabilityPipelineWebsocketSourceTlsEnabled;
+use datadog_api_client::datadogV2::model::ObservabilityPipelineWebsocketSourceTlsEnabledMode;
+use datadog_api_client::datadogV2::model::ObservabilityPipelineWebsocketSourceType;
+
+#[tokio::main]
+async fn main() {
+    let body =
+        ObservabilityPipelineSpec::new(
+            ObservabilityPipelineSpecData::new(
+                ObservabilityPipelineDataAttributes::new(
+                    ObservabilityPipelineConfig::new(
+                        vec![
+                            ObservabilityPipelineConfigDestinationItem::ObservabilityPipelineDatadogLogsDestination(
+                                Box::new(
+                                    ObservabilityPipelineDatadogLogsDestination::new(
+                                        "datadog-logs-destination".to_string(),
+                                        vec!["my-processor-group".to_string()],
+                                        ObservabilityPipelineDatadogLogsDestinationType::DATADOG_LOGS,
+                                    ),
+                                ),
+                            )
+                        ],
+                        vec![
+                            ObservabilityPipelineConfigSourceItem::ObservabilityPipelineWebsocketSource(
+                                Box::new(
+                                    ObservabilityPipelineWebsocketSource::new(
+                                        ObservabilityPipelineWebsocketSourceAuthStrategy::BEARER,
+                                        ObservabilityPipelineDecoding::DECODE_JSON,
+                                        "websocket-source".to_string(),
+                                        ObservabilityPipelineWebsocketSourceType::WEBSOCKET,
+                                    )
+                                        .tls(
+                                            ObservabilityPipelineWebsocketSourceTls
+                                            ::ObservabilityPipelineWebsocketSourceTlsEnabled(
+                                                Box::new(
+                                                    ObservabilityPipelineWebsocketSourceTlsEnabled::new(
+                                                        ObservabilityPipelineWebsocketSourceTlsEnabledMode::ENABLED,
+                                                    ),
+                                                ),
+                                            ),
+                                        )
+                                        .token_key("WS_BEARER_TOKEN".to_string())
+                                        .uri_key("WS_URI".to_string()),
+                                ),
+                            )
+                        ],
+                    ).processor_groups(
+                        vec![
+                            ObservabilityPipelineConfigProcessorGroup::new(
+                                true,
+                                "my-processor-group".to_string(),
+                                "service:my-service".to_string(),
+                                vec!["websocket-source".to_string()],
+                                vec![
+                                    ObservabilityPipelineConfigProcessorItem::ObservabilityPipelineFilterProcessor(
+                                        Box::new(
+                                            ObservabilityPipelineFilterProcessor::new(
+                                                true,
+                                                "filter-processor".to_string(),
+                                                "status:error".to_string(),
+                                                ObservabilityPipelineFilterProcessorType::FILTER,
+                                            ),
+                                        ),
+                                    )
+                                ],
+                            )
+                        ],
+                    ),
+                    "Pipeline with WebSocket Source".to_string(),
+                ),
+                "pipelines".to_string(),
+            ),
+        );
+    let configuration = datadog::Configuration::new();
+    let api = ObservabilityPipelinesAPI::with_config(configuration);
+    let resp = api.validate_pipeline(body).await;
+    if let Ok(value) = resp {
+        println!("{:#?}", value);
+    } else {
+        println!("{:#?}", resp.unwrap_err());
+    }
+}

src/datadogV2/model/mod.rs

@@ -7660,6 +7660,22 @@ pub mod model_observability_pipeline_syslog_ng_source;
 pub use self::model_observability_pipeline_syslog_ng_source::ObservabilityPipelineSyslogNgSource;
 pub mod model_observability_pipeline_syslog_ng_source_type;
 pub use self::model_observability_pipeline_syslog_ng_source_type::ObservabilityPipelineSyslogNgSourceType;
+pub mod model_observability_pipeline_websocket_source;
+pub use self::model_observability_pipeline_websocket_source::ObservabilityPipelineWebsocketSource;
+pub mod model_observability_pipeline_websocket_source_auth_strategy;
+pub use self::model_observability_pipeline_websocket_source_auth_strategy::ObservabilityPipelineWebsocketSourceAuthStrategy;
+pub mod model_observability_pipeline_websocket_source_tls_enabled;
+pub use self::model_observability_pipeline_websocket_source_tls_enabled::ObservabilityPipelineWebsocketSourceTlsEnabled;
+pub mod model_observability_pipeline_websocket_source_tls_enabled_mode;
+pub use self::model_observability_pipeline_websocket_source_tls_enabled_mode::ObservabilityPipelineWebsocketSourceTlsEnabledMode;
+pub mod model_observability_pipeline_websocket_source_tls_with_client_cert;
+pub use self::model_observability_pipeline_websocket_source_tls_with_client_cert::ObservabilityPipelineWebsocketSourceTlsWithClientCert;
+pub mod model_observability_pipeline_websocket_source_tls_with_client_cert_mode;
+pub use self::model_observability_pipeline_websocket_source_tls_with_client_cert_mode::ObservabilityPipelineWebsocketSourceTlsWithClientCertMode;
+pub mod model_observability_pipeline_websocket_source_tls;
+pub use self::model_observability_pipeline_websocket_source_tls::ObservabilityPipelineWebsocketSourceTls;
+pub mod model_observability_pipeline_websocket_source_type;
+pub use self::model_observability_pipeline_websocket_source_type::ObservabilityPipelineWebsocketSourceType;
 pub mod model_observability_pipeline_opentelemetry_source;
 pub use self::model_observability_pipeline_opentelemetry_source::ObservabilityPipelineOpentelemetrySource;
 pub mod model_observability_pipeline_opentelemetry_source_type;

src/datadogV2/model/model_observability_pipeline_config_source_item.rs

@@ -56,6 +56,9 @@ pub enum ObservabilityPipelineConfigSourceItem {
     ObservabilityPipelineSyslogNgSource(
         Box<crate::datadogV2::model::ObservabilityPipelineSyslogNgSource>,
     ),
+    ObservabilityPipelineWebsocketSource(
+        Box<crate::datadogV2::model::ObservabilityPipelineWebsocketSource>,
+    ),
     ObservabilityPipelineOpentelemetrySource(
         Box<crate::datadogV2::model::ObservabilityPipelineOpentelemetrySource>,
     ),
@@ -234,6 +237,16 @@ impl<'de> Deserialize<'de> for ObservabilityPipelineConfigSourceItem {
                 );
             }
         }
+        if let Ok(_v) = serde_json::from_value::<
+            Box<crate::datadogV2::model::ObservabilityPipelineWebsocketSource>,
+        >(value.clone())
+        {
+            if !_v._unparsed {
+                return Ok(
+                    ObservabilityPipelineConfigSourceItem::ObservabilityPipelineWebsocketSource(_v),
+                );
+            }
+        }
         if let Ok(_v) = serde_json::from_value::<
             Box<crate::datadogV2::model::ObservabilityPipelineOpentelemetrySource>,
         >(value.clone())