Add links to API reference documentation.

Daniel Abraham · copybara-github · commit 5d46d35ee5b1 · 2021-09-10T08:44:08.000-07:00
PiperOrigin-RevId: 395936333
diff --git a/detect/v2/cancel_retrohunt.py b/detect/v2/cancel_retrohunt.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for cancelling a retrohunt."""
+"""Executable and reusable sample for cancelling a retrohunt.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/detection-engine-api#cancelretrohunt
+"""
 
 import argparse
 
diff --git a/detect/v2/create_rule.py b/detect/v2/create_rule.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for creating a detection rule."""
+"""Executable and reusable sample for creating a detection rule.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/detection-engine-api#createrule
+"""
 
 import argparse
 import json
diff --git a/detect/v2/create_rule_version.py b/detect/v2/create_rule_version.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for creating a new rule version."""
+"""Executable and reusable sample for creating a new rule version.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/detection-engine-api#createruleversion
+"""
 
 import argparse
 from typing import Any, Mapping
diff --git a/detect/v2/delete_rule.py b/detect/v2/delete_rule.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for deleting a detection rule."""
+"""Executable and reusable sample for deleting a detection rule.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/detection-engine-api#deleterule
+"""
 
 import argparse
 
diff --git a/detect/v2/disable_alerting.py b/detect/v2/disable_alerting.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for disabling alerting for a rule."""
+"""Executable and reusable sample for disabling alerting for a rule.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/detection-engine-api#disablealerting
+"""
 
 import argparse
 
diff --git a/detect/v2/disable_live_rule.py b/detect/v2/disable_live_rule.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for disabling a live rule."""
+"""Executable and reusable sample for disabling a live rule.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/detection-engine-api#disableliverule
+"""
 
 import argparse
 
diff --git a/detect/v2/enable_alerting.py b/detect/v2/enable_alerting.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for enabling alerting for a detection rule."""
+"""Executable and reusable sample for enabling alerting for a detection rule.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/detection-engine-api#enablealerting
+"""
 
 import argparse
 
diff --git a/detect/v2/enable_live_rule.py b/detect/v2/enable_live_rule.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for enabling a live detection rule."""
+"""Executable and reusable sample for enabling a live detection rule.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/detection-engine-api#enableliverule
+"""
 
 import argparse
 
diff --git a/detect/v2/get_detection.py b/detect/v2/get_detection.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for retrieving detection."""
+"""Executable and reusable sample for retrieving detection.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/detection-engine-api#getdetection
+"""
 
 import argparse
 import json
diff --git a/detect/v2/get_error.py b/detect/v2/get_error.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for retrieving an error."""
+"""Executable and reusable sample for retrieving an error.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/detection-engine-api#geterror
+"""
 
 import argparse
 import json
diff --git a/detect/v2/get_retrohunt.py b/detect/v2/get_retrohunt.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for retrieving a retrohunt."""
+"""Executable and reusable sample for retrieving a retrohunt.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/detection-engine-api#getretrohunt
+"""
 
 import argparse
 import json
diff --git a/detect/v2/get_rule.py b/detect/v2/get_rule.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for retrieving a detection rule."""
+"""Executable and reusable sample for retrieving a detection rule.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/detection-engine-api#getrule
+"""
 
 import argparse
 import json
diff --git a/detect/v2/list_detections.py b/detect/v2/list_detections.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for listing detections."""
+"""Executable and reusable sample for listing detections.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/detection-engine-api#listdetections
+"""
 
 import argparse
 import datetime
diff --git a/detect/v2/list_errors.py b/detect/v2/list_errors.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for listing detection rule errors."""
+"""Executable and reusable sample for listing detection rule errors.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/detection-engine-api#listerrors
+"""
 
 import argparse
 import datetime
diff --git a/detect/v2/list_retrohunts.py b/detect/v2/list_retrohunts.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for listing retrohunts."""
+"""Executable and reusable sample for listing retrohunts.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/detection-engine-api#listretrohunts
+"""
 
 import argparse
 import json
diff --git a/detect/v2/list_rule_versions.py b/detect/v2/list_rule_versions.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for listing versions of a detection rule."""
+"""Executable and reusable sample for listing versions of a detection rule.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/detection-engine-api#listruleversions
+"""
 
 import argparse
 import json
diff --git a/detect/v2/list_rules.py b/detect/v2/list_rules.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for listing detection rules."""
+"""Executable and reusable sample for listing detection rules.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/detection-engine-api#listrules
+"""
 
 import argparse
 import json
diff --git a/detect/v2/run_retrohunt.py b/detect/v2/run_retrohunt.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for running a retrohunt."""
+"""Executable and reusable sample for running a retrohunt.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/detection-engine-api#runretrohunt
+"""
 
 import argparse
 import datetime
diff --git a/detect/v2/stream_detection_alerts.py b/detect/v2/stream_detection_alerts.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for streaming detection alerts."""
+"""Executable and reusable sample for streaming detection alerts.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/detection-engine-api#streamdetectionalerts
+"""
 
 import argparse
 import collections
diff --git a/detect/v2/stream_test_rule.py b/detect/v2/stream_test_rule.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for testing a rule without persisting results."""
+"""Executable and reusable sample for testing a rule without persisting results.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/detection-engine-api#streamtestrule
+"""
 
 import argparse
 import datetime
diff --git a/detect/v2/verify_rule.py b/detect/v2/verify_rule.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for verifying a detection rule."""
+"""Executable and reusable sample for verifying a detection rule.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/detection-engine-api#verifyrule
+"""
 
 import argparse
 import json
diff --git a/ingestion/create_udm_events.py b/ingestion/create_udm_events.py
@@ -33,6 +33,10 @@
 $ create_udm_events --customer_id=<your customer UUID> \
   --json_events_file=./example_input/sample_udm_events.json
 
+API reference:
+https://cloud.google.com/chronicle/docs/reference/ingestion-api#udmevents
+https://cloud.google.com/chronicle/docs/reference/udm-field-list
+https://cloud.google.com/chronicle/docs/unified-data-model/udm-usage
 """
 
 import argparse
diff --git a/ingestion/create_unstructured_log_entries.py b/ingestion/create_unstructured_log_entries.py
@@ -28,6 +28,8 @@
   --log_type=BIND_DNS \
   --logs_file=./example_input/sample_unstructured_log_entries.txt
 
+API reference:
+https://cloud.google.com/chronicle/docs/reference/ingestion-api#unstructuredlogentries
 """
 
 import argparse
diff --git a/ingestion/list_log_types.py b/ingestion/list_log_types.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for listing supported log types."""
+"""Executable and reusable sample for listing supported log types.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/ingestion-api#logtypes
+"""
 
 import argparse
 import json
diff --git a/search/list_alerts.py b/search/list_alerts.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for listing asset- and user-based alerts."""
+"""Executable and reusable sample for listing asset- and user-based alerts.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/search-api#listalerts
+"""
 
 import argparse
 import datetime
diff --git a/search/list_iocs.py b/search/list_iocs.py
@@ -14,7 +14,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-"""Executable and reusable sample for listing Indications of Compromise."""
+"""Executable and reusable sample for listing Indications of Compromise.
+
+API reference:
+https://cloud.google.com/chronicle/docs/reference/search-api#listiocs
+"""
 
 import argparse
 import datetime
