Mark hosts response version fields as nullable (#1261)

* handle nested nullable items

* Regenerate client from commit 37d94b14 of spec repo

Co-authored-by: Sherzod Karimov <[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.6.4",
-            "regenerated": "2022-12-19 10:28:53.334299",
-            "spec_repo_commit": "45a3d9c9"
+            "regenerated": "2022-12-19 15:44:19.631812",
+            "spec_repo_commit": "37d94b14"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-12-19 10:28:53.345908",
-            "spec_repo_commit": "45a3d9c9"
+            "regenerated": "2022-12-19 15:44:19.647393",
+            "spec_repo_commit": "37d94b14"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -3419,6 +3419,7 @@ components:
           items:
             description: The version name.
             example: FreeBSD
+            nullable: true
             type: string
           type: array
         gohai:
@@ -3434,6 +3435,7 @@ components:
           items:
             description: Version name.
             example: Mac
+            nullable: true
             type: string
           type: array
         machine:
@@ -3445,6 +3447,7 @@ components:
           items:
             description: Version name.
             example: Ubuntu
+            nullable: true
             type: string
           type: array
         platform:
@@ -3472,6 +3475,7 @@ components:
           items:
             description: Version name.
             example: Windows
+            nullable: true
             type: string
           type: array
       type: object

.generator/src/generator/openapi.py

@@ -37,7 +37,10 @@ def type_to_python_helper(type_, schema, alternative_name=None, in_list=False):
     elif type_ == "boolean":
         return "bool"
     elif type_ == "array":
-        return "[{}]".format(type_to_python(schema["items"], in_list=True))
+        subtype = type_to_python(schema["items"], in_list=True)
+        if schema["items"].get("nullable"):
+             subtype += ", none_type"
+        return "[{}]".format(subtype)
     elif type_ == "object":
         if "additionalProperties" in schema:
             nested_schema = schema["additionalProperties"]

src/datadog_api_client/v1/model/host_meta.py

@@ -8,6 +8,7 @@
 from datadog_api_client.model_utils import (
     ModelNormal,
     cached_property,
+    none_type,
     unset,
     UnsetType,
 )
@@ -28,18 +29,18 @@ def openapi_types(_):
             "agent_checks": ([AgentCheck],),
             "agent_version": (str,),
             "cpu_cores": (int,),
-            "fbsd_v": ([str],),
+            "fbsd_v": ([str, none_type],),
             "gohai": (str,),
             "install_method": (HostMetaInstallMethod,),
-            "mac_v": ([str],),
+            "mac_v": ([str, none_type],),
             "machine": (str,),
-            "nix_v": ([str],),
+            "nix_v": ([str, none_type],),
             "platform": (str,),
             "processor": (str,),
             "python_v": (str,),
             "socket_fqdn": (str,),
             "socket_hostname": (str,),
-            "win_v": ([str],),
+            "win_v": ([str, none_type],),
         }
 
     attribute_map = {
@@ -92,7 +93,7 @@ def __init__(
         :type cpu_cores: int, optional
 
         :param fbsd_v: An array of Mac versions.
-        :type fbsd_v: [str], optional
+        :type fbsd_v: [str, none_type], optional
 
         :param gohai: JSON string containing system information.
         :type gohai: str, optional
@@ -101,13 +102,13 @@ def __init__(
         :type install_method: HostMetaInstallMethod, optional
 
         :param mac_v: An array of Mac versions.
-        :type mac_v: [str], optional
+        :type mac_v: [str, none_type], optional
 
         :param machine: The machine architecture.
         :type machine: str, optional
 
         :param nix_v: Array of Unix versions.
-        :type nix_v: [str], optional
+        :type nix_v: [str, none_type], optional
 
         :param platform: The OS platform.
         :type platform: str, optional
@@ -125,7 +126,7 @@ def __init__(
         :type socket_hostname: str, optional
 
         :param win_v: An array of Windows versions.
-        :type win_v: [str], optional
+        :type win_v: [str, none_type], optional
         """
         if agent_checks is not unset:
             kwargs["agent_checks"] = agent_checks

src/datadog_api_client/v1/model/metrics_query_metadata.py

@@ -45,7 +45,7 @@ def openapi_types(_):
             "scope": (str,),
             "start": (int,),
             "tag_set": ([str],),
-            "unit": ([MetricsQueryUnit],),
+            "unit": ([MetricsQueryUnit, none_type],),
         }
 
     attribute_map = {
@@ -138,7 +138,7 @@ def __init__(
         :param unit: Detailed information about the metric unit.
             First element describes the "primary unit" (for example, ``bytes`` in ``bytes per second`` ),
             second describes the "per unit" (for example, ``second`` in ``bytes per second`` ).
-        :type unit: [MetricsQueryUnit], optional
+        :type unit: [MetricsQueryUnit, none_type], optional
         """
         if aggr is not unset:
             kwargs["aggr"] = aggr

src/datadog_api_client/v1/model/slo_history_metrics_series_metadata.py

@@ -31,7 +31,7 @@ def openapi_types(_):
             "metric": (str,),
             "query_index": (int,),
             "scope": (str,),
-            "unit": ([SLOHistoryMetricsSeriesMetadataUnit], none_type),
+            "unit": ([SLOHistoryMetricsSeriesMetadataUnit, none_type], none_type),
         }
 
     attribute_map = {
@@ -74,7 +74,7 @@ def __init__(
         :param unit: An array of metric units that contains up to two unit objects.
             For example, bytes represents one unit object and bytes per second represents two unit objects.
             If a metric query only has one unit object, the second array element is null.
-        :type unit: [SLOHistoryMetricsSeriesMetadataUnit], none_type, optional
+        :type unit: [SLOHistoryMetricsSeriesMetadataUnit, none_type], none_type, optional
         """
         if aggr is not unset:
             kwargs["aggr"] = aggr

tests/v1/cassettes/test_scenarios/test_get_all_hosts_with_metadata_deserializes_successfully.yaml

@@ -8,7 +8,7 @@ interactions:
     uri: https://api.datadoghq.com/api/v1/hosts?include_hosts_metadata=true
   response:
     body:
-      string: '{"exact_total_matching":true,"total_returned":1,"host_list":[{"last_reported_time":1640288946,"name":"vagrant","is_muted":false,"mute_timeout":null,"apps":["ntp","agent"],"tags_by_source":{"Datadog":["host:vagrant"]},"up":true,"metrics":{"load":0.031666666,"iowait":0.0434962,"cpu":0.6632819},"sources":["agent"],"meta":{"socket-hostname":"vagrant","nixV":["ubuntu","18.04",""],"pythonV":"3.8.11","macV":["","",""],"cpuCores":1,"agent_flavor":"agent","platform":"linux","timezones":["UTC"],"winV":["","",""],"machine":"amd64","install_method":{"tool":"install_script","installer_version":"install_script-1.7.1","tool_version":"install_script"},"fbsdV":["","",""],"gohai":"{\"cpu\":{\"cache_size\":\"8192
+      string: '{"exact_total_matching":true,"total_returned":1,"host_list":[{"last_reported_time":1640288946,"name":"vagrant","is_muted":false,"mute_timeout":null,"apps":["ntp","agent"],"tags_by_source":{"Datadog":["host:vagrant"]},"up":true,"metrics":{"load":0.031666666,"iowait":0.0434962,"cpu":0.6632819},"sources":["agent"],"meta":{"socket-hostname":"vagrant","nixV":["ubuntu","18.04",""],"pythonV":"3.8.11","macV":["","",""],"cpuCores":1,"agent_flavor":"agent","platform":"linux","timezones":["UTC"],"winV":[null,null,null],"machine":"amd64","install_method":{"tool":"install_script","installer_version":"install_script-1.7.1","tool_version":"install_script"},"fbsdV":["","",""],"gohai":"{\"cpu\":{\"cache_size\":\"8192
         KB\",\"cpu_cores\":\"1\",\"cpu_logical_processors\":\"1\",\"family\":\"6\",\"mhz\":\"2711.998\",\"model\":\"142\",\"model_name\":\"Intel(R)
         Core(TM) i7-8559U CPU @ 2.70GHz\",\"stepping\":\"10\",\"vendor_id\":\"GenuineIntel\"},\"filesystem\":[{\"kb_size\":\"3966892\",\"mounted_on\":\"/dev\",\"name\":\"udev\"},{\"kb_size\":\"797396\",\"mounted_on\":\"/run\",\"name\":\"tmpfs\"},{\"kb_size\":\"64800356\",\"mounted_on\":\"/\",\"name\":\"/dev/mapper/vagrant--vg-root\"},{\"kb_size\":\"3986968\",\"mounted_on\":\"/dev/shm\",\"name\":\"tmpfs\"},{\"kb_size\":\"5120\",\"mounted_on\":\"/run/lock\",\"name\":\"tmpfs\"},{\"kb_size\":\"3986968\",\"mounted_on\":\"/sys/fs/cgroup\",\"name\":\"tmpfs\"},{\"kb_size\":\"488245288\",\"mounted_on\":\"/vagrant\",\"name\":\"/vagrant\"},{\"kb_size\":\"797392\",\"mounted_on\":\"/run/user/1000\",\"name\":\"tmpfs\"}],\"memory\":{\"swap_total\":\"1003516kB\",\"total\":\"7973940kB\"},\"network\":{\"interfaces\":[{\"ipv4\":\"10.0.2.15\",\"ipv4-network\":\"10.0.2.0/24\",\"ipv6\":\"fe80::a00:27ff:fec2:be11\",\"ipv6-network\":\"fe80::/64\",\"macaddress\":\"08:00:27:c2:be:11\",\"name\":\"eth0\"},{\"ipv4\":\"192.168.122.1\",\"ipv4-network\":\"192.168.122.0/24\",\"macaddress\":\"52:54:00:6f:1c:bf\",\"name\":\"virbr0\"}],\"ipaddress\":\"10.0.2.15\",\"ipaddressv6\":\"fe80::a00:27ff:fec2:be11\",\"macaddress\":\"08:00:27:c2:be:11\"},\"platform\":{\"GOOARCH\":\"amd64\",\"GOOS\":\"linux\",\"goV\":\"1.16.7\",\"hardware_platform\":\"x86_64\",\"hostname\":\"vagrant\",\"kernel_name\":\"Linux\",\"kernel_release\":\"4.15.0-29-generic\",\"kernel_version\":\"#31-Ubuntu
         SMP Tue Jul 17 15:39:52 UTC 2018\",\"machine\":\"x86_64\",\"os\":\"GNU/Linux\",\"processor\":\"x86_64\",\"pythonV\":\"2.7.15rc1\"}}","network":null,"logs_agent":{"transport":""},"host_id":1036078308,"agent_version":"7.32.3","processor":"Intel(R)