[Breaking] Preserve integer precision in AdditionalProperties via UseNumber#4095
Merged
Conversation
JSON integers above 2^53 silently lost precision when the value landed
in a generated model's AdditionalProperties map. The generated
UnmarshalJSON populated that map via datadog.Unmarshal
(encoding/json.Unmarshal), which coerces JSON numbers into float64 for
interface{} targets.
Switch the additionalProperties decode in model_simple.j2 to a
UseNumber-enabled decoder via a new datadog.UnmarshalUseNumber helper
(added to encoding_json.j2 and goccy_gojson.j2 for both JSON backends).
Typed schema fields and existing decode paths are unaffected.
After regeneration, values in AdditionalProperties are json.Number
(string-backed) rather than float64. Callers can recover the original
integer via .(json.Number).Int64().
Fixes #4091.
charlie-zhang109
added
changelog/Changed
amaskara-dd
approved these changes
May 26, 2026
charlie-zhang109
changed the title
Contributor
Author
|
Confirmed with documentation team that 
|
…seNumber # Conflicts: # api/datadogV1/model_monitor_formula_and_function_event_query_definition_compute.go # api/datadogV1/model_monitor_formula_and_function_event_query_group_by.go # api/datadogV1/model_monitor_thresholds.go # api/datadogV1/model_monthly_usage_attribution_values.go # api/datadogV1/model_query_value_widget_request.go # api/datadogV1/model_synthetics_test_request.go # api/datadogV1/model_usage_summary_date.go # api/datadogV1/model_usage_summary_date_org.go # api/datadogV1/model_usage_summary_response.go # api/datadogV2/model_create_degradation_request_data_attributes.go # api/datadogV2/model_create_degradation_request_data_attributes_updates_items.go # api/datadogV2/model_create_degradation_request_data_attributes_updates_items_components_affected_items.go # api/datadogV2/model_create_maintenance_request_data_attributes.go # api/datadogV2/model_create_maintenance_request_data_attributes_updates_items.go # api/datadogV2/model_create_maintenance_request_data_attributes_updates_items_components_affected_items.go # api/datadogV2/model_degradation_data_attributes_updates_items.go # api/datadogV2/model_llm_obs_annotated_interaction_item.go # api/datadogV2/model_llm_obs_annotation_queue_interaction_item.go # api/datadogV2/model_llm_obs_annotation_queue_interaction_response_item.go # api/datadogV2/model_observability_pipeline_amazon_s3_generic_destination.go # api/datadogV2/model_observability_pipeline_cloud_prem_destination.go # api/datadogV2/model_observability_pipeline_databricks_zerobus_destination.go # api/datadogV2/model_observability_pipeline_http_client_destination.go # api/datadogV2/model_observability_pipeline_http_server_source.go # api/datadogV2/model_observability_pipeline_kafka_destination.go # api/datadogV2/model_observability_pipeline_splunk_hec_source.go # api/datadogV2/model_org_group_data.go # api/datadogV2/model_org_group_list_response.go # api/datadogV2/model_org_group_relationships.go # api/datadogV2/model_security_monitoring_rule_impossible_travel_options.go # api/datadogV2/model_single_aggregated_connection_response_data_attributes.go # api/datadogV2/model_synthetics_downtime_time_slot_recurrence_request.go # api/datadogV2/model_synthetics_downtime_time_slot_recurrence_response.go
gh-worker-dd-devflow-36fce6
Bot
added
mergequeue-status: done
and removed
mergequeue-status: waiting
labels
github-actions Bot
pushed a commit
to ConnectionMaster/datadog-api-client-go
that referenced
this pull request
May 27, 2026
…Number (DataDog#4095) * Preserve integer precision in AdditionalProperties via UseNumber JSON integers above 2^53 silently lost precision when the value landed in a generated model's AdditionalProperties map. The generated UnmarshalJSON populated that map via datadog.Unmarshal (encoding/json.Unmarshal), which coerces JSON numbers into float64 for interface{} targets. Switch the additionalProperties decode in model_simple.j2 to a UseNumber-enabled decoder via a new datadog.UnmarshalUseNumber helper (added to encoding_json.j2 and goccy_gojson.j2 for both JSON backends). Typed schema fields and existing decode paths are unaffected. After regeneration, values in AdditionalProperties are json.Number (string-backed) rather than float64. Callers can recover the original integer via .(json.Number).Int64(). Fixes DataDog#4091. * pre-commit fixes --------- Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> 0434e58
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #4091.
Summary
The generated
UnmarshalJSONfor every model with anadditionalPropertiesblock populatesAdditionalProperties map[string]interface{}viadatadog.Unmarshal, which is a thin wrapper aroundencoding/json.Unmarshal. The standard Go decoder unmarshals JSON numbers intointerface{}targets asfloat64, so integers above 2^53 silently lose precision. Typed schema fields decode into concrete*int64targets and are not affected.This PR switches the
additionalPropertiesdecode to aUseNumber-enabled decoder via a newdatadog.UnmarshalUseNumberhelper.Changes
.generator/src/generator/templates/encoding_json.j2— addUnmarshalUseNumberto the stdlib JSON backend..generator/src/generator/templates/goccy_gojson.j2— addUnmarshalUseNumberto thegoccy_gojsonbackend..generator/src/generator/templates/model_simple.j2— one-line change: theadditionalPropertiesdecode now callsdatadog.UnmarshalUseNumberinstead ofdatadog.Unmarshal.Templates-only — happy to regenerate the rendered output into the same PR if reviewers prefer that.
Behavioral contract change
After regeneration, values in
AdditionalPropertieswill bejson.Number(string-backed) rather thanfloat64.val.(float64)will break.val.(json.Number).Int64()or.Float64()get correct precision.Suggest
changelog/Changed+backward-incompatiblelabels.Test plan
api/datadog/encoding_json.go,api/datadog/goccy_gojson.go, and the ~100+ affectedmodel_*.gofiles matches expectation.additionalPropertiesand assert exact recovery via.(json.Number).Int64(). Happy to write this — flag if you'd like it in this PR or as a follow-up.