Remove/inline operation from Route, and introduce Route naming.

nomisRev · Jul 10, 2024 · db2411e · db2411e
1 parent e29ec6f
commit db2411e
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 73 deletions.
diff --git a/generation/src/main/kotlin/io/github/nomisrev/openapi/APIs.kt b/generation/src/main/kotlin/io/github/nomisrev/openapi/APIs.kt
@@ -201,13 +201,13 @@ private fun API.toImplementation(context: NamingContext? = null): TypeSpec {
 context(OpenAPIContext, TypeSpecHolder.Builder<*>, MemberSpecHolder.Builder<*>)
 private fun Route.addFunction(implemented: Boolean) {
   val function =
-    FunSpec.builder(toParamName(Named(operation.operationId!!)))
+    FunSpec.builder(toParamName(Named(naming.name)))
       .addModifiers(KModifier.SUSPEND, if (implemented) KModifier.OVERRIDE else KModifier.ABSTRACT)
       .addParameters(params(defaults = !implemented))
       .addParameters(requestBody(defaults = !implemented))
       .addParameter(configure(defaults = !implemented))
       .apply {
-        operation.summary?.let { addKdoc(it) }
+        summary?.let { addKdoc(it) }
         returnType()
         if (implemented) {
           addCode(
@@ -353,7 +353,7 @@ fun Route.returnType() {
       }
     returns(typeName)
   } else {
-    val response = ClassName(`package`, "${operation.operationId}Response")
+    val response = ClassName(`package`, "${naming.name}Response")
     addType(
       TypeSpec.interfaceBuilder(response)
         .addModifiers(KModifier.SEALED)

diff --git a/generation/src/main/kotlin/io/github/nomisrev/openapi/OpenAIInterceptor.kt b/generation/src/main/kotlin/io/github/nomisrev/openapi/OpenAIInterceptor.kt
@@ -84,7 +84,7 @@ fun APIInterceptor.Companion.openAIStreaming(`package`: String): APIInterceptor
     ): TypeSpec.Builder {
       val functions =
         api.routes
-          .associateBy { it.operation.operationId!! }
+          .associateBy { it.naming.name }
           .mapNotNull { (key, route) ->
             if (streamingOps.containsKey(key))
               route.toStreamingFun(implemented = implemented, streamingOps[key]!!)
@@ -99,7 +99,7 @@ fun APIInterceptor.Companion.openAIStreaming(`package`: String): APIInterceptor
 
     context(OpenAPIContext)
     private fun Route.toStreamingFun(implemented: Boolean, returnType: ClassName): FunSpec =
-      FunSpec.builder(toParamName(Named(operation.operationId!! + "Stream")))
+      FunSpec.builder(toParamName(Named(naming.name + "Stream")))
         .addModifiers(
           KModifier.SUSPEND,
           if (implemented) KModifier.OVERRIDE else KModifier.ABSTRACT

diff --git a/typed/src/commonMain/kotlin/io/github/nomisrev/openapi/Model.kt b/typed/src/commonMain/kotlin/io/github/nomisrev/openapi/Model.kt
@@ -5,8 +5,19 @@ import io.ktor.http.HttpMethod
 import io.ktor.http.HttpStatusCode
 import kotlinx.serialization.json.JsonElement
 
+sealed interface RouteNaming {
+  val name: String
+
+  data class OperationId(override val name: String) : RouteNaming
+  //  data class Path(
+  //    val value: String,
+  //    val operation: HttpMethod
+  //  ): RouteNaming
+}
+
 data class Route(
-  val operation: Operation,
+  val naming: RouteNaming,
+  val summary: String?,
   val path: String,
   val method: HttpMethod,
   val body: Bodies,

diff --git a/typed/src/commonMain/kotlin/io/github/nomisrev/openapi/OpenAPITransformer.kt b/typed/src/commonMain/kotlin/io/github/nomisrev/openapi/OpenAPITransformer.kt
@@ -100,7 +100,8 @@ private class OpenAPITransformer(private val openAPI: OpenAPI) {
           .let(::listOfNotNull)
 
       Route(
-        operation = operation,
+        naming = RouteNaming.OperationId(operation.operationId!!),
+        summary = operation.summary,
         path = path,
         method = method,
         body = toRequestBody(operation, operation.requestBody?.get(), ::context),

diff --git a/typed/src/commonTest/kotlin/io/github/nomisrev/openapi/RootTest.kt b/typed/src/commonTest/kotlin/io/github/nomisrev/openapi/RootTest.kt
@@ -14,80 +14,50 @@ class RootTest {
 
   @Test
   fun operation() {
-    val operation =
-      Operation(
-        operationId = "echo",
-        responses =
-          Responses(
-            200 to
-              value(
-                Response(
-                  content =
-                    mapOf(
-                      "application/json" to
-                        MediaType(schema = value(Schema(type = Schema.Type.Basic.String)))
-                    )
-                )
-              )
-          )
-      )
     val actual =
-      testAPI
-        .copy(
-          paths =
-            mapOf(
-              "/echo" to
-                PathItem(
-                  get =
-                    Operation(
-                      operationId = "echo",
-                      responses =
-                        Responses(
-                          200 to
-                            value(
-                              Response(
-                                content =
-                                  mapOf(
-                                    "application/json" to
-                                      MediaType(
-                                        schema = value(Schema(type = Schema.Type.Basic.String))
-                                      )
-                                  )
-                              )
-                            )
-                        )
-                    )
+      Operation(
+          operationId = "echo",
+          summary = "Echoes the input",
+          responses =
+            Responses(
+              200 to
+                value(
+                  Response(
+                    content =
+                      mapOf(
+                        "application/json" to
+                          MediaType(schema = value(Schema(type = Schema.Type.Basic.String)))
+                      )
+                  )
                 )
             )
         )
-        .root("OpenAPI")
+        .toAPI("/echo")
     val expected =
-      Root(
-        "OpenAPI",
-        emptyList(),
+      API(
+        "echo",
         listOf(
-          API(
-            "echo",
-            listOf(
-              Route(
-                operation = operation,
-                path = "/echo",
-                method = HttpMethod.Get,
-                body = Route.Bodies(required = false, emptyMap(), emptyMap()),
-                input = emptyList(),
-                returnType =
-                  Route.Returns(
-                    HttpStatusCode.OK to
-                      Route.ReturnType(Model.Primitive.string(null, null), emptyMap())
-                  ),
-                extensions = emptyMap(),
-                nested = listOf(Model.Primitive.string(null, null))
-              )
-            ),
-            nested = emptyList()
+          Route(
+            naming = RouteNaming.OperationId("echo"),
+            summary = "Echoes the input",
+            path = "/echo",
+            method = HttpMethod.Get,
+            body = Route.Bodies(required = false, emptyMap(), emptyMap()),
+            input = emptyList(),
+            returnType =
+              Route.Returns(
+                HttpStatusCode.OK to
+                  Route.ReturnType(Model.Primitive.string(null, null), emptyMap())
+              ),
+            extensions = emptyMap(),
+            nested = listOf(Model.Primitive.string(null, null))
           )
-        )
+        ),
+        nested = emptyList()
       )
     assertEquals(expected, actual)
   }
 }
+
+fun Operation.toAPI(path: String): API =
+  testAPI.copy(paths = mapOf(path to PathItem(get = this))).root("OpenAPI").endpoints.single()