docs: properly format literal strings. (#333)

PiperOrigin-RevId: 313202929 Source-Author: Google APIs <noreply@google.com> Source-Date: Tue May 26 09:12:28 2020 -0700 Source-Repo: googleapis/googleapis Source-Sha: f563b1dffee42be2f61c326c39af4974c1984278 Source-Link: googleapis/googleapis@f563b1d
googleapis · May 27, 2020 · a742034 · a742034
1 parent 81366f5
commit a742034
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 22 deletions.
diff --git a/packages/google-cloud-asset/protos/google/cloud/asset/v1/assets.proto b/packages/google-cloud-asset/protos/google/cloud/asset/v1/assets.proto
@@ -48,7 +48,7 @@ message TemporalAsset {
  Asset asset = 3;
 }
 
-// A time window specified by its "start_time" and "end_time".
+// A time window specified by its `start_time` and `end_time`.
 message TimeWindow {
  // Start time of the time window (exclusive).
  google.protobuf.Timestamp start_time = 1;
@@ -70,14 +70,14 @@ message Asset {
  };
 
  // The full name of the asset. For example:
- // "//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1"
+ // `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`
  //
  // See [Resource
  // names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
  // for more information.
  string name = 1;
 
- // The type of the asset. For example: "compute.googleapis.com/Disk"
+ // The type of the asset. For example: `compute.googleapis.com/Disk`
  //
  // See [Supported asset
  // types](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
@@ -128,27 +128,27 @@ message Asset {
 
 // A representation of a Google Cloud resource.
 message Resource {
- // The API version. For example: "v1"
+ // The API version. For example: `v1`
  string version = 1;
 
  // The URL of the discovery document containing the resource's JSON schema.
  // For example:
- // "https://www.googleapis.com/discovery/v1/apis/compute/v1/rest"
+ // `https://www.googleapis.com/discovery/v1/apis/compute/v1/rest`
  //
  // This value is unspecified for resources that do not have an API based on a
  // discovery document, such as Cloud Bigtable.
  string discovery_document_uri = 2;
 
  // The JSON schema name listed in the discovery document. For example:
- // "Project"
+ // `Project`
  //
  // This value is unspecified for resources that do not have an API based on a
  // discovery document, such as Cloud Bigtable.
  string discovery_name = 3;
 
  // The REST URL for accessing the resource. An HTTP `GET` request using this
  // URL returns the resource itself. For example:
- // "https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123"
+ // `https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123`
  //
  // This value is unspecified for resources without a REST API.
  string resource_url = 4;
@@ -162,7 +162,7 @@ message Resource {
  // [Cloud IAM policy
  // hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy).
  // For example:
- // "//cloudresourcemanager.googleapis.com/projects/my_project_123"
+ // `//cloudresourcemanager.googleapis.com/projects/my_project_123`
  //
  // For third-party assets, this field may be set differently.
  string parent = 5;
@@ -179,7 +179,7 @@ message Resource {
 // A result of Resource Search, containing information of a cloud resoure.
 message ResourceSearchResult {
  // The full resource name of this resource. Example:
- // "//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1".
+ // `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
  // See [Cloud Asset Inventory Resource Name
  // Format](https://cloud.google.com/asset-inventory/docs/resource-name-format)
  // for more information.
@@ -190,7 +190,7 @@ message ResourceSearchResult {
  // * use a free text query. Example: `"instance1"`
  string name = 1;
 
- // The type of this resource. Example: "compute.googleapis.com/Disk".
+ // The type of this resource. Example: `compute.googleapis.com/Disk`.
  //
  // To search against the `asset_type`:
  //
@@ -222,8 +222,8 @@ message ResourceSearchResult {
  // * use a free text query. Example: `"*important instance*"`
  string description = 5;
 
- // Location can be "global", regional like "us-east1", or zonal like
- // "us-west1-b".
+ // Location can be `global`, regional like `us-east1`, or zonal like
+ // `us-west1-b`.
  //
  // To search against the `location`:
  //
@@ -256,13 +256,13 @@ message ResourceSearchResult {
  repeated string network_tags = 8;
 
  // The additional attributes of this resource. The attributes may vary from
- // one resource type to another. Examples: "projectId" for Project,
- // "dnsName" for DNS ManagedZone.
+ // one resource type to another. Examples: `projectId` for Project,
+ // `dnsName` for DNS ManagedZone.
  //
  // To search against the `additional_attributes`:
  //
  // * use a free text query to match the attributes values. Example: to search
- // additional_attributes = { dnsName: "foobar" }, you can issue a query
+ // `additional_attributes = { dnsName: "foobar" }`, you can issue a query
  // `"foobar"`.
  google.protobuf.Struct additional_attributes = 9;
 }
@@ -273,23 +273,23 @@ message IamPolicySearchResult {
  message Explanation {
  // IAM permissions
  message Permissions {
- // A list of permissions. A sample permission string: "compute.disk.get".
+ // A list of permissions. A sample permission string: `compute.disk.get`.
  repeated string permissions = 1;
  }
 
  // The map from roles to their included permissions that match the
  // permission query (i.e., a query containing `policy.role.permissions:`).
  // Example: if query `policy.role.permissions : "compute.disk.get"`
  // matches a policy binding that contains owner role, the
- // matched_permissions will be {"roles/owner": ["compute.disk.get"]}. The
+ // matched_permissions will be `{"roles/owner": ["compute.disk.get"]}`. The
  // roles can also be found in the returned `policy` bindings. Note that the
  // map is populated only for requests with permission queries.
  map<string, Permissions> matched_permissions = 1;
  }
 
  // The full resource name of the resource associated with this IAM policy.
  // Example:
- // "//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1".
+ // `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
  // See [Cloud Asset Inventory Resource Name
  // Format](https://cloud.google.com/asset-inventory/docs/resource-name-format)
  // for more information.

diff --git a/packages/google-cloud-asset/synth.metadata b/packages/google-cloud-asset/synth.metadata
@@ -3,16 +3,16 @@
  {
  "git": {
  "name": ".",
- "remote": "git@github.com:googleapis/nodejs-asset.git",
- "sha": "238c11abedd65bc896762383a753e3c9bc4acddf"
+ "remote": "https://github.com/googleapis/nodejs-asset.git",
+ "sha": "2f896c4fc347823549bd0b38df39fa30c25663bc"
  }
  },
  {
  "git": {
  "name": "googleapis",
  "remote": "https://github.com/googleapis/googleapis.git",
- "sha": "cdf59a76184d5ddc24531f41567cf2411ae74593",
- "internalRef": "312479172"
+ "sha": "f563b1dffee42be2f61c326c39af4974c1984278",
+ "internalRef": "313202929"
  }
  },
  {