docs: improve comments for protos (googleapis#503)

- [ ] Regenerate this pull request now. PiperOrigin-RevId: 458250124 Source-Link: googleapis/googleapis@913b9bd Source-Link: https://github.com/googleapis/googleapis-gen/commit/5601594f1cdf45d9df26f245604c333e3ff3838d Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNTYwMTU5NGYxY2RmNDVkOWRmMjZmMjQ1NjA0YzMzM2UzZmYzODM4ZCJ9
suztomo · Jul 1, 2022 · 442b14c · 442b14c
1 parent 4060e29
commit 442b14c
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 3 deletions.
diff --git a/...ud-dialogflow-cx-v3/src/main/java/com/google/cloud/dialogflow/cx/v3/AdvancedSettings.java b/...ud-dialogflow-cx-v3/src/main/java/com/google/cloud/dialogflow/cx/v3/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>
  *
@@ -1026,7 +1031,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/...loud-dialogflow-cx-v3/src/main/java/com/google/cloud/dialogflow/cx/v3/WebhookRequest.java b/...loud-dialogflow-cx-v3/src/main/java/com/google/cloud/dialogflow/cx/v3/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.v3.WebhookRequest}
@@ -5409,6 +5411,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.v3.WebhookRequest}

diff --git a/...oud-dialogflow-cx-v3/src/main/proto/google/cloud/dialogflow/cx/v3/advanced_settings.proto b/...oud-dialogflow-cx-v3/src/main/proto/google/cloud/dialogflow/cx/v3/advanced_settings.proto
@@ -29,7 +29,13 @@ option ruby_package = "Google::Cloud::Dialogflow::CX::V3";
 
 // 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/...-google-cloud-dialogflow-cx-v3/src/main/proto/google/cloud/dialogflow/cx/v3/webhook.proto b/...-google-cloud-dialogflow-cx-v3/src/main/proto/google/cloud/dialogflow/cx/v3/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 {