feat: add OpenApiStatisticsController

Informatievlaanderen · Oct 3, 2023 · a622128 · a622128
1 parent 264db04
commit a622128
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 3 deletions.
diff --git a/.../informatievlaanderen/ldes/server/admin/rest/controllers/OpenApiStatisticsController.java b/.../informatievlaanderen/ldes/server/admin/rest/controllers/OpenApiStatisticsController.java
@@ -0,0 +1,46 @@
+package be.vlaanderen.informatievlaanderen.ldes.server.admin.rest.controllers;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.ExampleObject;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.tags.Tag;
+
+@SuppressWarnings("java:S2479") // whitespace needed for examples
+@Tag(name = "Statistics")
+public interface OpenApiStatisticsController {
+
+	@Operation(summary = "Retrieve json with statistics of the LDES server")
+	@ApiResponse(responseCode = "200", content = {
+			@Content(mediaType = "application/json", schema = @Schema(implementation = String.class), examples = @ExampleObject(value = """
+					{
+					    "ingested member count": 4018,
+					    "current member count": 4018,
+					    "LDESes": [
+					        {
+					            "name": "mobility-hindrances",
+					            "ingested member count": 4018,
+					            "current member count": 4018,
+					            "views": [
+					                {
+					                    "name": "mobility-hindrances/timebased",
+					                    "fragmentations": [
+					                        {
+					                            "name": "HierarchicalTimeBasedFragmentation",
+					                            "properties": {
+					                                "maxGranularity": "minute",
+					                                "fragmentationPath": "http://www.w3.org/ns/prov#generatedAtTime"
+					                            }
+					                        }
+					                    ],
+					                    "fragmentation progress": 100
+					                }
+					            ]
+					        }
+					    ]
+					}
+					""")),
+	})
+	String getStatistics();
+}
diff --git a/...anderen/informatievlaanderen/ldes/server/admin/rest/controllers/StatisticsController.java b/...anderen/informatievlaanderen/ldes/server/admin/rest/controllers/StatisticsController.java
@@ -7,16 +7,16 @@
 
 @RestController
 @RequestMapping(value = "/admin/api/v1/statistics")
-public class StatisticsController {
+public class StatisticsController implements OpenApiStatisticsController {
 
 	private final StatisticsService statisticsService;
 
 	public StatisticsController(StatisticsService statisticsService) {
 		this.statisticsService = statisticsService;
 	}
 
-	@GetMapping
-	public String getEventStreams() {
+	@GetMapping(produces = { "application/json" })
+	public String getStatistics() {
 		return statisticsService.getMetrics().toString();
 	}
 }