bossenti commented on code in PR #1192:
URL: https://github.com/apache/streampipes/pull/1192#discussion_r1093566485
##########
streampipes-rest/src/main/java/org/apache/streampipes/rest/impl/Version.java:
##########
@@ -33,6 +34,7 @@ public class Version extends AbstractAuthGuardedRestResource {
@GET
@Path("/versions")
@Produces(MediaType.APPLICATION_JSON)
+ @Operation(summary = "Provides health-check and information about current
backend version.", tags = {"Version"})
Review Comment:
@tenthe @dominikriemer do we want to apply authentication here?
The endpoint itself doesn't require this for sure, but it could worth to
think about it as it would provide more information to a user. One would that
login/authentication was successfull, that the StreamPipes API is up and get
information about the version.
What do you think about it?
On the other side, one could expect such an endpoint to be publicly available
##########
streampipes-rest/src/main/java/org/apache/streampipes/rest/impl/Version.java:
##########
@@ -33,6 +34,7 @@ public class Version extends AbstractAuthGuardedRestResource {
@GET
@Path("/versions")
@Produces(MediaType.APPLICATION_JSON)
+ @Operation(summary = "Provides health-check and information about current
backend version.", tags = {"Version"})
Review Comment:
Alternatively, we could provide this endpoint twice: with and without
authentication
##########
streampipes-rest/src/main/java/org/apache/streampipes/rest/impl/Version.java:
##########
@@ -33,6 +34,7 @@ public class Version extends AbstractAuthGuardedRestResource {
@GET
@Path("/versions")
Review Comment:
I would propose to rename the endpoint to `check`, `health-check` or
`status`.
Any other ideas?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
