Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AdditionalProperties and UnparsedObject are undocumented #2486

Open
mx-psi opened this issue May 8, 2024 · 1 comment
Open

AdditionalProperties and UnparsedObject are undocumented #2486

mx-psi opened this issue May 8, 2024 · 1 comment
Labels
documentation Documentation related changes stale Stale - Bot reminder

Comments

@mx-psi
Copy link
Member

mx-psi commented May 8, 2024

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.

Copy link

github-actions bot commented Jun 8, 2024

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.

@github-actions github-actions bot added the stale Stale - Bot reminder label Jun 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation related changes stale Stale - Bot reminder
Projects
None yet
Development

No branches or pull requests

1 participant