Enhance OpenAPI Definition

ArDoCo · Aug 28, 2024 · 55bfcdb · 55bfcdb
1 parent f14fed0
commit 55bfcdb
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/rest/src/main/kotlin/edu/kit/kastel/mcse/ardoco/metrics/rest/Application.kt b/rest/src/main/kotlin/edu/kit/kastel/mcse/ardoco/metrics/rest/Application.kt
@@ -1,11 +1,21 @@
 package edu.kit.kastel.mcse.ardoco.metrics.rest
 
+import io.swagger.v3.oas.annotations.ExternalDocumentation
 import io.swagger.v3.oas.annotations.OpenAPIDefinition
 import io.swagger.v3.oas.annotations.info.Info
+import io.swagger.v3.oas.annotations.info.License
 import org.springframework.boot.autoconfigure.SpringBootApplication
 import org.springframework.boot.runApplication
 
-@OpenAPIDefinition(info = Info(title = "ArDoCo: Metrics", description = "API for calculating metrics for TLR and other tasks"))
+@OpenAPIDefinition(
+    info =
+        Info(
+            title = "ArDoCo: Metrics",
+            description = "This tool provides functionality to calculate and aggregate classification and rank metrics for various tasks.",
+            license = License(name = "MIT License", url = "https://github.com/ArDoCo/Metrics/blob/main/LICENSE.md")
+        ),
+    externalDocs = ExternalDocumentation(description = "ArDoCo: Metrics - Wiki", url = "https://github.com/ArDoCo/metrics/wiki")
+)
 @SpringBootApplication
 class Application