fix!: mark Document.Entity.type as REQUIRED in all versions

Google APIs · copybara-github · commit a0d4c5c2a714 · 2022-04-26T13:49:31.000-07:00
fix!: remove Document.Entity.bounding_poly_for_demo_frontend from v1beta2

The type field was always required by the backend, so this formally breaking change can likely be accepted without bumping the major version. Field removal is in beta version so can be accepted as well.

PiperOrigin-RevId: 444656928
diff --git a/google/cloud/documentai/v1/document.proto b/google/cloud/documentai/v1/document.proto
@@ -476,8 +476,8 @@ message Document {
     // [Document.text][google.cloud.documentai.v1.Document.text].
     TextAnchor text_anchor = 1 [(google.api.field_behavior) = OPTIONAL];
 
-    // Entity type from a schema e.g. `Address`.
-    string type = 2;
+    // Required. Entity type from a schema e.g. `Address`.
+    string type = 2 [(google.api.field_behavior) = REQUIRED];
 
     // Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If
     // the entity is not present in the document, this field will be empty.
diff --git a/google/cloud/documentai/v1beta1/document.proto b/google/cloud/documentai/v1beta1/document.proto
@@ -18,6 +18,7 @@ syntax = "proto3";
 package google.cloud.documentai.v1beta1;
 
 import "google/api/annotations.proto";
+import "google/api/field_behavior.proto";
 import "google/cloud/documentai/v1beta1/geometry.proto";
 import "google/rpc/status.proto";
 import "google/type/color.proto";
@@ -351,8 +352,8 @@ message Document {
     // [Document.text][google.cloud.documentai.v1beta1.Document.text].
     TextAnchor text_anchor = 1;
 
-    // Entity type from a schema e.g. `Address`.
-    string type = 2;
+    // Required. Entity type from a schema e.g. `Address`.
+    string type = 2 [(google.api.field_behavior) = REQUIRED];
 
     // Text value in the document e.g. `1600 Amphitheatre Pkwy`.
     string mention_text = 3;
diff --git a/google/cloud/documentai/v1beta2/document.proto b/google/cloud/documentai/v1beta2/document.proto
@@ -368,8 +368,8 @@ message Document {
     // Text anchor indexing into the [Document.text][google.cloud.documentai.v1beta2.Document.text].
     TextAnchor text_anchor = 1;
 
-    // Entity type from a schema e.g. `Address`.
-    string type = 2;
+    // Required. Entity type from a schema e.g. `Address`.
+    string type = 2 [(google.api.field_behavior) = REQUIRED];
 
     // Text value in the document e.g. `1600 Amphitheatre Pkwy`.
     string mention_text = 3;
@@ -387,10 +387,6 @@ message Document {
     // Optional. Canonical id. This will be a unique value in the entity list
     // for this document.
     string id = 7 [(google.api.field_behavior) = OPTIONAL];
-
-    // Optional. Temporary field to store the bounding poly for short-term POCs. Used by
-    // the frontend only. Do not use before you talk to ybo@ and lukasr@.
-    BoundingPoly bounding_poly_for_demo_frontend = 8 [(google.api.field_behavior) = OPTIONAL];
   }
 
   // Relationship between [Entities][google.cloud.documentai.v1beta2.Document.Entity].
diff --git a/google/cloud/documentai/v1beta3/document.proto b/google/cloud/documentai/v1beta3/document.proto
@@ -480,8 +480,8 @@ message Document {
     // [Document.text][google.cloud.documentai.v1beta3.Document.text].
     TextAnchor text_anchor = 1 [(google.api.field_behavior) = OPTIONAL];
 
-    // Entity type from a schema e.g. `Address`.
-    string type = 2;
+    // Required. Entity type from a schema e.g. `Address`.
+    string type = 2 [(google.api.field_behavior) = REQUIRED];
 
     // Optional. Text value in the document e.g. `1600 Amphitheatre Pkwy`. If
     // the entity is not present in the document, this field will be empty.
