Skip to content

Commit b4967c7

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs(filestore): Fix various formatting issues and broken links
PiperOrigin-RevId: 387410905
1 parent 26871a2 commit b4967c7

2 files changed

Lines changed: 64 additions & 71 deletions

File tree

‎google/cloud/filestore/v1/cloud_filestore_service.proto‎

Lines changed: 32 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ message NetworkConfig {
197197
}
198198

199199
// The name of the Google Compute Engine
200-
// [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
200+
// [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the
201201
// instance is connected.
202202
string network = 1;
203203

@@ -207,17 +207,17 @@ message NetworkConfig {
207207

208208
// A /29 CIDR block in one of the
209209
// [internal IP address
210-
// ranges](https://www.arin.net/knowledge/address_filters.html) that
211-
// identifies the range of IP addresses reserved for this instance. For
210+
// ranges](https://www.arin.net/reference/research/statistics/address_filters/)
211+
// that identifies the range of IP addresses reserved for this instance. For
212212
// example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap
213213
// with either existing subnets or assigned IP address ranges for other Cloud
214214
// Filestore instances in the selected VPC network.
215215
string reserved_ip_range = 4;
216216

217217
// Output only. IPv4 addresses in the format
218-
// {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format
219-
// {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block
220-
// 7}:{block 8}.
218+
// IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or
219+
// IPv6 addresses in the format
220+
// `{block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}`.
221221
repeated string ip_addresses = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
222222
}
223223

