From dc9821e4005ff8fecc3bfccae1c61b5815cdf9d3 Mon Sep 17 00:00:00 2001 From: Google APIs Date: Wed, 20 Jan 2021 09:24:51 -0800 Subject: [PATCH] docs: Put resource paths in code spans and use absolute URLs PiperOrigin-RevId: 352807727 --- google/cloud/retail/v2/import_config.proto | 15 ++++++++------- google/cloud/retail/v2/product.proto | 4 ++-- google/cloud/retail/v2/product_service.proto | 6 +++--- google/cloud/retail/v2/user_event_service.proto | 6 +++--- 4 files changed, 16 insertions(+), 15 deletions(-) diff --git a/google/cloud/retail/v2/import_config.proto b/google/cloud/retail/v2/import_config.proto index cece6d5d..3d4c2686 100644 --- a/google/cloud/retail/v2/import_config.proto +++ b/google/cloud/retail/v2/import_config.proto @@ -38,10 +38,11 @@ option ruby_package = "Google::Cloud::Retail::V2"; message GcsSource { // Required. Google Cloud Storage URIs to input files. URI can be up to // 2000 characters long. URIs can match the full object path (for example, - // gs://bucket/directory/object.json) or a pattern matching one or more - // files, such as gs://bucket/directory/*.json. A request can + // `gs://bucket/directory/object.json`) or a pattern matching one or more + // files, such as `gs://bucket/directory/*.json`. A request can // contain at most 100 files, and each file can be up to 2 GB. See - // [Importing product information](/recommendations-ai/docs/upload-catalog) + // [Importing product + // information](https://cloud.google.com/recommendations-ai/docs/upload-catalog) // for the expected file format and setup instructions. repeated string input_uris = 1 [(google.api.field_behavior) = REQUIRED]; @@ -53,7 +54,7 @@ message GcsSource { // per line. Each product must // have a valid [Product.id][google.cloud.retail.v2.Product.id]. // * `product_merchant_center`: See [Importing catalog data from Merchant - // Center](/retail/recommendations-ai/docs/upload-catalog#mc). + // Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). // // Supported values for user events imports: // @@ -92,7 +93,7 @@ message BigQuerySource { // per line. Each product must // have a valid [Product.id][google.cloud.retail.v2.Product.id]. // * `product_merchant_center`: See [Importing catalog data from Merchant - // Center](/retail/recommendations-ai/docs/upload-catalog#mc). + // Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). // // Supported values for user events imports: // @@ -132,7 +133,7 @@ message ImportErrorsConfig { // Request message for Import methods. message ImportProductsRequest { // Required. - // "projects/1234/locations/global/catalogs/default_catalog/branches/default_branch" + // `projects/1234/locations/global/catalogs/default_catalog/branches/default_branch` // // If no updateMask is specified, requires products.create permission. // If updateMask is specified, requires products.update permission. @@ -151,7 +152,7 @@ message ImportProductsRequest { // Request message for the ImportUserEvents request. message ImportUserEventsRequest { - // Required. "projects/1234/locations/global/catalogs/default_catalog" + // Required. `projects/1234/locations/global/catalogs/default_catalog` string parent = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The desired input location of the data. diff --git a/google/cloud/retail/v2/product.proto b/google/cloud/retail/v2/product.proto index 0d2cece6..d93b0717 100644 --- a/google/cloud/retail/v2/product.proto +++ b/google/cloud/retail/v2/product.proto @@ -101,7 +101,7 @@ message Product { } // Immutable. Full resource name of the product, such as - // "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id". + // `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`. // // The branch ID must be "default_branch". string name = 1 [(google.api.field_behavior) = IMMUTABLE]; @@ -110,7 +110,7 @@ message Product { // the final component of [name][google.cloud.retail.v2.Product.name]. For // example, this field is "id_1", if // [name][google.cloud.retail.v2.Product.name] is - // "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/id_1". + // `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/id_1`. // // This field must be a UTF-8 encoded string with a length limit of 128 // characters. Otherwise, an INVALID_ARGUMENT error is returned. diff --git a/google/cloud/retail/v2/product_service.proto b/google/cloud/retail/v2/product_service.proto index 2c659064..b4130502 100644 --- a/google/cloud/retail/v2/product_service.proto +++ b/google/cloud/retail/v2/product_service.proto @@ -100,7 +100,7 @@ service ProductService { // Request message for [CreateProduct][] method. message CreateProductRequest { // Required. The parent catalog resource name, such as - // "projects/*/locations/global/catalogs/default_catalog/branches/default_branch". + // `projects/*/locations/global/catalogs/default_catalog/branches/default_branch`. string parent = 1 [ (google.api.field_behavior) = REQUIRED, (google.api.resource_reference) = { type: "retail.googleapis.com/Branch" } @@ -131,7 +131,7 @@ message CreateProductRequest { message GetProductRequest { // Required. Full resource name of [Product][google.cloud.retail.v2.Product], // such as - // "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id". + // `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. // // If the caller does not have permission to access the // [Product][google.cloud.retail.v2.Product], regardless of whether or not it @@ -171,7 +171,7 @@ message UpdateProductRequest { message DeleteProductRequest { // Required. Full resource name of [Product][google.cloud.retail.v2.Product], // such as - // "projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id". + // `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. // // If the caller does not have permission to delete the // [Product][google.cloud.retail.v2.Product], regardless of whether or not it diff --git a/google/cloud/retail/v2/user_event_service.proto b/google/cloud/retail/v2/user_event_service.proto index a73b63e1..4dbd1dc7 100644 --- a/google/cloud/retail/v2/user_event_service.proto +++ b/google/cloud/retail/v2/user_event_service.proto @@ -117,7 +117,7 @@ service UserEventService { // Request message for WriteUserEvent method. message WriteUserEventRequest { // Required. The parent catalog resource name, such as - // "projects/1234/locations/global/catalogs/default_catalog". + // `projects/1234/locations/global/catalogs/default_catalog`. string parent = 1 [(google.api.field_behavior) = REQUIRED]; // Required. User event to write. @@ -127,7 +127,7 @@ message WriteUserEventRequest { // Request message for CollectUserEvent method. message CollectUserEventRequest { // Required. The parent catalog name, such as - // "projects/1234/locations/global/catalogs/default_catalog". + // `projects/1234/locations/global/catalogs/default_catalog`. string parent = 1 [(google.api.field_behavior) = REQUIRED]; // Required. URL encoded UserEvent proto with a length limit of 2,000,000 @@ -168,7 +168,7 @@ message RejoinUserEventsRequest { } // Required. The parent catalog resource name, such as - // "projects/1234/locations/global/catalogs/default_catalog". + // `projects/1234/locations/global/catalogs/default_catalog`. string parent = 1 [(google.api.field_behavior) = REQUIRED]; // The type of the user event rejoin to define the scope and range of the user