Fix API description in docs (#493)

* Fix notes in docs

* Regenerate client from commit 4046482 of spec repo

Co-authored-by: Thomas Hervé <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: 3 people

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.4.1.dev8",
-            "regenerated": "2021-06-22 08:01:40.508539",
-            "spec_repo_commit": "6820788"
+            "regenerated": "2021-06-22 13:17:19.274865",
+            "spec_repo_commit": "4046482"
         },
         "v2": {
             "apigentools_version": "1.4.1.dev8",
-            "regenerated": "2021-06-22 08:02:06.972364",
-            "spec_repo_commit": "6820788"
+            "regenerated": "2021-06-22 13:17:45.898559",
+            "spec_repo_commit": "4046482"
         }
     }
 }

.generator/templates/api_doc.mustache

@@ -13,9 +13,7 @@ Method | HTTP request | Description
 # **{{{operationId}}}**
 > {{#returnType}}{{{returnType}}} {{/returnType}}{{{operationId}}}({{#requiredParams}}{{^defaultValue}}{{paramName}}{{^-last}}, {{/-last}}{{/defaultValue}}{{/requiredParams}})
 
-{{{summary}}}{{#notes}}
-
-{{{notes}}}{{/notes}}
+{{#notes}}{{{unescapedNotes}}}{{/notes}}
 
 ### Example
 

docs/v1/AWSIntegrationApi.md

@@ -18,9 +18,10 @@ Method | HTTP request | Description
 # **create_aws_account**
 > AWSAccountCreateResponse create_aws_account(body)
 
-Create an AWS integration
-
-Create a Datadog-Amazon Web Services integration. Using the `POST` method updates your integration configuration by adding your new configuration to the existing one in your Datadog organization. A unique AWS Account ID for role based authentication.
+Create a Datadog-Amazon Web Services integration.
+Using the `POST` method updates your integration configuration
+by adding your new configuration to the existing one in your Datadog organization.
+A unique AWS Account ID for role based authentication.
 
 ### Example
 
@@ -96,8 +97,6 @@ Name | Type | Description  | Notes
 # **create_aws_tag_filter**
 > {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_aws_tag_filter(body)
 
-Set an AWS tag filter
-
 Set an AWS tag filter.
 
 ### Example
@@ -166,8 +165,6 @@ Name | Type | Description  | Notes
 # **create_new_aws_external_id**
 > AWSAccountCreateResponse create_new_aws_external_id(body)
 
-Generate a new external ID
-
 Generate a new AWS external ID for a given AWS account ID and role name pair.
 
 ### Example
@@ -243,8 +240,6 @@ Name | Type | Description  | Notes
 # **delete_aws_account**
 > {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_aws_account(body)
 
-Delete an AWS integration
-
 Delete a Datadog-AWS integration matching the specified `account_id` and `role_name parameters`.
 
 ### Example
@@ -321,8 +316,6 @@ Name | Type | Description  | Notes
 # **delete_aws_tag_filter**
 > {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_aws_tag_filter(body)
 
-Delete a tag filtering entry
-
 Delete a tag filtering entry.
 
 ### Example
@@ -390,8 +383,6 @@ Name | Type | Description  | Notes
 # **list_available_aws_namespaces**
 > [str] list_available_aws_namespaces()
 
-List namespace rules
-
 List all namespace rules for a given Datadog-AWS integration. This endpoint takes no arguments.
 
 ### Example
@@ -451,8 +442,6 @@ This endpoint does not need any parameter.
 # **list_aws_accounts**
 > AWSAccountListResponse list_aws_accounts()
 
-List all AWS integrations
-
 List all Datadog-AWS integrations available in your Datadog organization.
 
 ### Example
@@ -522,8 +511,6 @@ Name | Type | Description  | Notes
 # **list_aws_tag_filters**
 > AWSTagFilterListResponse list_aws_tag_filters(account_id)
 
-Get all AWS tag filters
-
 Get all AWS tag filters.
 
 ### Example
@@ -588,8 +575,6 @@ Name | Type | Description  | Notes
 # **update_aws_account**
 > {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_aws_account(body)
 
-Update an AWS integration
-
 Update a Datadog-Amazon Web Services integration.
 
 ### Example

docs/v1/AWSLogsIntegrationApi.md

@@ -16,9 +16,14 @@ Method | HTTP request | Description
 # **check_aws_logs_lambda_async**
 > AWSLogsAsyncResponse check_aws_logs_lambda_async(body)
 
-Check that an AWS Lambda Function exists
+Test if permissions are present to add a log-forwarding triggers for the given services and AWS account. The input
+is the same as for Enable an AWS service log collection. Subsequent requests will always repeat the above, so this
+endpoint can be polled intermittently instead of blocking.
 
-Test if permissions are present to add a log-forwarding triggers for the given services and AWS account. The input is the same as for Enable an AWS service log collection. Subsequent requests will always repeat the above, so this endpoint can be polled intermittently instead of blocking.  - Returns a status of 'created' when it's checking if the Lambda exists in the account. - Returns a status of 'waiting' while checking. - Returns a status of 'checked and ok' if the Lambda exists. - Returns a status of 'error' if the Lambda does not exist.
+- Returns a status of 'created' when it's checking if the Lambda exists in the account.
+- Returns a status of 'waiting' while checking.
+- Returns a status of 'checked and ok' if the Lambda exists.
+- Returns a status of 'error' if the Lambda does not exist.
 
 ### Example
 
@@ -85,9 +90,16 @@ Name | Type | Description  | Notes
 # **check_aws_logs_services_async**
 > AWSLogsAsyncResponse check_aws_logs_services_async(body)
 
-Check permissions for log services
+Test if permissions are present to add log-forwarding triggers for the
+given services and AWS account. Input is the same as for `EnableAWSLogServices`.
+Done async, so can be repeatedly polled in a non-blocking fashion until
+the async request completes.
 
-Test if permissions are present to add log-forwarding triggers for the given services and AWS account. Input is the same as for `EnableAWSLogServices`. Done async, so can be repeatedly polled in a non-blocking fashion until the async request completes.  - Returns a status of `created` when it's checking if the permissions exists   in the AWS account. - Returns a status of `waiting` while checking. - Returns a status of `checked and ok` if the Lambda exists. - Returns a status of `error` if the Lambda does not exist.
+- Returns a status of `created` when it's checking if the permissions exists
+  in the AWS account.
+- Returns a status of `waiting` while checking.
+- Returns a status of `checked and ok` if the Lambda exists.
+- Returns a status of `error` if the Lambda does not exist.
 
 ### Example
 
@@ -154,8 +166,6 @@ Name | Type | Description  | Notes
 # **create_aws_lambda_arn**
 > {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_aws_lambda_arn(body)
 
-Add AWS Log Lambda ARN
-
 Attach the Lambda ARN of the Lambda created for the Datadog-AWS log collection to your AWS account ID to enable log collection.
 
 ### Example
@@ -223,8 +233,6 @@ Name | Type | Description  | Notes
 # **delete_aws_lambda_arn**
 > {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_aws_lambda_arn(body)
 
-Delete an AWS Logs integration
-
 Delete a Datadog-AWS logs configuration by removing the specific Lambda ARN associated with a given AWS account.
 
 ### Example
@@ -292,8 +300,6 @@ Name | Type | Description  | Notes
 # **enable_aws_log_services**
 > {str: (bool, date, datetime, dict, float, int, list, str, none_type)} enable_aws_log_services(body)
 
-Enable an AWS Logs integration
-
 Enable automatic log collection for a list of services. This should be run after running `CreateAWSLambdaARN` to save the configuration.
 
 ### Example
@@ -361,8 +367,6 @@ Name | Type | Description  | Notes
 # **list_aws_logs_integrations**
 > [AWSLogsListResponse] list_aws_logs_integrations()
 
-List all AWS Logs integrations
-
 List all Datadog-AWS Logs integrations configured in your Datadog account.
 
 ### Example
@@ -423,8 +427,6 @@ This endpoint does not need any parameter.
 # **list_aws_logs_services**
 > [AWSLogsListServicesResponse] list_aws_logs_services()
 
-Get list of AWS log ready services
-
 Get the list of current AWS services that Datadog offers automatic log collection. Use returned service IDs with the services parameter for the Enable an AWS service log collection API endpoint.
 
 ### Example

docs/v1/AuthenticationApi.md

@@ -10,8 +10,6 @@ Method | HTTP request | Description
 # **validate**
 > AuthenticationValidationResponse validate()
 
-Validate API key
-
 Check if the API key (not the APP key) is valid. If invalid, a 403 is returned.
 
 ### Example

docs/v1/AzureIntegrationApi.md

@@ -14,9 +14,13 @@ Method | HTTP request | Description
 # **create_azure_integration**
 > {str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_azure_integration(body)
 
-Create an Azure integration
+Create a Datadog-Azure integration.
 
-Create a Datadog-Azure integration.  Using the `POST` method updates your integration configuration by adding your new configuration to the existing one in your Datadog organization.  Using the `PUT` method updates your integration configuration by replacing your current configuration with the new one sent to your Datadog organization.
+Using the `POST` method updates your integration configuration by adding your new
+configuration to the existing one in your Datadog organization.
+
+Using the `PUT` method updates your integration configuration by replacing your
+current configuration with the new one sent to your Datadog organization.
 
 ### Example
 
@@ -88,8 +92,6 @@ Name | Type | Description  | Notes
 # **delete_azure_integration**
 > {str: (bool, date, datetime, dict, float, int, list, str, none_type)} delete_azure_integration(body)
 
-Delete an Azure integration
-
 Delete a given Datadog-Azure integration from your Datadog account.
 
 ### Example
@@ -162,8 +164,6 @@ Name | Type | Description  | Notes
 # **list_azure_integration**
 > AzureAccountListResponse list_azure_integration()
 
-List all Azure integrations
-
 List all Datadog-Azure integrations configured in your Datadog account.
 
 ### Example
@@ -224,8 +224,6 @@ This endpoint does not need any parameter.
 # **update_azure_host_filters**
 > {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_azure_host_filters(body)
 
-Update Azure integration host filters
-
 Update the defined list of host filters for a given Datadog-Azure integration.
 
 ### Example
@@ -298,9 +296,9 @@ Name | Type | Description  | Notes
 # **update_azure_integration**
 > {str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_azure_integration(body)
 
-Update an Azure integration
-
-Update a Datadog-Azure integration. Requires an existing `tenant_name` and `client_id`. Any other fields supplied will overwrite existing values. To overwrite `tenant_name` or `client_id`, use `new_tenant_name` and `new_client_id`. To leave a field unchanged, do not supply that field in the payload.
+Update a Datadog-Azure integration. Requires an existing `tenant_name` and `client_id`.
+Any other fields supplied will overwrite existing values. To overwrite `tenant_name` or `client_id`,
+use `new_tenant_name` and `new_client_id`. To leave a field unchanged, do not supply that field in the payload.
 
 ### Example
 

docs/v1/DashboardListsApi.md

@@ -14,8 +14,6 @@ Method | HTTP request | Description
 # **create_dashboard_list**
 > DashboardList create_dashboard_list(body)
 
-Create a dashboard list
-
 Create an empty dashboard list.
 
 ### Example
@@ -93,8 +91,6 @@ Name | Type | Description  | Notes
 # **delete_dashboard_list**
 > DashboardListDeleteResponse delete_dashboard_list(list_id)
 
-Delete a dashboard list
-
 Delete a dashboard list.
 
 ### Example
@@ -159,8 +155,6 @@ Name | Type | Description  | Notes
 # **get_dashboard_list**
 > DashboardList get_dashboard_list(list_id)
 
-Get a dashboard list
-
 Fetch an existing dashboard list's definition.
 
 ### Example
@@ -225,8 +219,6 @@ Name | Type | Description  | Notes
 # **list_dashboard_lists**
 > DashboardListListResponse list_dashboard_lists()
 
-Get all dashboard lists
-
 Fetch all of your existing dashboard list definitions.
 
 ### Example
@@ -286,8 +278,6 @@ This endpoint does not need any parameter.
 # **update_dashboard_list**
 > DashboardList update_dashboard_list(list_id, body)
 
-Update a dashboard list
-
 Update the name of a dashboard list.
 
 ### Example

docs/v1/DashboardsApi.md

@@ -14,9 +14,8 @@ Method | HTTP request | Description
 # **create_dashboard**
 > Dashboard create_dashboard(body)
 
-Create a new dashboard
-
-Create a dashboard using the specified options. When defining queries in your widgets, take note of which queries should have the `as_count()` or `as_rate()` modifiers appended. Refer to the following [documentation](https://docs.datadoghq.com/developers/metrics/type_modifiers/?tab=count#in-application-modifiers) for more information on these modifiers.
+Create a dashboard using the specified options. When defining queries in your widgets, take note of which queries should have the `as_count()` or `as_rate()` modifiers appended.
+Refer to the following [documentation](https://docs.datadoghq.com/developers/metrics/type_modifiers/?tab=count#in-application-modifiers) for more information on these modifiers.
 
 ### Example
 
@@ -128,8 +127,6 @@ Name | Type | Description  | Notes
 # **delete_dashboard**
 > DashboardDeleteResponse delete_dashboard(dashboard_id)
 
-Delete a dashboard
-
 Delete a dashboard using the specified ID.
 
 ### Example
@@ -194,8 +191,6 @@ Name | Type | Description  | Notes
 # **get_dashboard**
 > Dashboard get_dashboard(dashboard_id)
 
-Get a dashboard
-
 Get a dashboard using the specified ID.
 
 ### Example
@@ -260,9 +255,10 @@ Name | Type | Description  | Notes
 # **list_dashboards**
 > DashboardSummary list_dashboards()
 
-Get all dashboards
+Get all dashboards.
 
-Get all dashboards.  **Note**: This query will only return custom created or cloned dashboards. This query will not return preset dashboards.
+**Note**: This query will only return custom created or cloned dashboards.
+This query will not return preset dashboards.
 
 ### Example
 
@@ -326,8 +322,6 @@ Name | Type | Description  | Notes
 # **update_dashboard**
 > Dashboard update_dashboard(dashboard_id, body)
 
-Update a dashboard
-
 Update a dashboard using the specified ID.
 
 ### Example