diff --git a/monitoring/api/v3/alerts-client/README.rst b/monitoring/api/v3/alerts-client/README.rst index 68eba2344eb6..b071aa139210 100644 --- a/monitoring/api/v3/alerts-client/README.rst +++ b/monitoring/api/v3/alerts-client/README.rst @@ -14,6 +14,11 @@ This directory contains samples for Google Stackdriver Alerting API. Stackdriver .. _Google Stackdriver Alerting API: https://cloud.google.com/monitoring/alerts/ +To run the sample, you need to enable the API at: https://console.cloud.google.com/apis/library/monitoring.googleapis.com + +To run the sample, you need to have `Monitoring Admin` role. + + Setup ------------------------------------------------------------------------------- @@ -87,7 +92,21 @@ To run this sample: list-alert-policies list-notification-channels enable-alert-policies + Enable or disable alert policies in a project. + Arguments: project_name (str) enable (bool): Enable or + disable the policies. filter_ (str, optional): Only + enable/disable alert policies that match this filter_. + See + https://cloud.google.com/monitoring/api/v3/sorting- + and-filtering disable-alert-policies + Enable or disable alert policies in a project. + Arguments: project_name (str) enable (bool): Enable or + disable the policies. filter_ (str, optional): Only + enable/disable alert policies that match this filter_. + See + https://cloud.google.com/monitoring/api/v3/sorting- + and-filtering replace-notification-channels backup restore @@ -114,4 +133,4 @@ to `browse the source`_ and `report issues`_. https://github.com/GoogleCloudPlatform/google-cloud-python/issues -.. _Google Cloud SDK: https://cloud.google.com/sdk/ \ No newline at end of file +.. _Google Cloud SDK: https://cloud.google.com/sdk/ diff --git a/monitoring/api/v3/alerts-client/README.rst.in b/monitoring/api/v3/alerts-client/README.rst.in index ed7f6a3bcf1e..9fed59a6f432 100644 --- a/monitoring/api/v3/alerts-client/README.rst.in +++ b/monitoring/api/v3/alerts-client/README.rst.in @@ -12,6 +12,9 @@ product: and many others. Stackdriver's Alerting API allows you to create, delete, and make back up copies of your alert policies. +required_api_url: https://pantheon.corp.google.com/apis/library/monitoring.googleapis.com +required_role: Monitoring Admin + setup: - auth - install_deps @@ -23,4 +26,4 @@ samples: cloud_client_library: true -folder: monitoring/api/v3/alerts-client \ No newline at end of file +folder: monitoring/api/v3/alerts-client diff --git a/scripts/readme-gen/templates/README.tmpl.rst b/scripts/readme-gen/templates/README.tmpl.rst index 2314d7fc560b..11a191e9d183 100644 --- a/scripts/readme-gen/templates/README.tmpl.rst +++ b/scripts/readme-gen/templates/README.tmpl.rst @@ -15,6 +15,15 @@ This directory contains samples for {{product.name}}. {{product.description}} .. _{{product.name}}: {{product.url}} +{% if required_api_url %} +To run the sample, you need to enable the API at: {{required_api_url}} +{% endif %} + +{% if required_role %} +To run the sample, you need to have `{{required_role}}` role. +{% endif %} + + {% if setup %} Setup -------------------------------------------------------------------------------