From d233b3852dbb3c926a5090b5dddf4a49d73a1c55 Mon Sep 17 00:00:00 2001
From: David Kleiven <davidkleiven446@gmail.com>
Date: Tue, 26 Sep 2023 21:32:19 +0200
Subject: [PATCH] Add first version of swagger documentation

---
 pom.xml                                       |  5 ++
 src/main/App.kt                               |  2 +
 src/main/resources/openapi/documentation.yaml | 49 +++++++++++++++++++
 3 files changed, 56 insertions(+)
 create mode 100644 src/main/resources/openapi/documentation.yaml

diff --git a/pom.xml b/pom.xml
index 63f66de..75ad533 100644
--- a/pom.xml
+++ b/pom.xml
@@ -54,6 +54,11 @@
             <artifactId>ktor-server-content-negotiation-jvm</artifactId>
             <version>${ktor.version}</version>
         </dependency>
+        <dependency>
+            <groupId>io.ktor</groupId>
+            <artifactId>ktor-server-swagger-jvm</artifactId>
+            <version>${ktor.version}</version>
+        </dependency>
         <dependency>
             <groupId>org.jetbrains.kotlin</groupId>
             <artifactId>kotlin-test-junit5</artifactId>
diff --git a/src/main/App.kt b/src/main/App.kt
index d043ea4..4bd8579 100644
--- a/src/main/App.kt
+++ b/src/main/App.kt
@@ -7,6 +7,7 @@ import io.ktor.server.plugins.contentnegotiation.*
 import io.ktor.server.request.*
 import io.ktor.server.response.*
 import io.ktor.server.routing.*
+import io.ktor.server.plugins.swagger.*
 
 fun main(args: Array<String>): Unit = io.ktor.server.netty.EngineMain.main(args)
 
@@ -47,5 +48,6 @@ fun Application.module() {
                 call.respond(result)
             }
         }
+        swaggerUI(path="openapi", swaggerFile = "openapi/documentation.yaml")
     }
 }
diff --git a/src/main/resources/openapi/documentation.yaml b/src/main/resources/openapi/documentation.yaml
new file mode 100644
index 0000000..7b539be
--- /dev/null
+++ b/src/main/resources/openapi/documentation.yaml
@@ -0,0 +1,49 @@
+openapi: "3.0.3"
+info:
+  title: "Load Flow Service API"
+  description: "An API that interacts with Powsybl"
+  version: "1.0.0"
+servers:
+  - url: "http://0.0.0.0:8080"
+paths:
+  /get-buses:
+    post:
+      operationId: getBuses
+      description: "Return all buses in the network"
+      requestBody:
+        description: "Form with network sent as file"
+        required: true
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              properties:
+                network:
+                  type: string
+                  format: binary
+      responses:
+        "200":
+          description: "List with all buses in the network"
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/Bus"
+
+
+components:
+  schemas:
+    Bus:
+      type: object
+      properties:
+        id:
+          type: string
+        voltage:
+          type: double
+        angle:
+          type: double
+        activePower:
+          type: double
+        reactivePower:
+          type: double