datadog_api_client 2.13.0 → 2.14.0

data/.generator/src/generator/formatter.py

@@ -2,7 +2,6 @@
 import pathlib
 import json
 import re
-import warnings
 from functools import singledispatch
 
 
@@ -185,6 +184,8 @@ def _format_oneof(data, schema, name_prefix=None, replace_values=None):
     matched = 0
     for sub_schema in schema["oneOf"]:
         try:
+            if "items" in sub_schema and not isinstance(data, list):
+                continue
             formatted = format_data_with_schema(
                 data,
                 sub_schema,
@@ -196,13 +197,11 @@ def _format_oneof(data, schema, name_prefix=None, replace_values=None):
                 # parameters += formatted
                 parameters = formatted
             matched += 1
-        except (KeyError, ValueError):
+        except (KeyError, ValueError, TypeError):
             pass
 
-    if matched == 0:
+    if matched != 1:
         raise ValueError(f"[{matched}] {data} is not valid for schema")
-    elif matched > 1:
-        warnings.warn(f"[{matched}] {data} is not valid for schema")
 
     return parameters
 
@@ -246,11 +245,28 @@ def format_data_with_schema(
                 def open_file(x):
                     return f"File.open({repr(x)}, 'r')"
 
+                def format_number(x):
+                    if isinstance(x, (bool, str)):
+                        raise TypeError(f"{x} is not supported type {schema}")
+                    return str(x)
+
+                def format_string(x):
+                    if isinstance(x, bool):
+                        raise TypeError(f"{x} is not supported type {schema}")
+                    if schema.get("format") == "binary":
+                        return open_file(x)
+                    return repr(x)
+
+                def format_boolean(x):
+                    if not isinstance(x, bool):
+                        raise TypeError(f"{x} is not supported type {schema}")
+                    return "true" if x else "false"
+
                 formatter = {
-                    "number": str,
-                    "integer": str,
-                    "boolean": lambda x: "true" if x else "false",
-                    "string": open_file if schema.get("format") == "binary" else repr,
+                    "number": format_number,
+                    "integer": format_number,
+                    "boolean": format_boolean,
+                    "string": format_string,
                     None: repr,
                 }[schema.get("type")]
 
@@ -281,18 +297,7 @@ def format_data_with_schema_list(
     name = get_name(schema)
 
     if "oneOf" in schema:
-        for sub_schema in schema["oneOf"]:
-            try:
-                value = format_data_with_schema(
-                    data,
-                    sub_schema,
-                    replace_values=replace_values,
-                    default_name=name,
-                )
-            except (KeyError, ValueError):
-                continue
-            return value
-        raise ValueError(f"{data} is not valid oneOf {schema}")
+        return _format_oneof(data, schema, name_prefix=name_prefix, replace_values=replace_values)
 
     parameters = ""
     for d in data:
@@ -324,7 +329,7 @@ def format_data_with_schema_dict(
         missing = required_properties - set(data.keys())
         if missing:
             raise ValueError(f"missing required properties: {missing}")
-        
+
         for k, v in data.items():
             if k not in schema["properties"]:
                 continue
@@ -355,18 +360,18 @@ def format_data_with_schema_dict(
         if default_name and not schema.get("additionalProperties") and schema.get("properties"):
             name = default_name
         else:
-            name = "dict"
-            warnings.warn(f"Unnamed schema {schema} for {data}")
+            if not parameters and data:
+                parameters = ", ".join(f"\"{k}\": \"{v}\"" for k, v in data.items())
+            return f"{{\n{parameters}}}"
 
     if "oneOf" in schema:
         name = None
         parameters = _format_oneof(data, schema, name_prefix=name_prefix, replace_values=replace_values)
 
-    if name == "dict":
-        if not parameters and data:
-            parameters = ", ".join(f"\"{k}\": \"{v}\"" for k, v in data.items())
-        return f"{{\n{parameters}}}"
-    elif name:
+    if parameters == "" and schema.get("type") == "string":
+        raise ValueError(f"No schema matched for {data}")
+
+    if name:
         return f"{name_prefix}{name}.new({{\n{parameters}}})"
 
     return parameters

data/.generator/src/generator/templates/api_client.j2

@@ -44,71 +44,99 @@ module {{ module_name }}
     #   the data deserialized from response body (could be nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
       request = build_request(http_method, path, opts)
-      if opts[:stream_body]
-        tempfile = nil
-        encoding = nil
-
-        response = request.perform do | chunk |
-          unless tempfile
-            content_disposition = chunk.http_response.header['Content-Disposition']
-            if content_disposition && content_disposition =~ /filename=/i
-              filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-              prefix = sanitize_filename(filename)
-            else
-              prefix = 'download-'
-            end
-            prefix = prefix + '-' unless prefix.end_with?('-')
-            unless encoding
-              encoding = chunk.encoding
+      attempt = 0
+      loop do
+        if opts[:stream_body]
+          tempfile = nil
+          encoding = nil
+
+          response = request.perform do | chunk |
+            unless tempfile
+              content_disposition = chunk.http_response.header['Content-Disposition']
+              if content_disposition && content_disposition =~ /filename=/i
+                filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+                prefix = sanitize_filename(filename)
+              else
+                prefix = 'download-'
+              end
+              prefix = prefix + '-' unless prefix.end_with?('-')
+              unless encoding
+                encoding = chunk.encoding
+              end
+              tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+              @tempfile = tempfile
             end
-            tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
-            @tempfile = tempfile
+            chunk.force_encoding(encoding)
+            tempfile.write(chunk)
+          end
+          if tempfile
+            tempfile.close
+            @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                              "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                              "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                              "explicitly with `tempfile.delete`"
           end
-          chunk.force_encoding(encoding)
-          tempfile.write(chunk)
+        else
+          response = request.perform
         end
-        if tempfile
-          tempfile.close
-          @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
-                            "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                            "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                            "explicitly with `tempfile.delete`"
+
+        if @config.debugging
+          @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
         end
-      else
-        response = request.perform
-      end
 
-      if @config.debugging
-        @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
-      end
+        unless response.success?
+          if response.request_timeout?
+            fail APIError.new('Connection timed out')
+          elsif response.code == 0
+            # Errors from libcurl will be made visible here
+            fail APIError.new(:code => 0,
+                              :message => response.return_message)
+          else
+            body = response.body
+            if response.headers['Content-Encoding'].eql?('gzip') && !(body.nil? || body.empty?) then
+              gzip = Zlib::Inflate.new(Zlib::MAX_WBITS + 16)
+              body = gzip.inflate(body)
+              gzip.close
+            end
+            if should_retry(attempt, @config.max_retries, response.code, @config.enable_retry)
+              sleep calculate_retry_interval(response, @config.backoff_base, @config.backoff_multiplier, attempt, @config.timeout)
+              attempt = attempt + 1
+              next
+            else
+              fail APIError.new(:code => response.code,
+                :response_headers => response.headers,
+                :response_body => body),
+              response.message
+            end
+          end
+        end
 
-      unless response.success?
-        if response.request_timeout?
-          fail APIError.new('Connection timed out')
-        elsif response.code == 0
-          # Errors from libcurl will be made visible here
-          fail APIError.new(:code => 0,
-                            :message => response.return_message)
+        if opts[:return_type]
+          data = deserialize(opts[:api_version], response, opts[:return_type])
         else
-          body = response.body
-          if response.headers['Content-Encoding'].eql?('gzip') && !(body.nil? || body.empty?) then
-            gzip = Zlib::Inflate.new(Zlib::MAX_WBITS + 16)
-            body = gzip.inflate(body)
-            gzip.close
-          end
-          fail APIError.new(:code => response.code,
-                            :response_headers => response.headers,
-                            :response_body => body),
-               response.message
+          data = nil
         end
+        return data, response.code, response.headers
       end
+    end
+
+    # Check if an http request should be retried
+    def should_retry(attempt, max_retries, http_code, enable_retry)
+      (http_code == 429 || http_code >= 500) && max_retries > attempt && enable_retry
+    end
 
-      if opts[:return_type]
-        data = deserialize(opts[:api_version], response, opts[:return_type])
+    # Calculate the sleep interval between 2 retry attempts
+    def calculate_retry_interval(response, backoff_base, backoff_multiplier, attempt, timeout)
+      reset_header = response.headers['X-Ratelimit-Reset']
+      if  !reset_header.nil? && !reset_header.empty?
+        sleep_time = reset_header.to_i
       else
-        data = nil
+        sleep_time = (backoff_multiplier**attempt) * backoff_base
+        if timeout && timeout > 0
+          sleep_time = [timeout, sleep_time].min
+        end
       end
-      return data, response.code, response.headers
+      sleep_time
     end
 
     # Build the HTTP request

data/.generator/src/generator/templates/configuration.j2

@@ -138,6 +138,16 @@ module {{ module_name }}
     # Password for proxy server authentication
     attr_accessor :http_proxypass
 
+    # Enable retry when rate limited
+    attr_accessor :enable_retry
+
+    # Retry backoff calculation parameters
+    attr_accessor :backoff_base
+    attr_accessor :backoff_multiplier
+
+    # Maximum number of retry attempts allowed
+    attr_accessor :max_retries
+
     def initialize
       {%- set default_server = openapi.servers[0]|format_server %}
       @scheme = '{{ default_server.scheme }}'
@@ -149,6 +159,10 @@ module {{ module_name }}
       @server_operation_variables = {}
       @api_key = {}
       @api_key_prefix = {}
+      @enable_retry = false
+      @backoff_base = 2
+      @backoff_multiplier = 2
+      @max_retries = 3
       @timeout = nil
       @client_side_validation = true
       @verify_ssl = true
@@ -188,6 +202,13 @@ module {{ module_name }}
       @@default ||= Configuration.new
     end
 
+    def backoff_base=(value)
+      if value < 2
+        raise ArgumentError, 'backoff_base cannot be smaller than 2'
+      end
+      @backoff_base = value
+    end
+
     def configure
       yield(self) if block_given?
     end

data/.pre-commit-config.yaml

@@ -19,7 +19,7 @@ repos:
     name: Format documentation
     stages: [manual]
     language: node
-    language_version: 14.12.0
+    language_version: 20.5.0
     entry: prettier --write --list-different --ignore-unknown README.md
     "types": [text]
     files: 'README.md'
@@ -27,7 +27,7 @@ repos:
     additional_dependencies:
       # When updating the version of prettier, make sure to check the  pre-commit file
       # And keep the `entry` here up to date https://github.com/pre-commit/mirrors-prettier/blob/master/.pre-commit-hooks.yaml
-      - prettier@2.5.1
+      - prettier@3.0.0
   - id: generator
     name: generator
     language: python

data/CHANGELOG.md

@@ -1,5 +1,36 @@
 # CHANGELOG
 
+## 2.14.0 / 2023-08-23
+
+### Fixed
+* Update team schemas by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1470
+* Mark downtime v2 start response as required by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1482
+* Document new properties and fix security monitoring schemas by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1469
+* Add missing CI App fields `page` and `test_level` by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1448
+### Added
+* Update stated limit for api/v2/metrics from 14 days to 30 days by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1476
+* Add missing sensitive data scanner fields by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1466
+* Add Workflow Executions to usage metering API by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1478
+* Add missing `type` field for OnDemandConcurrencyCap response by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1468
+* Add CI Visibility Intelligent Test Runner to usage metering API by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1477
+* Add custom_links to distribution widget schema by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1485
+* Add usage field `region` by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1486
+* Add `message` field to audit logs response by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1488
+* Add `tags` field to dashboard list response by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1487
+* API specs for user team memberships by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1495
+* Document `EQUAL` comparator by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1498
+* Add persistCookies option synthetics test request by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1497
+* Expose sds_scanned_bytes_usage in usage attribution API by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1501
+* Add support in azure integration endpoint for app service plan filters/cspm/custom metrics by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1496
+* Add APM and USM usage attribution type by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1494
+* Document new attributes for team models by @api-clients-generation-pipeline in https://github.com/DataDog/datadog-api-client-ruby/pull/1492
+* Add retry support  by @HantingZhang2 in https://github.com/DataDog/datadog-api-client-ruby/pull/1502
+
+## New Contributors
+* @HantingZhang2 made their first contribution in https://github.com/DataDog/datadog-api-client-ruby/pull/1502
+
+**Full Changelog**: https://github.com/DataDog/datadog-api-client-ruby/compare/v2.13.0...v2.14.0
+
 ## 2.13.0 / 2023-07-20
 
 ### Fixed

data/README.md

@@ -165,6 +165,29 @@ api_instance.list_incidents_with_pagination() do |incident|
 end
 ```
 
+### Retry
+
+To enable the client to retry when rate limited (status 429) or status 500 and above:
+
+```ruby
+config = DatadogAPIClient::Configuration.new
+config.enable_retry = true
+client = DatadogAPIClient::APIClient.new(config)
+```
+
+The interval between 2 retry attempts will be the value of the `x-ratelimit-reset` response header when available.
+If not, it will be :
+
+```ruby
+(config.backoffMultiplier ** current_retry_count) * config.backoffBase
+```
+
+The maximum number of retry attempts is `3` by default and can be modified with
+
+```ruby
+config.maxRetries
+```
+
 ## Documentation
 
 If you are interested in general documentation for all public Datadog API endpoints, checkout the [general documentation site][api docs].

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

@@ -4,9 +4,12 @@ require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AzureIntegrationAPI.new
 
 body = DatadogAPIClient::V1::AzureAccount.new({
+  app_service_plan_filters: "key:value,filter:example",
   automute: true,
   client_id: "testc7f6-1234-5678-9101-3fcbf464test",
   client_secret: "testingx./Sw*g/Y33t..R1cH+hScMDt",
+  cspm_enabled: true,
+  custom_metrics_enabled: true,
   errors: [
     "*",
   ],

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

@@ -4,9 +4,12 @@ require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AzureIntegrationAPI.new
 
 body = DatadogAPIClient::V1::AzureAccount.new({
+  app_service_plan_filters: "key:value,filter:example",
   automute: true,
   client_id: "testc7f6-1234-5678-9101-3fcbf464test",
   client_secret: "testingx./Sw*g/Y33t..R1cH+hScMDt",
+  cspm_enabled: true,
+  custom_metrics_enabled: true,
   errors: [
     "*",
   ],

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

@@ -4,9 +4,12 @@ require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AzureIntegrationAPI.new
 
 body = DatadogAPIClient::V1::AzureAccount.new({
+  app_service_plan_filters: "key:value,filter:example",
   automute: true,
   client_id: "testc7f6-1234-5678-9101-3fcbf464test",
   client_secret: "testingx./Sw*g/Y33t..R1cH+hScMDt",
+  cspm_enabled: true,
+  custom_metrics_enabled: true,
   errors: [
     "*",
   ],

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

@@ -4,9 +4,12 @@ require "datadog_api_client"
 api_instance = DatadogAPIClient::V1::AzureIntegrationAPI.new
 
 body = DatadogAPIClient::V1::AzureAccount.new({
+  app_service_plan_filters: "key:value,filter:example",
   automute: true,
   client_id: "testc7f6-1234-5678-9101-3fcbf464test",
   client_secret: "testingx./Sw*g/Y33t..R1cH+hScMDt",
+  cspm_enabled: true,
+  custom_metrics_enabled: true,
   errors: [
     "*",
   ],

data/examples/v1/dashboards/CreateDashboard_252716965.rb

@@ -13,6 +13,12 @@ body = DatadogAPIClient::V1::Dashboard.new({
         title_align: DatadogAPIClient::V1::WidgetTextAlign::LEFT,
         show_legend: false,
         type: DatadogAPIClient::V1::DistributionWidgetDefinitionType::DISTRIBUTION,
+        custom_links: [
+          DatadogAPIClient::V1::WidgetCustomLink.new({
+            label: "Example",
+            link: "https://example.org/",
+          }),
+        ],
         xaxis: DatadogAPIClient::V1::DistributionWidgetXAxis.new({
           max: "auto",
           include_zero: true,

data/examples/v1/dashboards/DeletePublicDashboardInvitation.rb

@@ -5,11 +5,11 @@ api_instance = DatadogAPIClient::V1::DashboardsAPI.new
 
 body = DatadogAPIClient::V1::SharedDashboardInvites.new({
   data: [
-    SharedDashboardInvitesDataObject.new({
-      attributes: SharedDashboardInvitesDataObjectAttributes.new({
+    DatadogAPIClient::V1::SharedDashboardInvitesDataObject.new({
+      attributes: DatadogAPIClient::V1::SharedDashboardInvitesDataObjectAttributes.new({
         email: "test@datadoghq.com",
       }),
-      type: DashboardInviteType::PUBLIC_DASHBOARD_INVITATION,
+      type: DatadogAPIClient::V1::DashboardInviteType::PUBLIC_DASHBOARD_INVITATION,
     }),
   ],
 })

data/examples/v1/synthetics/CreateSyntheticsAPITest_1487281163.rb

@@ -77,6 +77,7 @@ body = DatadogAPIClient::V1::SyntheticsAPITest.new({
         token_api_authentication: DatadogAPIClient::V1::SyntheticsBasicAuthOauthTokenApiAuthentication::HEADER,
         type: DatadogAPIClient::V1::SyntheticsBasicAuthOauthClientType::OAUTH_CLIENT,
       }),
+      persist_cookies: true,
     }),
   }),
   locations: [

data/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent.rb

@@ -1,6 +1,9 @@
 # Send pipeline event returns "Request accepted for processing" response
 
 require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.create_ci_app_pipeline_event".to_sym] = true
+end
 api_instance = DatadogAPIClient::V2::CIVisibilityPipelinesAPI.new
 
 body = DatadogAPIClient::V2::CIAppCreatePipelineEventRequest.new({

data/examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent_129899466.rb

@@ -1,6 +1,9 @@
 # Send pipeline job event returns "Request accepted for processing" response
 
 require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.create_ci_app_pipeline_event".to_sym] = true
+end
 api_instance = DatadogAPIClient::V2::CIVisibilityPipelinesAPI.new
 
 body = DatadogAPIClient::V2::CIAppCreatePipelineEventRequest.new({

data/examples/v2/logs/AggregateLogs_2955613758.rb

@@ -29,7 +29,7 @@ body = DatadogAPIClient::V2::LogsAggregateRequest.new({
         aggregation: DatadogAPIClient::V2::LogsAggregationFunction::PERCENTILE_90,
         metric: "@duration",
       }),
-      total: true,
+      total: "recall",
     }),
   ],
 })

data/examples/v2/teams/CreateTeam.rb

@@ -6,8 +6,8 @@ api_instance = DatadogAPIClient::V2::TeamsAPI.new
 body = DatadogAPIClient::V2::TeamCreateRequest.new({
   data: DatadogAPIClient::V2::TeamCreate.new({
     attributes: DatadogAPIClient::V2::TeamCreateAttributes.new({
-      handle: "handle-a0fc0297eb519635",
-      name: "name-a0fc0297eb519635",
+      handle: "test-handle-a0fc0297eb519635",
+      name: "test-name-a0fc0297eb519635",
     }),
     relationships: DatadogAPIClient::V2::TeamCreateRelationships.new({
       users: DatadogAPIClient::V2::RelationshipToUsers.new({

data/examples/v2/teams/CreateTeam_252121814.rb

@@ -0,0 +1,24 @@
+# Create a team with V2 fields returns "CREATED" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::TeamsAPI.new
+
+body = DatadogAPIClient::V2::TeamCreateRequest.new({
+  data: DatadogAPIClient::V2::TeamCreate.new({
+    attributes: DatadogAPIClient::V2::TeamCreateAttributes.new({
+      handle: "test-handle-a0fc0297eb519635",
+      name: "test-name-a0fc0297eb519635",
+      avatar: "🥑",
+      banner: 7,
+      visible_modules: [
+        "m1",
+        "m2",
+      ],
+      hidden_modules: [
+        "m3",
+      ],
+    }),
+    type: DatadogAPIClient::V2::TeamType::TEAM,
+  }),
+})
+p api_instance.create_team(body)

data/examples/v2/teams/GetUserMemberships.rb

@@ -0,0 +1,8 @@
+# Get user memberships returns "Represents a user's association to a team" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::TeamsAPI.new
+
+# there is a valid "user" in the system
+USER_DATA_ID = ENV["USER_DATA_ID"]
+p api_instance.get_user_memberships(USER_DATA_ID)

data/examples/v2/teams/UpdateTeam.rb

@@ -13,6 +13,15 @@ body = DatadogAPIClient::V2::TeamUpdateRequest.new({
     attributes: DatadogAPIClient::V2::TeamUpdateAttributes.new({
       handle: DD_TEAM_DATA_ATTRIBUTES_HANDLE,
       name: "Example Team updated",
+      avatar: "🥑",
+      banner: 7,
+      hidden_modules: [
+        "m3",
+      ],
+      visible_modules: [
+        "m1",
+        "m2",
+      ],
     }),
     type: DatadogAPIClient::V2::TeamType::TEAM,
   }),