@@ -234,7 +234,7 @@ message FileShareConfig {
234234
// share is created from scratch.
235235
oneof source {
236236
// The resource name of the backup, in the format
237-
// projects/{project_number}/locations/{location_id}/backups/{backup_id},
237+
// `projects/{project_number}/locations/{location_id}/backups/{backup_id}`,
238238
// that this file share has been restored from.
239239
string source_backup = 8 [(google.api.resource_reference) = {
240240
type: "file.googleapis.com/Backup"
@@ -273,8 +273,8 @@ message NfsExportOptions {
273273
}
274274

275275
// List of either an IPv4 addresses in the format
276-
// {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format
277-
// {octet 1}.{octet 2}.{octet 3}.{octet 4}/{mask size} which may mount the
276+
// `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format
277+
// `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the
278278
// file share.
279279
// Overlapping IP ranges are not allowed, both within and across
280280
// NfsExportOptions. An error will be returned.
@@ -367,7 +367,7 @@ message Instance {
367367
}
368368

369369
// Output only. The resource name of the instance, in the format
370-
// projects/{project}/locations/{location}/instances/{instance}.
370+
// `projects/{project}/locations/{location}/instances/{instance}`.
371371
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
372372

373373
// The description of the instance (2048 characters or less).
@@ -407,7 +407,7 @@ message Instance {
407407
// CreateInstanceRequest creates an instance.
408408
message CreateInstanceRequest {
409409
// Required. The instance's project and location, in the format
410-
// projects/{project_id}/locations/{location}. In Cloud Filestore,
410+
// `projects/{project_id}/locations/{location}`. In Cloud Filestore,
411411
// locations map to GCP zones, for example **us-west1-b**.
412412
string parent = 1 [
413413
(google.api.field_behavior) = REQUIRED,
@@ -420,15 +420,14 @@ message CreateInstanceRequest {
420420
// The name must be unique for the specified project and location.
421421
string instance_id = 2 [(google.api.field_behavior) = REQUIRED];
422422

423-
// Required. A [instance resource]
424-
// (/cloud-filestore/reference/rest/v1/projects.locations.instances)
423+
// Required. An [instance resource][google.cloud.filestore.v1.Instance]
425424
Instance instance = 3 [(google.api.field_behavior) = REQUIRED];
426425
}
427426

428427
// GetInstanceRequest gets the state of an instance.
429428
message GetInstanceRequest {
430429
// Required. The instance resource name, in the format
431-
// projects/{project_id}/locations/{location}/instances/{instance_id}.
430+
// `projects/{project_id}/locations/{location}/instances/{instance_id}`.
432431
string name = 1 [
433432
(google.api.field_behavior) = REQUIRED,
434433
(google.api.resource_reference) = {
@@ -456,7 +455,7 @@ message UpdateInstanceRequest {
456455
// backup.
457456
message RestoreInstanceRequest {
458457
// Required. The resource name of the instance, in the format
459-
// projects/{project_number}/locations/{location_id}/instances/{instance_id}.
458+
// `projects/{project_number}/locations/{location_id}/instances/{instance_id}`.
460459
string name = 1 [
461460
(google.api.field_behavior) = REQUIRED,
462461
(google.api.resource_reference) = {
@@ -470,7 +469,7 @@ message RestoreInstanceRequest {
470469

471470
oneof source {
472471
// The resource name of the backup, in the format
473-
// projects/{project_number}/locations/{location_id}/backups/{backup_id}.
472+
// `projects/{project_number}/locations/{location_id}/backups/{backup_id}`.
474473
string source_backup = 3 [(google.api.resource_reference) = {
475474
type: "file.googleapis.com/Backup"
476475
}];
@@ -480,7 +479,7 @@ message RestoreInstanceRequest {
480479
// DeleteInstanceRequest deletes an instance.
481480
message DeleteInstanceRequest {
482481
// Required. The instance resource name, in the format
483-
// projects/{project_id}/locations/{location}/instances/{instance_id}
482+
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
484483
string name = 1 [
485484
(google.api.field_behavior) = REQUIRED,
486485
(google.api.resource_reference) = {
@@ -492,10 +491,10 @@ message DeleteInstanceRequest {
492491
// ListInstancesRequest lists instances.
493492
message ListInstancesRequest {
494493
// Required. The project and location for which to retrieve instance information,
495-
// in the format projects/{project_id}/locations/{location}. In Cloud
494+
// in the format `projects/{project_id}/locations/{location}`. In Cloud
496495
// Filestore, locations map to GCP zones, for example **us-west1-b**. To
497-
// retrieve instance information for all locations, use "-" for the {location}
498-
// value.
496+
// retrieve instance information for all locations, use "-" for the
497+
// `{location}` value.
499498
string parent = 1 [
500499
(google.api.field_behavior) = REQUIRED,
501500
(google.api.resource_reference) = {
@@ -521,8 +520,8 @@ message ListInstancesRequest {
521520
message ListInstancesResponse {
522521
// A list of instances in the project for the specified location.
523522
//
524-
// If the {location} value in the request is "-", the response contains a list
525-
// of instances from all locations. If any location is unreachable, the
523+
// If the `{location}` value in the request is "-", the response contains a
524+
// list of instances from all locations. If any location is unreachable, the
526525
// response will only return instances in reachable locations and the
527526
// "unreachable" field will be populated with a list of unreachable locations.
528527
repeated Instance instances = 1;
@@ -562,7 +561,7 @@ message Backup {
562561
}
563562

564563
// Output only. The resource name of the backup, in the format
565-
// projects/{project_number}/locations/{location_id}/backups/{backup_id}.
564+
// `projects/{project_number}/locations/{location_id}/backups/{backup_id}`.
566565
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
567566

568567
// A description of the backup with 2048 characters or less.
@@ -586,7 +585,7 @@ message Backup {
586585
int64 storage_bytes = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
587586

588587
// The resource name of the source Cloud Filestore instance, in the format
589-
// projects/{project_number}/locations/{location_id}/instances/{instance_id},
588+
// `projects/{project_number}/locations/{location_id}/instances/{instance_id}`,
590589
// used to create this backup.
591590
string source_instance = 8 [(google.api.resource_reference) = {
592591
type: "file.googleapis.com/Instance"
@@ -612,7 +611,7 @@ message Backup {
612611
// CreateBackupRequest creates a backup.
613612
message CreateBackupRequest {
614613
// Required. The backup's project and location, in the format
615-
// projects/{project_number}/locations/{location}. In Cloud Filestore,
614+
// `projects/{project_number}/locations/{location}`. In Cloud Filestore,
616615
// backup locations map to GCP regions, for example **us-west1**.
617616
string parent = 1 [
618617
(google.api.field_behavior) = REQUIRED,
@@ -621,8 +620,7 @@ message CreateBackupRequest {
621620
}
622621
];
623622

624-
// Required. A [backup resource]
625-
// (/cloud-filestore/reference/rest/v1/projects.locations.backups)
623+
// Required. A [backup resource][google.cloud.filestore.v1.Backup]
626624
Backup backup = 2 [(google.api.field_behavior) = REQUIRED];
627625

628626
// Required. The ID to use for the backup.
@@ -638,7 +636,7 @@ message CreateBackupRequest {
638636
// DeleteBackupRequest deletes a backup.
639637
message DeleteBackupRequest {
640638
// Required. The backup resource name, in the format
641-
// projects/{project_number}/locations/{location}/backups/{backup_id}
639+
// `projects/{project_number}/locations/{location}/backups/{backup_id}`
642640
string name = 1 [
643641
(google.api.field_behavior) = REQUIRED,
644642
(google.api.resource_reference) = {
@@ -649,8 +647,7 @@ message DeleteBackupRequest {
649647

650648
// UpdateBackupRequest updates description and/or labels for a backup.
651649
message UpdateBackupRequest {
652-
// Required. A [backup resource]
653-
// (/cloud-filestore/reference/rest/v1/projects.locations.backups)
650+
// Required. A [backup resource][google.cloud.filestore.v1.Backup]
654651
Backup backup = 1 [(google.api.field_behavior) = REQUIRED];
655652

656653
// Required. Mask of fields to update. At least one path must be supplied in this
@@ -661,7 +658,7 @@ message UpdateBackupRequest {
661658
// GetBackupRequest gets the state of a backup.
662659
message GetBackupRequest {
663660
// Required. The backup resource name, in the format
664-
// projects/{project_number}/locations/{location}/backups/{backup_id}.
661+
// `projects/{project_number}/locations/{location}/backups/{backup_id}`.
665662
string name = 1 [
666663
(google.api.field_behavior) = REQUIRED,
667664
(google.api.resource_reference) = {
@@ -673,11 +670,11 @@ message GetBackupRequest {
673670
// ListBackupsRequest lists backups.
674671
message ListBackupsRequest {
675672
// Required. The project and location for which to retrieve backup information,
676-
// in the format projects/{project_number}/locations/{location}.
673+
// in the format `projects/{project_number}/locations/{location}`.
677674
// In Cloud Filestore, backup locations map to GCP regions,
678675
// for example **us-west1**.
679676
// To retrieve backup information for all locations, use "-" for the
680-
// {location} value.
677+
// `{location}` value.
681678
string parent = 1 [
682679
(google.api.field_behavior) = REQUIRED,
683680
(google.api.resource_reference) = {
@@ -703,8 +700,8 @@ message ListBackupsRequest {
703700
message ListBackupsResponse {
704701
// A list of backups in the project for the specified location.
705702
//
706-
// If the {location} value in the request is "-", the response contains a list
707-
// of backups from all locations. If any location is unreachable, the
703+
// If the `{location}` value in the request is "-", the response contains a
704+
// list of backups from all locations. If any location is unreachable, the
708705
// response will only return backups in reachable locations and the
709706
// "unreachable" field will be populated with a list of unreachable
710707
// locations.

0 commit comments

Comments
 (0)