docs(json-specs): improve descriptions and examples

activemq_xml/changelog.d/20878.fixed

@@ -0,0 +1 @@
+Improve descriptions and examples

activemq_xml/datadog_checks/activemq_xml/data/conf.yaml.example

@@ -112,7 +112,7 @@ instances:
 
     ## @param auth_type - string - optional - default: basic
     ## The type of authentication to use. The available types (and related options) are:
-    ##
+    ## ```
     ##   - basic
     ##     |__ username
     ##     |__ password
@@ -135,7 +135,7 @@ instances:
     ##     |__ aws_region
     ##     |__ aws_host
     ##     |__ aws_service
-    ##
+    ## ```
     ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`.
     ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials
     #

aerospike/changelog.d/20878.fixed

@@ -0,0 +1 @@
+Improve descriptions and examples

aerospike/datadog_checks/aerospike/data/conf.yaml.example

@@ -63,30 +63,32 @@ instances:
     ##
     ## 1. If the item is a string, then it represents the exposed metric name, and
     ##    the sent metric name will be identical. For example:
-    ##
+    ##      ```
     ##      extra_metrics:
     ##      - <METRIC_1>
     ##      - <METRIC_2>
+    ##      ```
     ## 2. If the item is a mapping, then the keys represent the exposed metric names.
     ##
-    ##      a. If a value is a string, then it represents the sent metric name. For example:
-    ##
+    ##      1. If a value is a string, then it represents the sent metric name. For example:
+    ##           ```
     ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>: <SENT_METRIC_1>
     ##           - <EXPOSED_METRIC_2>: <SENT_METRIC_2>
-    ##      b. If a value is a mapping, then it must have a `name` and/or `type` key.
+    ##           ```
+    ##      2. If a value is a mapping, then it must have a `name` and/or `type` key.
     ##         The `name` represents the sent metric name, and the `type` represents how
     ##         the metric should be handled, overriding any type information the endpoint
     ##         may provide. For example:
-    ##
+    ##           ```
     ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>:
     ##               name: <SENT_METRIC_1>
     ##               type: <METRIC_TYPE_1>
     ##           - <EXPOSED_METRIC_2>:
     ##               name: <SENT_METRIC_2>
     ##               type: <METRIC_TYPE_2>
-    ##
+    ##           ```
     ##         The supported native types are `gauge`, `counter`, `histogram`, and `summary`.
     ##
     ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total`
@@ -96,13 +98,19 @@ instances:
     ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes
     ##
     ## Regular expressions may be used to match the exposed metric names, for example:
-    ##
+    ##   ```
     ##   extra_metrics:
     ##   - ^network_(ingress|egress)_.+
     ##   - .+:
     ##       type: gauge
+    ##   ```
     #
-    # extra_metrics: []
+    # extra_metrics:
+    #   - <METRIC_1>
+    #   - <EXPOSED_METRIC_2>: <SENT_METRIC_2>
+    #   - <EXPOSED_METRIC_3>:
+    #       name: <SENT_METRIC_3>
+    #       type: <METRIC_TYPE_3>
 
     ## @param exclude_metrics - list of strings - optional
     ## A list of metrics to exclude, with each entry being either
@@ -215,30 +223,28 @@ instances:
     ## exposed metrics from which to share labels, and the values are mappings that configure the
     ## sharing behavior. Each mapping must have at least one of the following keys:
     ##
-    ##   labels - This is a list of labels to share. All labels are shared if this is not set.
-    ##   match - This is a list of labels to match on other metrics as a condition for sharing.
-    ##   values - This is a list of allowed values as a condition for sharing.
+    ##   - labels - This is a list of labels to share. All labels are shared if this is not set.
+    ##   - match - This is a list of labels to match on other metrics as a condition for sharing.
+    ##   - values - This is a list of allowed values as a condition for sharing.
     ##
     ## To unconditionally share all labels of a metric, set it to `true`.
     ##
     ## For example, the following configuration instructs the check to apply all labels from `metric_a`
     ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod`
     ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c`
     ## to all other metrics if their value is equal to `23` or `42`.
