Format generated examples (#736)

* Format generated examples

* pre-commit fixes

* Use ruby env

* pre-commit fixes

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

.pre-commit-config.yaml

@@ -7,14 +7,22 @@ repos:
     entry: make
     files: '^(\.generator/.*|\.pre-commit-config\.yaml|Makefile)'
     pass_filenames: false
+  - id: format-examples
+    name: Format generated examples
+    language: ruby
+    additional_dependencies:
+      - rufo
+    entry: rufo examples/generated
+    files: '^examples/generated'
+    pass_filenames: false
   - id: docs
     name: Format documentation
     stages: [manual]
     language: node
     language_version: 14.12.0
-    entry: prettier --write --list-different --ignore-unknown docs
+    entry: prettier --write --list-different --ignore-unknown README.md
     "types": [text]
-    files: '^docs/'
+    files: 'README.md'
     pass_filenames: false
     additional_dependencies:
       # When updating the version of prettier, make sure to check the  pre-commit file

Makefile

@@ -8,6 +8,7 @@ all: .generator .env
 	@rm lib/datadog_api_client/v*/version.rb
 	@ls v1/docs/*API.md | grep -v IPPrefixesAPI.md | xargs -n1 ./extract-code-blocks.awk -v output="examples/generated/v1"
 	@ls v2/docs/*API.md | grep -v IPPrefixesAPI.md | xargs -n1 ./extract-code-blocks.awk -v output="examples/generated/v2"
+	@pre-commit run --all-files --hook-stage=manual format-examples || true
 	@rm -rf v1 v2
 	@pre-commit run --all-files --hook-stage=manual docs || echo "modified files"
 

README.md

@@ -18,42 +18,42 @@ The following steps will help you quickly start interacting with Datadog APIs us
 
 1. Add the `datadog_api_client` gem to you Gemfile:
 
-    ```ruby
-    source 'https://rubygems.org'
-    gem 'datadog_api_client'
-    ```
+   ```ruby
+   source 'https://rubygems.org'
+   gem 'datadog_api_client'
+   ```
 
 2. Install the gem with `bundle install`
 
 3. (optional) You can configure site and [authentication](#authentication) using environment variables or code block:
 
-    ```ruby
-    DatadogAPIClient::V1.configure do |config|
-      config.server_variables[:site] = 'datadoghq.eu'
-    end
-    ```
+   ```ruby
+   DatadogAPIClient::V1.configure do |config|
+     config.server_variables[:site] = 'datadoghq.eu'
+   end
+   ```
 
 ### Build a gem
 
 1. Build the Ruby code into a gem:
 
-    ```shell
-    gem build datadog_api_client.gemspec
-    ```
+   ```shell
+   gem build datadog_api_client.gemspec
+   ```
 
 2. Install the gem locally:
 
-    ```shell
-    gem install ./datadog_api_client-*.gem
-    ```
+   ```shell
+   gem install ./datadog_api_client-*.gem
+   ```
 
 ### Install from Git
 
 1. Add the following in the Gemfile:
 
-    ```ruby
-    gem 'datadog_api_client', :git => 'https://github.com/DataDog/datadog-api-client-ruby.git'
-    ```
+   ```ruby
+   gem 'datadog_api_client', :git => 'https://github.com/DataDog/datadog-api-client-ruby.git'
+   ```
 
 2. Install the gem with `bundle install`
 
@@ -63,9 +63,9 @@ The following steps will help you quickly start interacting with Datadog APIs us
 
 2. Include the Ruby code directly using `-I` as follows:
 
-    ```shell
-    ruby -Ilib example.rb
-    ```
+   ```shell
+   ruby -Ilib example.rb
+   ```
 
 ## Getting Started
 
@@ -127,7 +127,7 @@ config = DatadogAPIClient::V1::Configuration.new
 config.compress = false
 client = DatadogAPIClient::V1::APIClient.new(config)
 ```
- 
+
 ### Enable requests logging
 
 If you want to enable requests logging, set the `debugging` flag

examples/generated/v1/authentication/Validate.rb

@@ -1,4 +1,4 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AuthenticationAPI.new
 
 begin

examples/generated/v1/aws-integration/CreateAWSAccount.rb

@@ -1,4 +1,4 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AWSIntegrationAPI.new
 body = DatadogAPIClient::V1::AWSAccount.new # AWSAccount | AWS Request Object
 

examples/generated/v1/aws-integration/CreateAWSTagFilter.rb

@@ -1,4 +1,4 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AWSIntegrationAPI.new
 body = DatadogAPIClient::V1::AWSTagFilterCreateRequest.new # AWSTagFilterCreateRequest | Set an AWS tag filter using an `aws_account_identifier`, `namespace`, and filtering string. Namespace options are `application_elb`, `elb`, `lambda`, `network_elb`, `rds`, `sqs`, and `custom`.
 

examples/generated/v1/aws-integration/CreateNewAWSExternalId.rb

@@ -1,4 +1,4 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AWSIntegrationAPI.new
 body = DatadogAPIClient::V1::AWSAccount.new # AWSAccount | Your Datadog role delegation name. For more information about your AWS account Role name, see the [Datadog AWS integration configuration info](https://docs.datadoghq.com/integrations/amazon_web_services/#setup).
 

examples/generated/v1/aws-integration/DeleteAWSAccount.rb

@@ -1,4 +1,4 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AWSIntegrationAPI.new
 body = DatadogAPIClient::V1::AWSAccountDeleteRequest.new # AWSAccountDeleteRequest | AWS request object
 

examples/generated/v1/aws-integration/DeleteAWSTagFilter.rb

@@ -1,4 +1,4 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AWSIntegrationAPI.new
 body = DatadogAPIClient::V1::AWSTagFilterDeleteRequest.new # AWSTagFilterDeleteRequest | Delete a tag filtering entry for a given AWS account and `dd-aws` namespace.
 

examples/generated/v1/aws-integration/ListAWSAccounts.rb

@@ -1,9 +1,9 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AWSIntegrationAPI.new
 opts = {
-  account_id: 'account_id_example', # String | Only return AWS accounts that matches this `account_id`.
-  role_name: 'role_name_example', # String | Only return AWS accounts that matches this role_name.
-  access_key_id: 'access_key_id_example' # String | Only return AWS accounts that matches this `access_key_id`.
+  account_id: "account_id_example", # String | Only return AWS accounts that matches this `account_id`.
+  role_name: "role_name_example", # String | Only return AWS accounts that matches this role_name.
+  access_key_id: "access_key_id_example", # String | Only return AWS accounts that matches this `access_key_id`.
 }
 
 begin

examples/generated/v1/aws-integration/ListAWSTagFilters.rb

@@ -1,6 +1,6 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AWSIntegrationAPI.new
-account_id = 'account_id_example' # String | Only return AWS filters that matches this `account_id`.
+account_id = "account_id_example" # String | Only return AWS filters that matches this `account_id`.
 
 begin
   # Get all AWS tag filters

examples/generated/v1/aws-integration/ListAvailableAWSNamespaces.rb

@@ -1,4 +1,4 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AWSIntegrationAPI.new
 
 begin

examples/generated/v1/aws-integration/UpdateAWSAccount.rb

@@ -1,10 +1,10 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AWSIntegrationAPI.new
 body = DatadogAPIClient::V1::AWSAccount.new # AWSAccount | AWS request object
 opts = {
-  account_id: 'account_id_example', # String | Only return AWS accounts that matches this `account_id`.
-  role_name: 'role_name_example', # String | Only return AWS accounts that match this `role_name`. Required if `account_id` is specified.
-  access_key_id: 'access_key_id_example' # String | Only return AWS accounts that matches this `access_key_id`. Required if none of the other two options are specified.
+  account_id: "account_id_example", # String | Only return AWS accounts that matches this `account_id`.
+  role_name: "role_name_example", # String | Only return AWS accounts that match this `role_name`. Required if `account_id` is specified.
+  access_key_id: "access_key_id_example", # String | Only return AWS accounts that matches this `access_key_id`. Required if none of the other two options are specified.
 }
 
 begin

examples/generated/v1/aws-logs-integration/CheckAWSLogsLambdaAsync.rb

@@ -1,6 +1,6 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AWSLogsIntegrationAPI.new
-body = DatadogAPIClient::V1::AWSAccountAndLambdaRequest.new({account_id: '1234567', lambda_arn: 'arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest'}) # AWSAccountAndLambdaRequest | Check AWS Log Lambda Async request body.
+body = DatadogAPIClient::V1::AWSAccountAndLambdaRequest.new({ account_id: "1234567", lambda_arn: "arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest" }) # AWSAccountAndLambdaRequest | Check AWS Log Lambda Async request body.
 
 begin
   # Check that an AWS Lambda Function exists

examples/generated/v1/aws-logs-integration/CheckAWSLogsServicesAsync.rb

@@ -1,6 +1,6 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AWSLogsIntegrationAPI.new
-body = DatadogAPIClient::V1::AWSLogsServicesRequest.new({account_id: '1234567', services: ['services_example']}) # AWSLogsServicesRequest | Check AWS Logs Async Services request body.
+body = DatadogAPIClient::V1::AWSLogsServicesRequest.new({ account_id: "1234567", services: ["services_example"] }) # AWSLogsServicesRequest | Check AWS Logs Async Services request body.
 
 begin
   # Check permissions for log services

examples/generated/v1/aws-logs-integration/CreateAWSLambdaArn.rb

@@ -1,6 +1,6 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AWSLogsIntegrationAPI.new
-body = DatadogAPIClient::V1::AWSAccountAndLambdaRequest.new({account_id: '1234567', lambda_arn: 'arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest'}) # AWSAccountAndLambdaRequest | AWS Log Lambda Async request body.
+body = DatadogAPIClient::V1::AWSAccountAndLambdaRequest.new({ account_id: "1234567", lambda_arn: "arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest" }) # AWSAccountAndLambdaRequest | AWS Log Lambda Async request body.
 
 begin
   # Add AWS Log Lambda ARN

examples/generated/v1/aws-logs-integration/DeleteAWSLambdaArn.rb

@@ -1,6 +1,6 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AWSLogsIntegrationAPI.new
-body = DatadogAPIClient::V1::AWSAccountAndLambdaRequest.new({account_id: '1234567', lambda_arn: 'arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest'}) # AWSAccountAndLambdaRequest | Delete AWS Lambda ARN request body.
+body = DatadogAPIClient::V1::AWSAccountAndLambdaRequest.new({ account_id: "1234567", lambda_arn: "arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest" }) # AWSAccountAndLambdaRequest | Delete AWS Lambda ARN request body.
 
 begin
   # Delete an AWS Logs integration

examples/generated/v1/aws-logs-integration/EnableAWSLogServices.rb

@@ -1,6 +1,6 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AWSLogsIntegrationAPI.new
-body = DatadogAPIClient::V1::AWSLogsServicesRequest.new({account_id: '1234567', services: ['services_example']}) # AWSLogsServicesRequest | Enable AWS Log Services request body.
+body = DatadogAPIClient::V1::AWSLogsServicesRequest.new({ account_id: "1234567", services: ["services_example"] }) # AWSLogsServicesRequest | Enable AWS Log Services request body.
 
 begin
   # Enable an AWS Logs integration

examples/generated/v1/aws-logs-integration/ListAWSLogsIntegrations.rb

@@ -1,4 +1,4 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AWSLogsIntegrationAPI.new
 
 begin

examples/generated/v1/aws-logs-integration/ListAWSLogsServices.rb

@@ -1,4 +1,4 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AWSLogsIntegrationAPI.new
 
 begin

examples/generated/v1/azure-integration/CreateAzureIntegration.rb

@@ -1,4 +1,4 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AzureIntegrationAPI.new
 body = DatadogAPIClient::V1::AzureAccount.new # AzureAccount | Create a Datadog-Azure integration for your Datadog account request body.
 

examples/generated/v1/azure-integration/DeleteAzureIntegration.rb

@@ -1,4 +1,4 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AzureIntegrationAPI.new
 body = DatadogAPIClient::V1::AzureAccount.new # AzureAccount | Delete a given Datadog-Azure integration request body.
 

examples/generated/v1/azure-integration/ListAzureIntegration.rb

@@ -1,4 +1,4 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AzureIntegrationAPI.new
 
 begin

examples/generated/v1/azure-integration/UpdateAzureHostFilters.rb

@@ -1,4 +1,4 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AzureIntegrationAPI.new
 body = DatadogAPIClient::V1::AzureAccount.new # AzureAccount | Update a Datadog-Azure integration's host filters request body.
 

examples/generated/v1/azure-integration/UpdateAzureIntegration.rb

@@ -1,4 +1,4 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AzureIntegrationAPI.new
 body = DatadogAPIClient::V1::AzureAccount.new # AzureAccount | Update a Datadog-Azure integration request body.
 

examples/generated/v1/dashboard-lists/CreateDashboardList.rb

@@ -1,6 +1,6 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::DashboardListsAPI.new
-body = DatadogAPIClient::V1::DashboardList.new({name: 'My Dashboard'}) # DashboardList | Create a dashboard list request body.
+body = DatadogAPIClient::V1::DashboardList.new({ name: "My Dashboard" }) # DashboardList | Create a dashboard list request body.
 
 begin
   # Create a dashboard list

examples/generated/v1/dashboard-lists/DeleteDashboardList.rb

@@ -1,4 +1,4 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::DashboardListsAPI.new
 list_id = 789 # Integer | ID of the dashboard list to delete.
 

examples/generated/v1/dashboard-lists/GetDashboardList.rb

@@ -1,4 +1,4 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::DashboardListsAPI.new
 list_id = 789 # Integer | ID of the dashboard list to fetch.
 

examples/generated/v1/dashboard-lists/ListDashboardLists.rb

@@ -1,4 +1,4 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::DashboardListsAPI.new
 
 begin

examples/generated/v1/dashboard-lists/UpdateDashboardList.rb

@@ -1,7 +1,7 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::DashboardListsAPI.new
 list_id = 789 # Integer | ID of the dashboard list to update.
-body = DatadogAPIClient::V1::DashboardList.new({name: 'My Dashboard'}) # DashboardList | Update a dashboard list request body.
+body = DatadogAPIClient::V1::DashboardList.new({ name: "My Dashboard" }) # DashboardList | Update a dashboard list request body.
 
 begin
   # Update a dashboard list

examples/generated/v1/dashboards/CreateDashboard.rb

@@ -1,6 +1,6 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::DashboardsAPI.new
-body = DatadogAPIClient::V1::Dashboard.new({layout_type: DatadogAPIClient::V1::DashboardLayoutType::ORDERED, title: 'title_example', widgets: [DatadogAPIClient::V1::Widget.new({definition: DatadogAPIClient::V1::AlertGraphWidgetDefinition.new({alert_id: 'alert_id_example', type: DatadogAPIClient::V1::AlertGraphWidgetDefinitionType::ALERT_GRAPH, viz_type: DatadogAPIClient::V1::WidgetVizType::TIMESERIES})})]}) # Dashboard | Create a dashboard request body.
+body = DatadogAPIClient::V1::Dashboard.new({ layout_type: DatadogAPIClient::V1::DashboardLayoutType::ORDERED, title: "title_example", widgets: [DatadogAPIClient::V1::Widget.new({ definition: DatadogAPIClient::V1::AlertGraphWidgetDefinition.new({ alert_id: "alert_id_example", type: DatadogAPIClient::V1::AlertGraphWidgetDefinitionType::ALERT_GRAPH, viz_type: DatadogAPIClient::V1::WidgetVizType::TIMESERIES }) })] }) # Dashboard | Create a dashboard request body.
 
 begin
   # Create a new dashboard

examples/generated/v1/dashboards/DeleteDashboard.rb

@@ -1,6 +1,6 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::DashboardsAPI.new
-dashboard_id = 'dashboard_id_example' # String | The ID of the dashboard.
+dashboard_id = "dashboard_id_example" # String | The ID of the dashboard.
 
 begin
   # Delete a dashboard

examples/generated/v1/dashboards/DeleteDashboards.rb

@@ -1,6 +1,6 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::DashboardsAPI.new
-body = DatadogAPIClient::V1::DashboardBulkDeleteRequest.new({data: [DatadogAPIClient::V1::DashboardBulkActionData.new({id: '123-abc-456', type: DatadogAPIClient::V1::DashboardResourceType::DASHBOARD})]}) # DashboardBulkDeleteRequest | Delete dashboards request body.
+body = DatadogAPIClient::V1::DashboardBulkDeleteRequest.new({ data: [DatadogAPIClient::V1::DashboardBulkActionData.new({ id: "123-abc-456", type: DatadogAPIClient::V1::DashboardResourceType::DASHBOARD })] }) # DashboardBulkDeleteRequest | Delete dashboards request body.
 
 begin
   # Delete dashboards

examples/generated/v1/dashboards/GetDashboard.rb

@@ -1,6 +1,6 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::DashboardsAPI.new
-dashboard_id = 'dashboard_id_example' # String | The ID of the dashboard.
+dashboard_id = "dashboard_id_example" # String | The ID of the dashboard.
 
 begin
   # Get a dashboard

examples/generated/v1/dashboards/ListDashboards.rb

@@ -1,8 +1,8 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::DashboardsAPI.new
 opts = {
   filter_shared: true, # Boolean | When `true`, this query only returns shared custom created or cloned dashboards.
-  filter_deleted: true # Boolean | When `true`, this query returns only deleted custom-created or cloned dashboards. This parameter is incompatible with `filter[shared]`.
+  filter_deleted: true, # Boolean | When `true`, this query returns only deleted custom-created or cloned dashboards. This parameter is incompatible with `filter[shared]`.
 }
 
 begin

examples/generated/v1/dashboards/RestoreDashboards.rb

@@ -1,6 +1,6 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::DashboardsAPI.new
-body = DatadogAPIClient::V1::DashboardRestoreRequest.new({data: [DatadogAPIClient::V1::DashboardBulkActionData.new({id: '123-abc-456', type: DatadogAPIClient::V1::DashboardResourceType::DASHBOARD})]}) # DashboardRestoreRequest | Restore dashboards request body.
+body = DatadogAPIClient::V1::DashboardRestoreRequest.new({ data: [DatadogAPIClient::V1::DashboardBulkActionData.new({ id: "123-abc-456", type: DatadogAPIClient::V1::DashboardResourceType::DASHBOARD })] }) # DashboardRestoreRequest | Restore dashboards request body.
 
 begin
   # Restore deleted dashboards

examples/generated/v1/dashboards/UpdateDashboard.rb

@@ -1,7 +1,7 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::DashboardsAPI.new
-dashboard_id = 'dashboard_id_example' # String | The ID of the dashboard.
-body = DatadogAPIClient::V1::Dashboard.new({layout_type: DatadogAPIClient::V1::DashboardLayoutType::ORDERED, title: 'title_example', widgets: [DatadogAPIClient::V1::Widget.new({definition: DatadogAPIClient::V1::AlertGraphWidgetDefinition.new({alert_id: 'alert_id_example', type: DatadogAPIClient::V1::AlertGraphWidgetDefinitionType::ALERT_GRAPH, viz_type: DatadogAPIClient::V1::WidgetVizType::TIMESERIES})})]}) # Dashboard | Update Dashboard request body.
+dashboard_id = "dashboard_id_example" # String | The ID of the dashboard.
+body = DatadogAPIClient::V1::Dashboard.new({ layout_type: DatadogAPIClient::V1::DashboardLayoutType::ORDERED, title: "title_example", widgets: [DatadogAPIClient::V1::Widget.new({ definition: DatadogAPIClient::V1::AlertGraphWidgetDefinition.new({ alert_id: "alert_id_example", type: DatadogAPIClient::V1::AlertGraphWidgetDefinitionType::ALERT_GRAPH, viz_type: DatadogAPIClient::V1::WidgetVizType::TIMESERIES }) })] }) # Dashboard | Update Dashboard request body.
 
 begin
   # Update a dashboard

examples/generated/v1/downtimes/CancelDowntime.rb

@@ -1,4 +1,4 @@
-require 'datadog_api_client'
+require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::DowntimesAPI.new
 downtime_id = 123456 # Integer | ID of the downtime to cancel.