Merge pull request #77 from waterflow80/update-swagger-page

updated the swagger page's endpoints' names to more meaningful names
EBIvariation · Jan 29, 2024 · a2387cf · a2387cf
2 parents 1fa020c + eef729a
commit a2387cf
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 1 deletion.
diff --git a/src/main/java/uk/ac/ebi/eva/evaseqcol/controller/admin/AdminController.java b/src/main/java/uk/ac/ebi/eva/evaseqcol/controller/admin/AdminController.java
@@ -4,6 +4,7 @@
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
@@ -24,6 +25,7 @@
 
 @RequestMapping("/admin")
 @RestController
+@Tag(name = "Admin endpoints")
 public class AdminController {
 
     private SeqColService seqColService;

diff --git a/src/main/java/uk/ac/ebi/eva/evaseqcol/controller/seqcol/SeqColComparisonController.java b/src/main/java/uk/ac/ebi/eva/evaseqcol/controller/seqcol/SeqColComparisonController.java
@@ -4,6 +4,7 @@
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
@@ -23,6 +24,7 @@
 
 @RestController
 @RequestMapping("/comparison")
+@Tag(name = "Seqcol endpoints")
 public class SeqColComparisonController {
 
     private SeqColService seqColService;

diff --git a/src/main/java/uk/ac/ebi/eva/evaseqcol/controller/seqcol/SeqColController.java b/src/main/java/uk/ac/ebi/eva/evaseqcol/controller/seqcol/SeqColController.java
@@ -4,6 +4,7 @@
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
@@ -25,6 +26,7 @@
 
 @RestController
 @RequestMapping("/")
+@Tag(name = "Seqcol endpoints")
 public class SeqColController {
 
     private SeqColService seqColService;

diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties
@@ -39,5 +39,5 @@ springdoc.swagger-ui.path=/seqcol-documentation
 springdoc.api-docs.path=/seqcol-api-docs
 
 springdoc.packages-to-scan=uk.ac.ebi.eva.evaseqcol.controller
-springdoc.swagger-ui.operationsSorter=method
+springdoc.swagger-ui.operationsSorter=alpha
 springdoc.swagger-ui.tagsSorter=alpha