-    ##
-    ##   share_labels:
-    ##     metric_a: true
-    ##     metric_b:
-    ##       labels:
-    ##       - node
-    ##       match:
-    ##       - pod
-    ##     metric_c:
-    ##       values:
-    ##       - 23
-    ##       - 42
     #
-    # share_labels: {}
+    # share_labels:
+    #   metric_a: true
+    #   metric_b:
+    #     labels:
+    #     - node
+    #     match:
+    #     - pod
+    #   metric_c:
+    #     values:
+    #     - 23
+    #     - 42
 
     ## @param cache_shared_labels - boolean - optional - default: true
     ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload
@@ -306,7 +312,7 @@ instances:
 
     ## @param auth_type - string - optional - default: basic
     ## The type of authentication to use. The available types (and related options) are:
-    ##
+    ## ```
     ##   - basic
     ##     |__ username
     ##     |__ password
@@ -329,7 +335,7 @@ instances:
     ##     |__ aws_region
     ##     |__ aws_host
     ##     |__ aws_service
-    ##
+    ## ```
     ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`.
     ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials
     #

airflow/changelog.d/20878.fixed

@@ -0,0 +1 @@
+Improve descriptions and examples

airflow/datadog_checks/airflow/data/conf.yaml.example

@@ -88,7 +88,7 @@ instances:
 
     ## @param auth_type - string - optional - default: basic
     ## The type of authentication to use. The available types (and related options) are:
-    ##
+    ## ```
     ##   - basic
     ##     |__ username
     ##     |__ password
@@ -111,7 +111,7 @@ instances:
     ##     |__ aws_region
     ##     |__ aws_host
     ##     |__ aws_service
-    ##
+    ## ```
     ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`.
     ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials
     #

amazon_msk/changelog.d/20878.fixed

@@ -0,0 +1 @@
+Improve descriptions and examples

amazon_msk/datadog_checks/amazon_msk/data/conf.yaml.example

@@ -114,30 +114,32 @@ instances:
     ##
     ## 1. If the item is a string, then it represents the exposed metric name, and
     ##    the sent metric name will be identical. For example:
-    ##
+    ##      ```
     ##      extra_metrics:
     ##      - <METRIC_1>
     ##      - <METRIC_2>
+    ##      ```
     ## 2. If the item is a mapping, then the keys represent the exposed metric names.
     ##
-    ##      a. If a value is a string, then it represents the sent metric name. For example:
-    ##
+    ##      1. If a value is a string, then it represents the sent metric name. For example:
+    ##           ```
     ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>: <SENT_METRIC_1>
     ##           - <EXPOSED_METRIC_2>: <SENT_METRIC_2>
-    ##      b. If a value is a mapping, then it must have a `name` and/or `type` key.
+    ##           ```
+    ##      2. If a value is a mapping, then it must have a `name` and/or `type` key.
     ##         The `name` represents the sent metric name, and the `type` represents how
     ##         the metric should be handled, overriding any type information the endpoint
     ##         may provide. For example:
-    ##
+    ##           ```
     ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>:
     ##               name: <SENT_METRIC_1>
     ##               type: <METRIC_TYPE_1>
     ##           - <EXPOSED_METRIC_2>:
     ##               name: <SENT_METRIC_2>
     ##               type: <METRIC_TYPE_2>
-    ##
+    ##           ```
     ##         The supported native types are `gauge`, `counter`, `histogram`, and `summary`.
     ##
     ## Note: To collect counter metrics with names ending in `_total`, specify the metric name without the `_total`
@@ -147,13 +149,19 @@ instances:
     ## https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#suffixes
     ##
     ## Regular expressions may be used to match the exposed metric names, for example:
-    ##
+    ##   ```
     ##   extra_metrics:
     ##   - ^network_(ingress|egress)_.+
     ##   - .+:
     ##       type: gauge
+    ##   ```
     #
