datadog-api-client-go icon indicating copy to clipboard operation
datadog-api-client-go copied to clipboard

`AdditionalProperties` and `UnparsedObject` are undocumented

Open mx-psi opened this issue 3 months ago • 1 comments

Describe the bug

All autogenerated structs have an AdditionalProperties and UnparsedObject. AdditionalProperties is used when using MarshalJSON to add any extra fields, but is currently undocumented. I don't know what the purpose of UnparsedObject is. We should document it!

To Reproduce Steps to reproduce the behavior:

  1. Go to https://datadoghq.dev/datadog-api-client-go/pkg/github.com/DataDog/datadog-api-client-go/v2/api/datadogV2/#MetricPayload
  2. See that these two fields are undocumented

Expected behavior

All fields have a docstring documenting what they do.

mx-psi avatar May 08 '24 11:05 mx-psi