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

Documentation clarity for requested_columns #581

Open
4 tasks
josh-chamberlain opened this issue Jan 16, 2025 · 0 comments
Open
4 tasks

Documentation clarity for requested_columns #581

josh-chamberlain opened this issue Jan 16, 2025 · 0 comments
Labels
api documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@josh-chamberlain
Copy link
Contributor

Context

This is either a bug or a documentation issue!

  • When I try to use the param requested_columns: 'id,title' on GET /data-requests, I get a 500 error
    • commenting out this param fixes the issue
  • It's not clear to me whether accessing nested properties like locations.display_name should work, but ideally it would!

Requirements

  • make it clearer how to use the requested_columns param on GET /data-requests, and other endpoints where it is usable, if the syntax is more complicated than "comma-delimited" seems to imply
  • if something is broken, fix it!
  • if nested properties are not intended to be accessible this way, consider adding that ability

Tests

  • should probably test to make sure this param is working
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
Status: To do
Status: Todo
Development

No branches or pull requests

1 participant