feat re-add swagger grouping + fix gradle file

12urenloop · Mar 28, 2024 · c322ab0 · c322ab0
1 parent f0ef082
commit c322ab0
Show file tree

Hide file tree

Showing 13 changed files with 28 additions and 1 deletion.
diff --git a/build.gradle b/build.gradle
@@ -45,7 +45,9 @@ idea {
         inheritOutputDirs = true
     }
 }
-build.finalizedBy(javadoc)
+build {
+    finalizedBy(javadoc)
+}
 
 dependencies {
     // Web framework stuff

diff --git a/src/main/java/telraam/api/AcceptedLapsResource.java b/src/main/java/telraam/api/AcceptedLapsResource.java
@@ -1,6 +1,7 @@
 package telraam.api;
 
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.ws.rs.GET;
 import jakarta.ws.rs.Path;
 import jakarta.ws.rs.Produces;
@@ -11,6 +12,7 @@
 import java.util.List;
 
 @Path("/accepted-laps")
+@Tag(name="Accpted Laps")
 @Produces(MediaType.APPLICATION_JSON)
 public class AcceptedLapsResource {
     @GET

diff --git a/src/main/java/telraam/api/BatonResource.java b/src/main/java/telraam/api/BatonResource.java
@@ -1,6 +1,7 @@
 package telraam.api;
 
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.ws.rs.Path;
 import jakarta.ws.rs.Produces;
 import jakarta.ws.rs.core.MediaType;
@@ -11,6 +12,7 @@
 import java.util.Optional;
 
 @Path("/baton") // dropwizard
+@Tag(name = "Baton")
 @Produces(MediaType.APPLICATION_JSON)
 public class BatonResource extends AbstractListableResource<Baton> {
     public BatonResource(BatonDAO dao) {

diff --git a/src/main/java/telraam/api/BatonSwitchoverResource.java b/src/main/java/telraam/api/BatonSwitchoverResource.java
@@ -1,6 +1,7 @@
 package telraam.api;
 
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.ws.rs.Path;
 import jakarta.ws.rs.Produces;
 import jakarta.ws.rs.core.MediaType;
@@ -11,6 +12,7 @@
 import java.util.Optional;
 
 @Path("/batonswitchover") // dropwizard
+@Tag(name="Baton Switchover")
 @Produces(MediaType.APPLICATION_JSON)
 public class BatonSwitchoverResource extends AbstractListableResource<BatonSwitchover> {
     public BatonSwitchoverResource(BatonSwitchoverDAO dao) {

diff --git a/src/main/java/telraam/api/DetectionResource.java b/src/main/java/telraam/api/DetectionResource.java
@@ -1,6 +1,7 @@
 package telraam.api;
 
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.ws.rs.*;
 import jakarta.ws.rs.core.MediaType;
 import telraam.database.daos.DetectionDAO;
@@ -11,6 +12,7 @@
 
 @Path("/detection")
 @Produces(MediaType.APPLICATION_JSON)
+@Tag(name="Detection")
 public class DetectionResource extends AbstractListableResource<Detection> {
 
     private final DetectionDAO detectionDAO;

diff --git a/src/main/java/telraam/api/LapCountResource.java b/src/main/java/telraam/api/LapCountResource.java
@@ -1,6 +1,7 @@
 package telraam.api;
 
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.ws.rs.*;
 import jakarta.ws.rs.core.MediaType;
 import telraam.database.daos.TeamDAO;
@@ -13,6 +14,7 @@
 import java.util.Optional;
 
 @Path("/lap-counts")
+@Tag(name="Lap Counts")
 @Produces(MediaType.APPLICATION_JSON)
 public class LapCountResource {
     TeamDAO teamDAO;

diff --git a/src/main/java/telraam/api/LapResource.java b/src/main/java/telraam/api/LapResource.java
@@ -1,6 +1,7 @@
 package telraam.api;
 
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.ws.rs.*;
 import jakarta.ws.rs.core.MediaType;
 import telraam.database.daos.LapDAO;
@@ -10,6 +11,7 @@
 import java.util.Optional;
 
 @Path("/lap")
+@Tag(name="Lap")
 @Produces(MediaType.APPLICATION_JSON)
 public class LapResource extends AbstractResource<Lap> {
     private final LapDAO lapDAO;

diff --git a/src/main/java/telraam/api/LapSourceResource.java b/src/main/java/telraam/api/LapSourceResource.java
@@ -1,6 +1,7 @@
 package telraam.api;
 
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.ws.rs.*;
 import jakarta.ws.rs.core.MediaType;
 import telraam.database.daos.DAO;
@@ -10,6 +11,7 @@
 import java.util.Optional;
 
 @Path("/lap-source")
+@Tag(name = "Lap Source")
 @Produces(MediaType.APPLICATION_JSON)
 public class LapSourceResource extends AbstractListableResource<LapSource> {
     public LapSourceResource(DAO<LapSource> dao) {

diff --git a/src/main/java/telraam/api/LapSourceSwitchoverResource.java b/src/main/java/telraam/api/LapSourceSwitchoverResource.java
@@ -1,6 +1,7 @@
 package telraam.api;
 
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.ws.rs.*;
 import jakarta.ws.rs.core.MediaType;
 import telraam.database.daos.LapSourceSwitchoverDAO;
@@ -10,6 +11,7 @@
 import java.util.Optional;
 
 @Path("/lapsourceswitchover") // dropwizard
+@Tag(name="Lap Source Switchover")
 @Produces(MediaType.APPLICATION_JSON)
 public class LapSourceSwitchoverResource extends AbstractListableResource<LapSourceSwitchover> {
     public LapSourceSwitchoverResource(LapSourceSwitchoverDAO dao) {

diff --git a/src/main/java/telraam/api/MonitoringResource.java b/src/main/java/telraam/api/MonitoringResource.java
@@ -1,6 +1,7 @@
 package telraam.api;
 
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import org.jdbi.v3.core.Jdbi;
 import telraam.database.daos.*;
 import telraam.database.models.Lap;
@@ -17,9 +18,11 @@
 
 import jakarta.ws.rs.*;
 import jakarta.ws.rs.core.MediaType;
+
 import java.util.*;
 
 @Path("/monitoring")
+@Tag(name = "Monitoring")
 @Produces(MediaType.APPLICATION_JSON)
 public class MonitoringResource {
     private final BatonStatusHolder batonStatusHolder;

diff --git a/src/main/java/telraam/api/StationResource.java b/src/main/java/telraam/api/StationResource.java
@@ -1,6 +1,7 @@
 package telraam.api;
 
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.ws.rs.Produces;
 import telraam.database.daos.DAO;
 import telraam.database.models.Station;
@@ -11,6 +12,7 @@
 import java.util.Optional;
 
 @Path("/station")
+@Tag(name="Station")
 @Produces(MediaType.APPLICATION_JSON)
 public class StationResource extends AbstractListableResource<Station> {
     public StationResource(DAO<Station> dao) {

diff --git a/src/main/java/telraam/api/TeamResource.java b/src/main/java/telraam/api/TeamResource.java
@@ -1,6 +1,7 @@
 package telraam.api;
 
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.ws.rs.Produces;
 import telraam.database.daos.BatonSwitchoverDAO;
 import telraam.database.daos.TeamDAO;
@@ -17,6 +18,7 @@
 
 
 @Path("/team")
+@Tag(name="Team")
 @Produces(MediaType.APPLICATION_JSON)
 public class TeamResource extends AbstractListableResource<Team> {
     BatonSwitchoverDAO batonSwitchoverDAO;

diff --git a/src/main/java/telraam/api/TimeResource.java b/src/main/java/telraam/api/TimeResource.java
@@ -1,12 +1,14 @@
 package telraam.api;
 
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.ws.rs.GET;
 import jakarta.ws.rs.Path;
 import jakarta.ws.rs.Produces;
 import jakarta.ws.rs.core.MediaType;
 
 @Path("/time")
+@Tag(name = "Time")
 @Produces(MediaType.APPLICATION_JSON)
 public class TimeResource {
     static class TimeResponse {