-    # extra_metrics: []
+    # extra_metrics:
+    #   - <METRIC_1>
+    #   - <EXPOSED_METRIC_2>: <SENT_METRIC_2>
+    #   - <EXPOSED_METRIC_3>:
+    #       name: <SENT_METRIC_3>
+    #       type: <METRIC_TYPE_3>
 
     ## @param exclude_metrics - list of strings - optional
     ## A list of metrics to exclude, with each entry being either
@@ -266,30 +274,28 @@ instances:
     ## exposed metrics from which to share labels, and the values are mappings that configure the
     ## sharing behavior. Each mapping must have at least one of the following keys:
     ##
-    ##   labels - This is a list of labels to share. All labels are shared if this is not set.
-    ##   match - This is a list of labels to match on other metrics as a condition for sharing.
-    ##   values - This is a list of allowed values as a condition for sharing.
+    ##   - labels - This is a list of labels to share. All labels are shared if this is not set.
+    ##   - match - This is a list of labels to match on other metrics as a condition for sharing.
+    ##   - values - This is a list of allowed values as a condition for sharing.
     ##
     ## To unconditionally share all labels of a metric, set it to `true`.
     ##
     ## For example, the following configuration instructs the check to apply all labels from `metric_a`
     ## to all other metrics, the `node` label from `metric_b` to only those metrics that have a `pod`
     ## label value that matches the `pod` label value of `metric_b`, and all labels from `metric_c`
     ## to all other metrics if their value is equal to `23` or `42`.
-    ##
-    ##   share_labels:
-    ##     metric_a: true
-    ##     metric_b:
-    ##       labels:
-    ##       - node
-    ##       match:
-    ##       - pod
-    ##     metric_c:
-    ##       values:
-    ##       - 23
-    ##       - 42
     #
-    # share_labels: {}
+    # share_labels:
+    #   metric_a: true
+    #   metric_b:
+    #     labels:
+    #     - node
+    #     match:
+    #     - pod
+    #   metric_c:
+    #     values:
+    #     - 23
+    #     - 42
 
     ## @param cache_shared_labels - boolean - optional - default: true
     ## When `share_labels` is set, it instructs the check to cache labels collected from the first payload
@@ -357,7 +363,7 @@ instances:
 
     ## @param auth_type - string - optional - default: basic
     ## The type of authentication to use. The available types (and related options) are:
-    ##
+    ## ```
     ##   - basic
     ##     |__ username
     ##     |__ password
@@ -380,7 +386,7 @@ instances:
     ##     |__ aws_region
     ##     |__ aws_host
     ##     |__ aws_service
-    ##
+    ## ```
     ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`.
     ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials
     #

ambari/changelog.d/20878.fixed

@@ -0,0 +1 @@
+Improve descriptions and examples

ambari/datadog_checks/ambari/data/conf.yaml.example

@@ -91,7 +91,7 @@ instances:
 
     ## @param auth_type - string - optional - default: basic
     ## The type of authentication to use. The available types (and related options) are:
-    ##
+    ## ```
     ##   - basic
     ##     |__ username
     ##     |__ password
@@ -114,7 +114,7 @@ instances:
     ##     |__ aws_region
     ##     |__ aws_host
     ##     |__ aws_service
-    ##
+    ## ```
     ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`.
     ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials
     #

apache/changelog.d/20878.fixed

@@ -0,0 +1 @@
+Improve descriptions and examples

apache/datadog_checks/apache/data/conf.yaml.example

@@ -83,7 +83,7 @@ instances:
 
     ## @param auth_type - string - optional - default: basic
     ## The type of authentication to use. The available types (and related options) are:
-    ##
+    ## ```
     ##   - basic
     ##     |__ username
     ##     |__ password
@@ -106,7 +106,7 @@ instances:
     ##     |__ aws_region
     ##     |__ aws_host
     ##     |__ aws_service
-    ##
+    ## ```
     ## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`.
     ## Details: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html#configuring-credentials
     #

appgate_sdp/changelog.d/20878.fixed

@@ -0,0 +1 @@
+Improve descriptions and examples