From 6d008d29d1d2fcb8e6fa5823ef8a970bf5f2f3bd Mon Sep 17 00:00:00 2001 From: Google APIs Date: Mon, 1 Nov 2021 14:33:11 -0700 Subject: [PATCH] docs: fix docstring formatting Committer: @parthea PiperOrigin-RevId: 406921699 --- .../cloud/recommender/v1/recommendation.proto | 21 +++++++++++++------ .../recommender/v1/recommender_service.proto | 12 +++++------ .../recommender/v1beta1/recommendation.proto | 21 +++++++++++++------ .../v1beta1/recommender_service.proto | 12 +++++------ 4 files changed, 42 insertions(+), 24 deletions(-) diff --git a/google/cloud/recommender/v1/recommendation.proto b/google/cloud/recommender/v1/recommendation.proto index 78f8f10c27..8d75134d68 100644 --- a/google/cloud/recommender/v1/recommendation.proto +++ b/google/cloud/recommender/v1/recommendation.proto @@ -171,18 +171,27 @@ message Operation { // This is intended to be an exact match per filter. To perform advanced // matching, use path_value_matchers. // - // * Example: { + // * Example: + // ``` + // { // "/versions/*/name" : "it-123" // "/versions/*/targetSize/percent": 20 - // } - // * Example: { + // } + // ``` + // * Example: + // ``` + // { // "/bindings/*/role": "roles/owner" // "/bindings/*/condition" : null - // } - // * Example: { + // } + // ``` + // * Example: + // ``` + // { // "/bindings/*/role": "roles/owner" // "/bindings/*/members/*" : ["x@example.com", "y@example.com"] - // } + // } + // ``` // When both path_filters and path_value_matchers are set, an implicit AND // must be performed. map path_filters = 8; diff --git a/google/cloud/recommender/v1/recommender_service.proto b/google/cloud/recommender/v1/recommender_service.proto index f8816a9247..c6475eaa3c 100644 --- a/google/cloud/recommender/v1/recommender_service.proto +++ b/google/cloud/recommender/v1/recommender_service.proto @@ -374,8 +374,8 @@ message MarkRecommendationClaimedRequest { // State properties to include with this state. Overwrites any existing // `state_metadata`. - // Keys must match the regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. - // Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/. + // Keys must match the regex `/^[a-z0-9][a-z0-9_.-]{0,62}$/`. + // Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. map state_metadata = 2; // Required. Fingerprint of the Recommendation. Provides optimistic locking. @@ -394,8 +394,8 @@ message MarkRecommendationSucceededRequest { // State properties to include with this state. Overwrites any existing // `state_metadata`. - // Keys must match the regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. - // Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/. + // Keys must match the regex `/^[a-z0-9][a-z0-9_.-]{0,62}$/`. + // Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. map state_metadata = 2; // Required. Fingerprint of the Recommendation. Provides optimistic locking. @@ -414,8 +414,8 @@ message MarkRecommendationFailedRequest { // State properties to include with this state. Overwrites any existing // `state_metadata`. - // Keys must match the regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. - // Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/. + // Keys must match the regex `/^[a-z0-9][a-z0-9_.-]{0,62}$/`. + // Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. map state_metadata = 2; // Required. Fingerprint of the Recommendation. Provides optimistic locking. diff --git a/google/cloud/recommender/v1beta1/recommendation.proto b/google/cloud/recommender/v1beta1/recommendation.proto index 15b4ef3b9b..af4cf57d4b 100644 --- a/google/cloud/recommender/v1beta1/recommendation.proto +++ b/google/cloud/recommender/v1beta1/recommendation.proto @@ -171,18 +171,27 @@ message Operation { // This is intended to be an exact match per filter. To perform advanced // matching, use path_value_matchers. // - // * Example: { + // * Example: + // ``` + // { // "/versions/*/name" : "it-123" // "/versions/*/targetSize/percent": 20 - // } - // * Example: { + // } + // ``` + // * Example: + // ``` + // { // "/bindings/*/role": "roles/owner" // "/bindings/*/condition" : null - // } - // * Example: { + // } + // ``` + // * Example: + // ``` + // { // "/bindings/*/role": "roles/owner" // "/bindings/*/members/*" : ["x@example.com", "y@example.com"] - // } + // } + // ``` // When both path_filters and path_value_matchers are set, an implicit AND // must be performed. map path_filters = 8; diff --git a/google/cloud/recommender/v1beta1/recommender_service.proto b/google/cloud/recommender/v1beta1/recommender_service.proto index d502c0a382..47303f5b12 100644 --- a/google/cloud/recommender/v1beta1/recommender_service.proto +++ b/google/cloud/recommender/v1beta1/recommender_service.proto @@ -373,8 +373,8 @@ message MarkRecommendationClaimedRequest { // State properties to include with this state. Overwrites any existing // `state_metadata`. - // Keys must match the regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. - // Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/. + // Keys must match the regex `/^[a-z0-9][a-z0-9_.-]{0,62}$/`. + // Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. map state_metadata = 2; // Required. Fingerprint of the Recommendation. Provides optimistic locking. @@ -393,8 +393,8 @@ message MarkRecommendationSucceededRequest { // State properties to include with this state. Overwrites any existing // `state_metadata`. - // Keys must match the regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. - // Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/. + // Keys must match the regex `/^[a-z0-9][a-z0-9_.-]{0,62}$/`. + // Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. map state_metadata = 2; // Required. Fingerprint of the Recommendation. Provides optimistic locking. @@ -413,8 +413,8 @@ message MarkRecommendationFailedRequest { // State properties to include with this state. Overwrites any existing // `state_metadata`. - // Keys must match the regex /^[a-z0-9][a-z0-9_.-]{0,62}$/. - // Values must match the regex /^[a-zA-Z0-9_./-]{0,255}$/. + // Keys must match the regex `/^[a-z0-9][a-z0-9_.-]{0,62}$/`. + // Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`. map state_metadata = 2; // Required. Fingerprint of the Recommendation. Provides optimistic locking.