DataDog / datadog-api-client-typescript

Typescript client for the Datadog API

Home Page:http://datadoghq.dev/datadog-api-client-typescript/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

v1.searchSLO SearchSLOResponse does not match actual API response

mscharp opened this issue · comments

Describe the bug

  • Cannot use searchSLO without enabling "unstableOperations" (which doesn't seem to be documented anywhere).
  • The typescript types and parsing of the API response does not match what the actual API returns. For example, the api response is "data.attributes.slos" whereas the SearchSLOResponse has "data.attributes.slo".
  • SearchSLOResponse "data.attributes.unparsedObject" is undefined.
  • etc

Label the issue properly.

This api is unusable as a result of this bug.

To Reproduce
Steps to reproduce the behavior:

Use the typescript project to search for an SLO and use the response.

Expected behavior
SearchSLOResponse should have all properties populated and match the actual response from the API.

Screenshots
Screen Shot 2022-09-27 at 10 47 36 AM

Environment and Versions (please complete the following information):

  • "typescript": "^4.8.3"
  • "@datadog/datadog-api-client": "^1.3.0"

Hi,

The unstable status is documented, you can see the examples with the call here: https://docs.datadoghq.com/api/latest/service-level-objectives/?code-lang=typescript#search-for-slos or here: https://github.com/DataDog/datadog-api-client-typescript/blob/master/examples/v1/service-level-objectives/SearchSLO.ts.

The response body is completely inaccurate though. This should be fixed by #856 , thanks for your patience.

Thanks! Do you know when a new release will be made available?