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

Update API docs to show examples to show array query params #6086

Open
1 task done
nataliefiann opened this issue Sep 18, 2024 · 0 comments
Open
1 task done

Update API docs to show examples to show array query params #6086

nataliefiann opened this issue Sep 18, 2024 · 0 comments
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear

Comments

@nataliefiann
Copy link
Contributor

nataliefiann commented Sep 18, 2024

Contributions

  • I have read the contribution docs, and understand what's expected of me.

Link to the page on docs.getdbt.com requiring updates

https://docs.getdbt.com/dbt-cloud/api-v2#/operations/List%20Runs

What part(s) of the page would you like to see updated?

With ref to Slack thread raised by Miguel in CS, an enterprise customer raised some feedback about the List Run API.

They mentioned they experienced some issues figuring the format to pass the values as range and suggested it would help if there were a few examples involving array query params.

Miguel mentioned, whilst the documentation says that the finished_at__range field should be an array, he thinks it may better if there are samples. He found a resolution with finished_at__range being ["{start_date}", "{end_date}"] like ["yyyy-mm-dd", "yyyy-mm-dd"] or ["yyyy-mm-dd hh:mm:ss", "yyyy-mm-dd hh:mm:ss"] .

Additional information

APIexample1
APIexample2

@nataliefiann nataliefiann added content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear labels Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear
Projects
None yet
Development

No branches or pull requests

1 participant