README.md in datadog_api_client-2.0.0 vs README.md in datadog_api_client-2.0.1

- old
+ new

@@ -25,11 +25,11 @@ 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| + DatadogAPIClient.configure do |config| config.server_variables[:site] = 'datadoghq.eu' end ``` ### Build a gem @@ -76,78 +76,78 @@ api_instance = DatadogAPIClient::V1::IPRangesAPI.new begin result = api_instance.get_ip_ranges p result -rescue DatadogAPIClient::V1::APIError => e +rescue DatadogAPIClient::APIError => e puts "Error when calling IPRangesAPI->get_ip_ranges: #{e}" end ``` ### Authentication Authenticate with the API by providing your API and Application keys in the configuration: ```ruby -DatadogAPIClient::V1.configure do |config| +DatadogAPIClient.configure do |config| config.api_key = ENV['NON_STANDARD_NAME_FOR_DD_API_KEY'] config.application_key = ENV['NON_STANDARD_NAME_FOR_DD_APP_KEY'] end ``` ### Unstable (Beta) Endpoints This client includes access to Datadog API endpoints while they are in an unstable state and may undergo breaking changes. An extra configuration step is required to enable these endpoints: ```ruby -DatadogAPIClient::V1.configure do |config| - config.unstable_operations[:'<unstable_operation_id>'] = true +DatadogAPIClient.configure do |config| + config.unstable_operations[:'<api_version>.<unstable_operation_id>'] = true end ``` where `<unstable_operation_id>` is the name of the method used to interact with that endpoint. For example: `list_log_indexes`, or `get_logs_index` ### Changing Server When talking to a different server, like the `eu` instance, change the `server_variables` on your configuration object: ```ruby -config = DatadogAPIClient::V1::Configuration.new +config = DatadogAPIClient::Configuration.new config.server_variables["site"] = "datadoghq.eu" -client = DatadogAPIClient::V1::APIClient.new(config) +client = DatadogAPIClient::APIClient.new(config) ``` ### Disable compressed payloads If you want to disable GZIP compressed responses, set the `compress` flag on your configuration object: ```ruby -config = DatadogAPIClient::V1::Configuration.new +config = DatadogAPIClient::Configuration.new config.compress = false -client = DatadogAPIClient::V1::APIClient.new(config) +client = DatadogAPIClient::APIClient.new(config) ``` ### Enable requests logging If you want to enable requests logging, set the `debugging` flag on your configuration object: ```ruby -config = DatadogAPIClient::V1::Configuration.new +config = DatadogAPIClient::Configuration.new config.debugging = true -client = DatadogAPIClient::V1::APIClient.new(config) +client = DatadogAPIClient::APIClient.new(config) ``` ### Pagination Several listing operations have a pagination method to help consume all the items available. For example, to retrieve all your incidents: ```ruby require "datadog_api_client" -DatadogAPIClient::V2.configure do |config| - config.unstable_operations[:list_incidents] = true +DatadogAPIClient.configure do |config| + config.unstable_operations[:'v2.list_incidents'] = true end api_instance = DatadogAPIClient::V2::IncidentsAPI.new api_instance.list_incidents_with_pagination() do |incident| p incident.id end