docs: clarify descriptions of the AdvancedSettings and WebhookRequest…

… data types (#501) - [ ] Regenerate this pull request now. PiperOrigin-RevId: 458000126 Source-Link: googleapis/googleapis@c425ac6 Source-Link: https://github.com/googleapis/googleapis-gen/commit/1b0446dbaba086f1bf64d976b180d6ab6f338eb6 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMWIwNDQ2ZGJhYmEwODZmMWJmNjRkOTc2YjE4MGQ2YWI2ZjMzOGViNiJ9
googleapis · Jun 30, 2022 · d3fca46 · d3fca46
1 parent 1a1578d
commit d3fca46
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 3 deletions.
diff --git a/...low-cx-v3beta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/AdvancedSettings.java b/...low-cx-v3beta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/AdvancedSettings.java
@@ -24,7 +24,12 @@
  * <pre>
  * Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
  * Settings exposed at lower level overrides the settings exposed at higher
- * level.
+ * level. Overriding occurs at the sub-setting level. For example, the
+ * playback_interruption_settings at fulfillment level only overrides the
+ * playback_interruption_settings at the agent level, leaving other settings
+ * at the agent level unchanged.
+ * DTMF settings does not override each other. DTMF settings set at different
+ * levels define DTMF detections running in parallel.
  * Hierarchy: Agent-&gt;Flow-&gt;Page-&gt;Fulfillment/Parameter.
  * </pre>
  *
@@ -1041,7 +1046,12 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
    * <pre>
    * Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
    * Settings exposed at lower level overrides the settings exposed at higher
-   * level.
+   * level. Overriding occurs at the sub-setting level. For example, the
+   * playback_interruption_settings at fulfillment level only overrides the
+   * playback_interruption_settings at the agent level, leaving other settings
+   * at the agent level unchanged.
+   * DTMF settings does not override each other. DTMF settings set at different
+   * levels define DTMF detections running in parallel.
    * Hierarchy: Agent-&gt;Flow-&gt;Page-&gt;Fulfillment/Parameter.
    * </pre>
    *

diff --git a/...gflow-cx-v3beta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/WebhookRequest.java b/...gflow-cx-v3beta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/WebhookRequest.java
@@ -24,6 +24,8 @@
  * <pre>
  * The request message for a webhook call. The request is sent as a JSON object
  * and the field names will be presented in camel cases.
+ * You may see undocumented fields in an actual request. These fields are used
+ * internally by Dialogflow and should be ignored.
  * </pre>
  *
  * Protobuf type {@code google.cloud.dialogflow.cx.v3beta1.WebhookRequest}
@@ -5458,6 +5460,8 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
    * <pre>
    * The request message for a webhook call. The request is sent as a JSON object
    * and the field names will be presented in camel cases.
+   * You may see undocumented fields in an actual request. These fields are used
+   * internally by Dialogflow and should be ignored.
    * </pre>
    *
    * Protobuf type {@code google.cloud.dialogflow.cx.v3beta1.WebhookRequest}

diff --git a/...flow-cx-v3beta1/src/main/proto/google/cloud/dialogflow/cx/v3beta1/advanced_settings.proto b/...flow-cx-v3beta1/src/main/proto/google/cloud/dialogflow/cx/v3beta1/advanced_settings.proto
@@ -29,7 +29,13 @@ option ruby_package = "Google::Cloud::Dialogflow::CX::V3beta1";
 
 // Hierarchical advanced settings for agent/flow/page/fulfillment/parameter.
 // Settings exposed at lower level overrides the settings exposed at higher
-// level.
+// level. Overriding occurs at the sub-setting level. For example, the
+// playback_interruption_settings at fulfillment level only overrides the
+// playback_interruption_settings at the agent level, leaving other settings
+// at the agent level unchanged.
+//
+// DTMF settings does not override each other. DTMF settings set at different
+// levels define DTMF detections running in parallel.
 //
 // Hierarchy: Agent->Flow->Page->Fulfillment/Parameter.
 message AdvancedSettings {

diff --git a/...oud-dialogflow-cx-v3beta1/src/main/proto/google/cloud/dialogflow/cx/v3beta1/webhook.proto b/...oud-dialogflow-cx-v3beta1/src/main/proto/google/cloud/dialogflow/cx/v3beta1/webhook.proto
@@ -273,6 +273,9 @@ message DeleteWebhookRequest {
 
 // The request message for a webhook call. The request is sent as a JSON object
 // and the field names will be presented in camel cases.
+//
+// You may see undocumented fields in an actual request. These fields are used
+// internally by Dialogflow and should be ignored.
 message WebhookRequest {
   // Represents fulfillment information communicated to the webhook.
   message FulfillmentInfo {