-
Notifications
You must be signed in to change notification settings - Fork 66
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
Adds API endpoints for Janeway core and Plugin versions. #4575
base: master
Are you sure you want to change the base?
Conversation
@@ -15,6 +15,8 @@ | |||
router.register(r'licences', views.LicenceViewSet, 'licence') | |||
router.register(r'keywords', views.KeywordsViewSet, 'keywords') | |||
router.register(r'accounts', views.AccountViewSet, 'accounts') | |||
router.register(r'versions', views.VersionViewSet, 'versions') | |||
router.register(r'plugins', views.PluginViewSet, 'plugins') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I left these as single quote for consistency.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When I proposed this feature I should have added a bit more detail on the use case. It is often important to get the exact version an installation is on, when doing support, so you know how to help them.
The way you've done it, by relying on the Janeway Version rather than the Git tag for this information, we are not always getting the exact version. There could be RCs, or there could be a version tagged but not propagated to the Version object, like the current 1.7.3 release (the Version object shows as 1.7.2). Is there a safe way to get and display the Git tag?
Also, I had actually imagined this would be public, not behind an Editor permissions decorator, to make it easy to write a script. (Security implications?) As it is, I don't know how you'd write a script for this. Do we offer token authentication? It is not in our documentation, so can you document it? https://janeway.readthedocs.io/en/v1.7.2/dev/api.html
No worries. I think there is a git module we can use and we can inject the tag into the JSON. I still think this endpoint is useful. I think it should be behind authentication. I’ll add some info to docs. |
|
Closes #4350