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

Set custom examples for some endpoints in queries_web #192

Closed
kkaris opened this issue Dec 19, 2024 · 1 comment
Closed

Set custom examples for some endpoints in queries_web #192

kkaris opened this issue Dec 19, 2024 · 1 comment

Comments

@kkaris
Copy link
Collaborator

kkaris commented Dec 19, 2024

Right now, there are some example parameter values for the api docs set up in the queries_web module, that are shared between multiple functions if these functions share a parameter with the same name. In some cases this leads to example queries that return empty results.

Potential fixes:

  • Add a 'corner case' nested dictionary, mapping function name -> parameter name -> parameter example value for those functions where we need a special example(s), while leaving most functions to use the default value in the examples dict.
  • Restructure the whole example setup to have examples set explicitly for all functions.
@kkaris
Copy link
Collaborator Author

kkaris commented Jan 8, 2025

Resolved by #193

@kkaris kkaris closed this as completed Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant