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

Improve documentation and code for 4CAT API calling #459

Open
sal-uva opened this issue Oct 15, 2024 · 2 comments
Open

Improve documentation and code for 4CAT API calling #459

sal-uva opened this issue Oct 15, 2024 · 2 comments
Labels
enhancement New feature or request

Comments

@sal-uva
Copy link
Collaborator

sal-uva commented Oct 15, 2024

I just integrated a 4CAT data source search call in a local python script and lo and behold.. it worked great! But at the moment it's a bit of a forgotten child. We should really improve the documentation and (some of) the code on this, because it's an amazing feature.

Things to improve:

  • Write documentation
    • How to retrieve an API key
    • What endpoints are available (queue-query, check-query, etc).
    • Have some kind of reference point for the options dictionaries per datasource and processors.
    • Scalar implementation?
  • Make sure "-search" doesn't need to be removed for data source IDs.
  • Set frontend-confirm to True by default.
  • Remove some of the old code that still assumes we're searching for text for every data source.
@sal-uva sal-uva added the enhancement New feature or request label Oct 15, 2024
@stijn-uva
Copy link
Member

stijn-uva commented Oct 15, 2024

We have auto-generated documentation at /api/spec/tool/swagger.json (see also /api/) that addresses some of the points above. We could update it and use something like Scalar to generate pretty documentation with it...

@sal-uva
Copy link
Collaborator Author

sal-uva commented Oct 15, 2024

That would be cool. And references on GitHub and 4cat.nl so people can actually find this option.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants