docs: clarified some LRO types

docs: fixed some wrong update mask descriptions PiperOrigin-RevId: 394033461
googleapis · Aug 31, 2021 · aa15f32 · aa15f32
1 parent 2127126
commit aa15f32
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 4 deletions.
diff --git a/google/cloud/dialogflow/cx/v3beta1/BUILD.bazel b/google/cloud/dialogflow/cx/v3beta1/BUILD.bazel
@@ -91,12 +91,18 @@ java_grpc_library(
 java_gapic_library(
     name = "cx_java_gapic",
     srcs = [":cx_proto_with_info"],
+    gapic_yaml = None,
     grpc_service_config = "dialogflow_grpc_service_config.json",
+    service_yaml = "dialogflow_v3beta1.yaml",
     test_deps = [
         ":cx_java_grpc",
+        "//google/cloud/location:location_java_grpc",
     ],
     deps = [
         ":cx_java_proto",
+        "//google/api:api_java_proto",
+        "//google/cloud/location:location_java_grpc",
+        "//google/cloud/location:location_java_proto",
     ],
 )
 
@@ -129,6 +135,9 @@ java_gapic_assembly_gradle_pkg(
         ":cx_java_grpc",
         ":cx_java_proto",
         ":cx_proto",
+        "//google/cloud/location:location_java_grpc",
+        "//google/cloud/location:location_java_proto",
+        "//google/cloud/location:location_proto",
     ],
 )
 
@@ -165,6 +174,7 @@ go_gapic_library(
     service_yaml = "dialogflow_v3beta1.yaml",
     deps = [
         ":cx_go_proto",
+        "//google/cloud/location:location_go_proto",
         "//google/longrunning:longrunning_go_proto",
         "@com_google_cloud_go//longrunning:go_default_library",
         "@com_google_cloud_go//longrunning/autogen:go_default_library",

diff --git a/google/cloud/dialogflow/cx/v3beta1/agent.proto b/google/cloud/dialogflow/cx/v3beta1/agent.proto
@@ -94,6 +94,13 @@ service Agents {
   }
 
   // Exports the specified agent to a binary file.
+  // This method is a [long-running
+  // operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
+  // The returned `Operation` type has the following method-specific fields:
+  //
+  // - `metadata`: An empty [Struct
+  //   message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+  // - `response`: [ExportAgentResponse][google.cloud.dialogflow.cx.v3beta1.ExportAgentResponse]
   rpc ExportAgent(ExportAgentRequest) returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v3beta1/{name=projects/*/locations/*/agents/*}:export"

diff --git a/google/cloud/dialogflow/cx/v3beta1/audio_config.proto b/google/cloud/dialogflow/cx/v3beta1/audio_config.proto
@@ -19,6 +19,7 @@ package google.cloud.dialogflow.cx.v3beta1;
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
 import "google/api/annotations.proto";
 
 option cc_enable_arenas = true;

diff --git a/google/cloud/dialogflow/cx/v3beta1/flow.proto b/google/cloud/dialogflow/cx/v3beta1/flow.proto
@@ -420,9 +420,9 @@ message UpdateFlowRequest {
   // Required. The flow to update.
   Flow flow = 1 [(google.api.field_behavior) = REQUIRED];
 
-  // Required. The mask to control which fields get updated. If `update_mask` is not
-  // specified, an error will be returned.
-  google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+  // The mask to control which fields get updated. If the mask is not present,
+  // all fields will be updated.
+  google.protobuf.FieldMask update_mask = 2;
 
   // The language of the following fields in `flow`:
   //

diff --git a/google/cloud/dialogflow/cx/v3beta1/test_case.proto b/google/cloud/dialogflow/cx/v3beta1/test_case.proto
@@ -94,6 +94,12 @@ service TestCases {
   }
 
   // Kicks off a test case run.
+  // This method is a [long-running
+  // operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
+  // The returned `Operation` type has the following method-specific fields:
+  //
+  // - `metadata`: [RunTestCaseMetadata][google.cloud.dialogflow.cx.v3beta1.RunTestCaseMetadata]
+  // - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse]
   rpc RunTestCase(RunTestCaseRequest) returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v3beta1/{name=projects/*/locations/*/agents/*/testCases/*}:run"
@@ -284,7 +290,7 @@ message ConversationTurn {
 
     // Required. Input only. The diagnostic
     // [info][Session.DetectIntentResponse.QueryResult.diagnostic_info]
-    // output for the turn.
+    // output for the turn. Required to calculate the testing coverage.
     google.protobuf.Struct diagnostic_info = 6 [
       (google.api.field_behavior) = REQUIRED,
       (google.api.field_behavior) = INPUT_ONLY
@@ -635,6 +641,7 @@ message RunTestCaseResponse {
 }
 
 // Metadata returned for the [TestCases.RunTestCase][google.cloud.dialogflow.cx.v3beta1.TestCases.RunTestCase] long running operation.
+// This message currently has no fields.
 message RunTestCaseMetadata {
 
 }