docs: Clarify maximum retention of backups (max 14 weeks)

Google APIs · copybara-github · commit 296afd14291c · 2024-08-29T10:39:23.000-07:00
docs: Remove note about backups running at a specific time
docs: Standardize on the capitalization of "ID"

PiperOrigin-RevId: 668987834
diff --git a/google/firestore/admin/v1/field.proto b/google/firestore/admin/v1/field.proto
@@ -32,7 +32,7 @@ option ruby_package = "Google::Cloud::Firestore::Admin::V1";
 // Represents a single field in the database.
 //
 // Fields are grouped by their "Collection Group", which represent all
-// collections in the database with the same id.
+// collections in the database with the same ID.
 message Field {
   option (google.api.resource) = {
     type: "firestore.googleapis.com/Field"
diff --git a/google/firestore/admin/v1/index.proto b/google/firestore/admin/v1/index.proto
@@ -44,11 +44,11 @@ message Index {
 
     // Indexes with a collection query scope specified allow queries
     // against a collection that is the child of a specific document, specified
-    // at query time, and that has the collection id specified by the index.
+    // at query time, and that has the collection ID specified by the index.
     COLLECTION = 1;
 
     // Indexes with a collection group query scope specified allow queries
-    // against all collections that has the collection id specified by the
+    // against all collections that has the collection ID specified by the
     // index.
     COLLECTION_GROUP = 2;
 
@@ -170,11 +170,11 @@ message Index {
 
   // Indexes with a collection query scope specified allow queries
   // against a collection that is the child of a specific document, specified at
-  // query time, and that has the same collection id.
+  // query time, and that has the same collection ID.
   //
   // Indexes with a collection group query scope specified allow queries against
   // all collections descended from a specific document, specified at query
-  // time, and that have the same collection id as this index.
+  // time, and that have the same collection ID as this index.
   QueryScope query_scope = 2;
 
   // The API scope supported by this index.
diff --git a/google/firestore/admin/v1/operation.proto b/google/firestore/admin/v1/operation.proto
@@ -146,13 +146,13 @@ message ExportDocumentsMetadata {
   // The progress, in bytes, of this operation.
   Progress progress_bytes = 5;
 
-  // Which collection ids are being exported.
+  // Which collection IDs are being exported.
   repeated string collection_ids = 6;
 
   // Where the documents are being exported to.
   string output_uri_prefix = 7;
 
-  // Which namespace ids are being exported.
+  // Which namespace IDs are being exported.
   repeated string namespace_ids = 8;
 
   // The timestamp that corresponds to the version of the database that is being
@@ -181,13 +181,13 @@ message ImportDocumentsMetadata {
   // The progress, in bytes, of this operation.
   Progress progress_bytes = 5;
 
-  // Which collection ids are being imported.
+  // Which collection IDs are being imported.
   repeated string collection_ids = 6;
 
   // The location of the documents being imported.
   string input_uri_prefix = 7;
 
-  // Which namespace ids are being imported.
+  // Which namespace IDs are being imported.
   repeated string namespace_ids = 8;
 }
 
@@ -211,10 +211,10 @@ message BulkDeleteDocumentsMetadata {
   // The progress, in bytes, of this operation.
   Progress progress_bytes = 5;
 
-  // The ids of the collection groups that are being deleted.
+  // The IDs of the collection groups that are being deleted.
   repeated string collection_ids = 6;
 
-  // Which namespace ids are being deleted.
+  // Which namespace IDs are being deleted.
   repeated string namespace_ids = 7;
 
   // The timestamp that corresponds to the version of the database that is being
diff --git a/google/firestore/admin/v1/schedule.proto b/google/firestore/admin/v1/schedule.proto
@@ -65,6 +65,8 @@ message BackupSchedule {
 
   // At what relative time in the future, compared to its creation time,
   // the backup should be deleted, e.g. keep backups for 7 days.
+  //
+  // The maximum supported retention period is 14 weeks.
   google.protobuf.Duration retention = 6;
 
   // A oneof field to represent when backups will be taken.
@@ -77,7 +79,7 @@ message BackupSchedule {
   }
 }
 
-// Represents a recurring schedule that runs at a specific time every day.
+// Represents a recurring schedule that runs every day.
 //
 // The time zone is UTC.
 message DailyRecurrence {}

Original file line number	Diff line number	Diff line change
`@@ -65,6 +65,8 @@ message BackupSchedule {`
`65`	`65`
`66`	`66`	`// At what relative time in the future, compared to its creation time,`
`67`	`67`	`// the backup should be deleted, e.g. keep backups for 7 days.`
	`68`	`+ //`
	`69`	`+ // The maximum supported retention period is 14 weeks.`
`68`	`70`	`google.protobuf.Duration retention = 6;`
`69`	`71`
`70`	`72`	`// A oneof field to represent when backups will be taken.`
`@@ -77,7 +79,7 @@ message BackupSchedule {`
`77`	`79`	`}`
`78`	`80`	`}`
`79`	`81`
`80`		`-// Represents a recurring schedule that runs at a specific time every day.`
	`82`	`+// Represents a recurring schedule that runs every day.`
`81`	`83`	`//`
`82`	`84`	`// The time zone is UTC.`
`83`	`85`	`message DailyRecurrence {}`