add new non-admin APIs for external tools registration (for marketplace) #11079
Conversation
stevenwinship
added
Size: 10
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
| This API is Superuser only. Note the endpoint difference (/api/externalTools instead of /api/admin/externalTools). | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| curl -s -H "X-Dataverse-key:$API_TOKEN" http://localhost:8080/api/externalTools |
There was a problem hiding this comment.
Obviously, only superusers should be able to ADD tools but have we considered allowing the guest user (no API token) LIST tools? (This would apply to the "list one tool" endpoint as well, of course.)
I don't THINK there would be any harm...
On a related note, it's now possible to list (without an API token), the exporters that are enabled:
I think it would be nice to have this for external tools as well. We could, of course, defer this and open up the listing API in a future pull request. I just thought I'd mention it.
There was a problem hiding this comment.
I can change it now. Makes sense and shouldn't be an issue
|
📦 Pushed preview images as 🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name. |
pdurbin
changed the title
There was a problem hiding this comment.
Tests are passing: https://jenkins.dataverse.org/job/IQSS-Dataverse-Develop-PR/job/PR-11079/7/testReport/
Approved. Ready for QA.
What this PR does / why we need it: The APIs for registering and listing external tools needs be accessible outside of admin (with proper authorization) to allow them to be called from the marketplace.
Which issue(s) this PR closes: #10930
Special notes for your reviewer:
Suggestions on how to test this: See IT tests. Test each API (admin and non-admin)
Does this PR introduce a user interface change? If mockups are available, please link/include them here: No
Is there a release notes update needed for this change?: Included
Additional documentation:
Preview docs at https://dataverse-guide--11079.org.readthedocs.build/en/11079/admin/external-tools.html#managing-external-tools