search

DataDog / datadog-api-client-go

Golang client for the Datadog API
http://datadoghq.dev/datadog-api-client-go/
Apache License 2.0
126 stars 54 forks source link

`AdditionalProperties` and `UnparsedObject` are undocumented #2486

Open mx-psi opened 2 months ago

mx-psi commented 2 months ago

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.

github-actions[bot] commented 1 month ago

Thanks for your contribution!

This issue has been automatically marked as stale because it has not had activity in the last 30 days. Note that the issue will not be automatically closed, but this notification will remind us to investigate why there's been inactivity. Thank you for participating in the Datadog open source community.

If you would like this issue to remain open:

  1. Verify that you can still reproduce the issue in the latest version of this project.

  2. Comment that the issue is still reproducible and include updated details requested in the issue template.