chore: prep for 3.14.3 release

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

CHANGELOG.md

@@ -12,6 +12,36 @@
 
 ## Released
 
+## [3.14.3] - May 22nd, 2023
+
+### Added
+
+- Added `required` parameter in request info builder.
+
+## [3.14.2] - May 8rd, 2023
+
+### Changed
+
+- Fixed bug where routes were not resolving when a parameter was declared via the ktor SDK
+
+## [3.14.1] - April 28th, 2023
+
+### Changed
+
+- Generating enrichments for generic classes no longer throws the `Slugs should not be generated for field enrichments` error.
+
+## [3.14.0] - April 6th, 2023
+
+### Added
+
+- Add support for response headers
+
+## [3.13.0] - March 15th, 2023
+
+### Changed
+
+- Post, Put, and Patch now support not providing request info
+
 ## [3.12.0] - March 14th, 2023
 
 ### Added

README.md

@@ -3,3 +3,7 @@
 [![version](https://img.shields.io/maven-central/v/io.bkbn/kompendium-core?style=flat-square)](https://search.maven.org/search?q=io.bkbn%20kompendium)
 
 Documentation is stored in the `docs` folder and is hosted [here](https://bkbn.gitbook.io/kompendium)
+
+## Showcase
+
+If you would like to showcase docs that you build using Kompendium, add them to [the showcase discussion](https://github.com/bkbnio/kompendium/discussions/444)

build.gradle.kts

@@ -1,12 +1,12 @@
 plugins {
-  kotlin("jvm") version "1.8.10" apply false
+  kotlin("jvm") version "1.8.21" apply false
-  kotlin("plugin.serialization") version "1.8.10" apply false
+  kotlin("plugin.serialization") version "1.8.21" apply false
   id("io.bkbn.sourdough.library.jvm") version "0.12.0" apply false
   id("io.bkbn.sourdough.application.jvm") version "0.12.0" apply false
   id("io.bkbn.sourdough.root") version "0.12.0"
   id("com.github.jakemarsden.git-hooks") version "0.0.2"
   id("org.jetbrains.kotlinx.kover") version "0.6.1"
-  id("io.github.gradle-nexus.publish-plugin") version "1.2.0"
+  id("io.github.gradle-nexus.publish-plugin") version "1.3.0"
 }
 
 gitHooks {

core/build.gradle.kts

@@ -57,9 +57,9 @@ dependencies {
   testFixturesApi("io.ktor:ktor-client:$ktorVersion")
   testFixturesApi("io.ktor:ktor-client-cio:$ktorVersion")
 
-  testFixturesApi("dev.forst:ktor-api-key:2.2.2")
+  testFixturesApi("dev.forst:ktor-api-key:2.2.4")
 
-  testFixturesApi("org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1")
+  testFixturesApi("org.jetbrains.kotlinx:kotlinx-serialization-json:1.5.1")
 }
 
 testing {

core/src/main/kotlin/io/bkbn/kompendium/core/metadata/MethodInfoWithRequest.kt

@@ -1,7 +1,7 @@
 package io.bkbn.kompendium.core.metadata
 
 sealed interface MethodInfoWithRequest : MethodInfo {
-  val request: RequestInfo
+  val request: RequestInfo?
 
   abstract class Builder<T : MethodInfoWithRequest> : MethodInfo.Builder<T>() {
     internal var request: RequestInfo? = null

core/src/main/kotlin/io/bkbn/kompendium/core/metadata/PatchInfo.kt

@@ -4,7 +4,7 @@ import io.bkbn.kompendium.oas.common.ExternalDocumentation
 import io.bkbn.kompendium.oas.payload.Parameter
 
 class PatchInfo private constructor(
-  override val request: RequestInfo,
+  override val request: RequestInfo?,
   override val errors: MutableList<ResponseInfo>,
   override val response: ResponseInfo,
   override val tags: Set<String>,
@@ -26,7 +26,7 @@ class PatchInfo private constructor(
 
   class Builder : MethodInfoWithRequest.Builder<PatchInfo>() {
     override fun build() = PatchInfo(
-      request = request ?: error("request info must be present"),
+      request = request,
       errors = errors,
       response = response ?: error("response info must be present"),
       tags = tags,

core/src/main/kotlin/io/bkbn/kompendium/core/metadata/PostInfo.kt

@@ -4,7 +4,7 @@ import io.bkbn.kompendium.oas.common.ExternalDocumentation
 import io.bkbn.kompendium.oas.payload.Parameter
 
 class PostInfo private constructor(
-  override val request: RequestInfo,
+  override val request: RequestInfo?,
   override val errors: MutableList<ResponseInfo>,
   override val response: ResponseInfo,
   override val tags: Set<String>,
@@ -26,7 +26,7 @@ class PostInfo private constructor(
 
   class Builder : MethodInfoWithRequest.Builder<PostInfo>() {
     override fun build() = PostInfo(
-      request = request ?: error("request info must be present"),
+      request = request,
       errors = errors,
       response = response ?: error("response info must be present"),
       tags = tags,

core/src/main/kotlin/io/bkbn/kompendium/core/metadata/PutInfo.kt

@@ -4,7 +4,7 @@ import io.bkbn.kompendium.oas.common.ExternalDocumentation
 import io.bkbn.kompendium.oas.payload.Parameter
 
 class PutInfo private constructor(
-  override val request: RequestInfo,
+  override val request: RequestInfo?,
   override val errors: MutableList<ResponseInfo>,
   override val response: ResponseInfo,
   override val tags: Set<String>,
@@ -26,7 +26,7 @@ class PutInfo private constructor(
 
   class Builder : MethodInfoWithRequest.Builder<PutInfo>() {
     override fun build() = PutInfo(
-      request = request ?: error("request info must be present"),
+      request = request,
       errors = errors,
       response = response ?: error("response info must be present"),
       tags = tags,

core/src/main/kotlin/io/bkbn/kompendium/core/metadata/RequestInfo.kt

@@ -10,7 +10,8 @@ class RequestInfo private constructor(
   val typeEnrichment: TypeEnrichment<*>?,
   val description: String,
   val examples: Map<String, MediaType.Example>?,
-  val mediaTypes: Set<String>
+  val mediaTypes: Set<String>,
+  val required: Boolean
 ) {
 
   companion object {
@@ -27,6 +28,11 @@ class RequestInfo private constructor(
     private var description: String? = null
     private var examples: Map<String, MediaType.Example>? = null
     private var mediaTypes: Set<String>? = null
+    private var required: Boolean? = null
+
+    fun required(r: Boolean) = apply {
+      this.required = r
+    }
 
     fun requestType(t: KType) = apply {
       this.requestType = t
@@ -56,7 +62,8 @@ class RequestInfo private constructor(
       description = description ?: error("Description must be present"),
       typeEnrichment = typeEnrichment,
       examples = examples,
-      mediaTypes = mediaTypes ?: setOf("application/json")
+      mediaTypes = mediaTypes ?: setOf("application/json"),
+      required = required ?: true
     )
   }
 }

core/src/main/kotlin/io/bkbn/kompendium/core/metadata/ResponseInfo.kt

@@ -1,6 +1,7 @@
 package io.bkbn.kompendium.core.metadata
 
 import io.bkbn.kompendium.enrichment.TypeEnrichment
+import io.bkbn.kompendium.oas.payload.Header
 import io.bkbn.kompendium.oas.payload.MediaType
 import io.ktor.http.HttpStatusCode
 import kotlin.reflect.KType
@@ -12,7 +13,8 @@ class ResponseInfo private constructor(
   val typeEnrichment: TypeEnrichment<*>?,
   val description: String,
   val examples: Map<String, MediaType.Example>?,
-  val mediaTypes: Set<String>
+  val mediaTypes: Set<String>,
+  val responseHeaders: Map<String, Header>?
 ) {
 
   companion object {
@@ -30,6 +32,11 @@ class ResponseInfo private constructor(
     private var description: String? = null
     private var examples: Map<String, MediaType.Example>? = null
     private var mediaTypes: Set<String>? = null
+    private var responseHeaders: Map<String, Header>? = null
+
+    fun responseHeaders(headers: Map<String, Header>) = apply {
+      this.responseHeaders = headers
+    }
 
     fun responseCode(code: HttpStatusCode) = apply {
       this.responseCode = code
@@ -64,7 +71,8 @@ class ResponseInfo private constructor(
       description = description ?: error("You must provide a description in order to build a Response!"),
       typeEnrichment = typeEnrichment,
       examples = examples,
-      mediaTypes = mediaTypes ?: setOf("application/json")
+      mediaTypes = mediaTypes ?: setOf("application/json"),
+      responseHeaders = responseHeaders
     )
   }
 }

core/src/main/kotlin/io/bkbn/kompendium/core/plugin/NotarizedRoute.kt

@@ -86,6 +86,7 @@ object NotarizedRoute {
         ?: it
     }
     .replace(Regex("/\\(.+\\)"), "")
+    .replace(Regex("/\\[.+\\]"), "")
 
   fun Route.collectAuthMethods() = toString()
     .split("/")

core/src/main/kotlin/io/bkbn/kompendium/core/util/Helpers.kt

@@ -72,13 +72,15 @@ object Helpers {
 
     when (this) {
       is MethodInfoWithRequest -> {
+        this.request?.let { reqInfo ->
           SchemaGenerator.fromTypeOrUnit(
-          type = this.request.requestType,
+            type = reqInfo.requestType,
             cache = spec.components.schemas,
             schemaConfigurator = schemaConfigurator,
-          enrichment = this.request.typeEnrichment,
+            enrichment = reqInfo.typeEnrichment,
           )?.let { schema ->
-          spec.components.schemas[this.request.requestType.getSlug(this.request.typeEnrichment)] = schema
+            spec.components.schemas[reqInfo.requestType.getSlug(reqInfo.typeEnrichment)] = schema
+          }
         }
       }
 
@@ -121,21 +123,24 @@ object Helpers {
       ?.map { listOf(it).toMap() }
       ?.toMutableList(),
     requestBody = when (this) {
-      is MethodInfoWithRequest -> Request(
+      is MethodInfoWithRequest -> this.request?.let { reqInfo ->
-        description = this.request.description,
+        Request(
-        content = this.request.requestType.toReferenceContent(
+          description = reqInfo.description,
-          examples = this.request.examples,
+          content = reqInfo.requestType.toReferenceContent(
-          mediaTypes = this.request.mediaTypes,
+            examples = reqInfo.examples,
-          enrichment = this.request.typeEnrichment
+            mediaTypes = reqInfo.mediaTypes,
+            enrichment = reqInfo.typeEnrichment
           ),
-        required = true
+          required = reqInfo.required
         )
+      }
 
       else -> null
     },
     responses = mapOf(
       this.response.responseCode.value to Response(
         description = this.response.description,
+        headers = this.response.responseHeaders,
         content = this.response.responseType.toReferenceContent(
           examples = this.response.examples,
           mediaTypes = this.response.mediaTypes,
@@ -148,6 +153,7 @@ object Helpers {
   private fun List<ResponseInfo>.toResponseMap(): Map<Int, Response> = associate { error ->
     error.responseCode.value to Response(
       description = error.description,
+      headers = error.responseHeaders,
       content = error.responseType.toReferenceContent(
         examples = error.examples,
         mediaTypes = error.mediaTypes,

core/src/test/kotlin/io/bkbn/kompendium/core/KompendiumTest.kt

@@ -11,6 +11,7 @@ import io.bkbn.kompendium.core.util.defaultAuthConfig
 import io.bkbn.kompendium.core.util.defaultField
 import io.bkbn.kompendium.core.util.defaultParameter
 import io.bkbn.kompendium.core.util.doubleConstraints
+import io.bkbn.kompendium.core.util.enrichedGenericResponse
 import io.bkbn.kompendium.core.util.enrichedComplexGenericType
 import io.bkbn.kompendium.core.util.enrichedNestedCollection
 import io.bkbn.kompendium.core.util.enrichedSimpleRequest
@@ -48,9 +49,12 @@ import io.bkbn.kompendium.core.util.polymorphicCollectionResponse
 import io.bkbn.kompendium.core.util.polymorphicException
 import io.bkbn.kompendium.core.util.polymorphicMapResponse
 import io.bkbn.kompendium.core.util.polymorphicResponse
+import io.bkbn.kompendium.core.util.postNoReqBody
 import io.bkbn.kompendium.core.util.primitives
 import io.bkbn.kompendium.core.util.reqRespExamples
+import io.bkbn.kompendium.core.util.optionalReqExample
 import io.bkbn.kompendium.core.util.requiredParams
+import io.bkbn.kompendium.core.util.responseHeaders
 import io.bkbn.kompendium.core.util.returnsList
 import io.bkbn.kompendium.core.util.rootRoute
 import io.bkbn.kompendium.core.util.samePathDifferentMethodsAndAuth
@@ -64,6 +68,7 @@ import io.bkbn.kompendium.core.util.stringContentEncodingConstraints
 import io.bkbn.kompendium.core.util.stringPatternConstraints
 import io.bkbn.kompendium.core.util.topLevelNullable
 import io.bkbn.kompendium.core.util.trailingSlash
+import io.bkbn.kompendium.core.util.paramWrapper
 import io.bkbn.kompendium.core.util.unbackedFieldsResponse
 import io.bkbn.kompendium.core.util.withOperationId
 import io.bkbn.kompendium.json.schema.definition.TypeDefinition
@@ -129,6 +134,12 @@ class KompendiumTest : DescribeSpec({
     it("Can override media types") {
       openApiTestAllSerializers("T0052__override_media_types.json") { overrideMediaTypes() }
     }
+    it("Can support a post request with no request body") {
+      openApiTestAllSerializers("T0065__post_no_req_body.json") { postNoReqBody() }
+    }
+    it("Can notarize a route with response headers") {
+      openApiTestAllSerializers("T0066__notarized_get_with_response_headers.json") { responseHeaders() }
+    }
   }
   describe("Route Parsing") {
     it("Can parse a simple path and store it under the expected route") {
@@ -143,6 +154,9 @@ class KompendiumTest : DescribeSpec({
     it("Can notarize a route with a trailing slash") {
       openApiTestAllSerializers("T0015__trailing_slash.json") { trailingSlash() }
     }
+    it("Can notarize a route with a parameter") {
+      openApiTestAllSerializers("T0068__param_wrapper.json") { paramWrapper() }
+    }
   }
   describe("Exceptions") {
     it("Can add an exception status code to a response") {
@@ -165,6 +179,9 @@ class KompendiumTest : DescribeSpec({
     it("Can describe example parameters") {
       openApiTestAllSerializers("T0021__example_parameters.json") { exampleParams() }
     }
+    it("Can generate example optional request body") {
+      openApiTestAllSerializers("T0069__example_optional_req.json") { optionalReqExample() }
+    }
   }
   describe("Defaults") {
     it("Can generate a default parameter value") {
@@ -444,6 +461,9 @@ class KompendiumTest : DescribeSpec({
     it("Can enrich a complex generic type") {
       openApiTestAllSerializers("T0057__enriched_complex_generic_type.json") { enrichedComplexGenericType() }
     }
+    it("Can enrich a generic object") {
+      openApiTestAllSerializers("T0067__enriched_generic_object.json") { enrichedGenericResponse() }
+    }
   }
   describe("Constraints") {
     it("Can apply constraints to an int field") {

core/src/test/kotlin/io/bkbn/kompendium/core/util/Enrichment.kt

@@ -6,6 +6,7 @@ import io.bkbn.kompendium.core.fixtures.NestedComplexItem
 import io.bkbn.kompendium.core.fixtures.TestCreatedResponse
 import io.bkbn.kompendium.core.fixtures.TestResponse
 import io.bkbn.kompendium.core.fixtures.TestSimpleRequest
+import io.bkbn.kompendium.core.fixtures.GenericObject
 import io.bkbn.kompendium.core.metadata.GetInfo
 import io.bkbn.kompendium.core.metadata.PostInfo
 import io.bkbn.kompendium.core.plugin.NotarizedRoute
@@ -135,3 +136,33 @@ fun Routing.enrichedComplexGenericType() {
     }
   }
 }
+
+fun Routing.enrichedGenericResponse() {
+  route("/example") {
+    install(NotarizedRoute()) {
+      get = GetInfo.builder {
+        summary(TestModules.defaultPathSummary)
+        description(TestModules.defaultPathDescription)
+        response {
+          responseType(
+            enrichment = TypeEnrichment("generic") {
+              GenericObject<TestSimpleRequest>::data {
+                description = "A simple description"
+                typeEnrichment = TypeEnrichment("simple") {
+                  TestSimpleRequest::a {
+                    description = "A simple description"
+                  }
+                  TestSimpleRequest::b {
+                    deprecated = true
+                  }
+                }
+              }
+            }
+          )
+          description("A good response")
+          responseCode(HttpStatusCode.Created)
+        }
+      }
+    }
+  }
+}

core/src/test/kotlin/io/bkbn/kompendium/core/util/Examples.kt

@@ -55,3 +55,30 @@ fun Routing.exampleParams() = basicGetGenerator<TestResponse>(
     )
   )
 )
+
+fun Routing.optionalReqExample() {
+  route(rootPath) {
+    install(NotarizedRoute()) {
+      post = PostInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+        request {
+          description(defaultRequestDescription)
+          requestType<TestRequest>()
+          examples(
+            "Testerina" to TestRequest(TestNested("asdf"), 1.5, emptyList())
+          )
+          required(false)
+        }
+        response {
+          description(defaultResponseDescription)
+          responseCode(HttpStatusCode.OK)
+          responseType<TestResponse>()
+          examples(
+            "Testerino" to TestResponse("Heya")
+          )
+        }
+      }
+    }
+  }
+}

core/src/test/kotlin/io/bkbn/kompendium/core/util/NotarizedOpenApi.kt

@@ -20,7 +20,9 @@ import io.bkbn.kompendium.core.util.TestModules.defaultPathSummary
 import io.bkbn.kompendium.core.util.TestModules.defaultResponseDescription
 import io.bkbn.kompendium.core.util.TestModules.rootPath
 import io.bkbn.kompendium.json.schema.definition.TypeDefinition
+import io.bkbn.kompendium.oas.payload.Header
 import io.bkbn.kompendium.oas.payload.Parameter
+import io.ktor.http.HttpHeaders
 import io.ktor.http.HttpStatusCode
 import io.ktor.server.application.call
 import io.ktor.server.application.install
@@ -56,6 +58,38 @@ fun Routing.notarizedGet() {
   }
 }
 
+fun Routing.responseHeaders() {
+  route(defaultPath) {
+    install(NotarizedRoute()) {
+      parameters = defaultParams
+      get = GetInfo.builder {
+        response {
+          responseCode(HttpStatusCode.OK)
+          responseType<TestResponse>()
+          description(defaultResponseDescription)
+          responseHeaders(
+            mapOf(
+              HttpHeaders.ETag to Header(
+                TypeDefinition.STRING,
+                "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag"
+              ),
+              HttpHeaders.LastModified to Header(
+                TypeDefinition.STRING,
+                "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified"
+              ),
+            )
+          )
+        }
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+      }
+    }
+    get {
+      call.respondText { "hey dude ‼️ congrats on the get request" }
+    }
+  }
+}
+
 fun Routing.notarizedPost() {
   route(defaultPath) {
     install(NotarizedRoute()) {
@@ -299,3 +333,19 @@ fun Routing.overrideMediaTypes() {
     }
   }
 }
+
+fun Routing.postNoReqBody() {
+  route("/no_req_body") {
+    install(NotarizedRoute()) {
+      post = PostInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+        response {
+          responseType<TestResponse>()
+          description("Cool response")
+          responseCode(HttpStatusCode.Created)
+        }
+      }
+    }
+  }
+}

core/src/test/kotlin/io/bkbn/kompendium/core/util/RouteParsing.kt

@@ -14,6 +14,7 @@ import io.ktor.http.HttpStatusCode
 import io.ktor.server.application.install
 import io.ktor.server.routing.Routing
 import io.ktor.server.routing.route
+import io.ktor.server.routing.param
 
 fun Routing.simplePathParsing() {
   route("/this") {
@@ -100,3 +101,32 @@ fun Routing.trailingSlash() {
     }
   }
 }
+
+fun Routing.paramWrapper() {
+  route("/test") {
+    param("a") {
+      param("b") {
+        param("c") {
+          install(NotarizedRoute()) {
+            parameters = listOf(
+              Parameter(
+                name = "test",
+                `in` = Parameter.Location.query,
+                schema = TypeDefinition.STRING
+              )
+            )
+            get = GetInfo.builder {
+              summary(defaultPathSummary)
+              description(defaultPathDescription)
+              response {
+                description(defaultResponseDescription)
+                responseCode(HttpStatusCode.OK)
+                responseType<TestResponse>()
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

core/src/test/resources/T0065__post_no_req_body.json

@@ -0,0 +1,72 @@
+{
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
+  "info": {
+    "title": "Test API",
+    "version": "1.33.7",
+    "description": "An amazing, fully-ish 😉 generated API spec",
+    "termsOfService": "https://example.com",
+    "contact": {
+      "name": "Homer Simpson",
+      "url": "https://gph.is/1NPUDiM",
+      "email": "chunkylover53@aol.com"
+    },
+    "license": {
+      "name": "MIT",
+      "url": "https://github.com/bkbnio/kompendium/blob/main/LICENSE"
+    }
+  },
+  "servers": [
+    {
+      "url": "https://myawesomeapi.com",
+      "description": "Production instance of my API"
+    },
+    {
+      "url": "https://staging.myawesomeapi.com",
+      "description": "Where the fun stuff happens"
+    }
+  ],
+  "paths": {
+    "/no_req_body": {
+      "post": {
+        "tags": [],
+        "summary": "Great Summary!",
+        "description": "testing more",
+        "parameters": [],
+        "responses": {
+          "201": {
+            "description": "Cool response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TestResponse"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0066__notarized_get_with_response_headers.json

@@ -0,0 +1,110 @@
+{
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
+  "info": {
+    "title": "Test API",
+    "version": "1.33.7",
+    "description": "An amazing, fully-ish 😉 generated API spec",
+    "termsOfService": "https://example.com",
+    "contact": {
+      "name": "Homer Simpson",
+      "url": "https://gph.is/1NPUDiM",
+      "email": "chunkylover53@aol.com"
+    },
+    "license": {
+      "name": "MIT",
+      "url": "https://github.com/bkbnio/kompendium/blob/main/LICENSE"
+    }
+  },
+  "servers": [
+    {
+      "url": "https://myawesomeapi.com",
+      "description": "Production instance of my API"
+    },
+    {
+      "url": "https://staging.myawesomeapi.com",
+      "description": "Where the fun stuff happens"
+    }
+  ],
+  "paths": {
+    "/test/{a}": {
+      "get": {
+        "tags": [],
+        "summary": "Great Summary!",
+        "description": "testing more",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "A Successful Endeavor",
+            "headers": {
+              "ETag": {
+                "schema": {
+                  "type": "string"
+                },
+                "description": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag",
+                "required": true,
+                "deprecated": false
+              },
+              "Last-Modified": {
+                "schema": {
+                  "type": "string"
+                },
+                "description": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified",
+                "required": true,
+                "deprecated": false
+              }
+            },
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TestResponse"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": [
+        {
+          "name": "a",
+          "in": "path",
+          "schema": {
+            "type": "string"
+          },
+          "required": true,
+          "deprecated": false
+        },
+        {
+          "name": "aa",
+          "in": "query",
+          "schema": {
+            "type": "number",
+            "format": "int32"
+          },
+          "required": true,
+          "deprecated": false
+        }
+      ]
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0067__enriched_generic_object.json

@@ -0,0 +1,91 @@
+{
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
+  "info": {
+    "title": "Test API",
+    "version": "1.33.7",
+    "description": "An amazing, fully-ish 😉 generated API spec",
+    "termsOfService": "https://example.com",
+    "contact": {
+      "name": "Homer Simpson",
+      "url": "https://gph.is/1NPUDiM",
+      "email": "chunkylover53@aol.com"
+    },
+    "license": {
+      "name": "MIT",
+      "url": "https://github.com/bkbnio/kompendium/blob/main/LICENSE"
+    }
+  },
+  "servers": [
+    {
+      "url": "https://myawesomeapi.com",
+      "description": "Production instance of my API"
+    },
+    {
+      "url": "https://staging.myawesomeapi.com",
+      "description": "Where the fun stuff happens"
+    }
+  ],
+  "paths": {
+    "/example": {
+      "get": {
+        "tags": [],
+        "summary": "Great Summary!",
+        "description": "testing more",
+        "parameters": [],
+        "responses": {
+          "201": {
+            "description": "A good response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/GenericObject-TestSimpleRequest-generic"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "GenericObject-TestSimpleRequest-generic": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "$ref": "#/components/schemas/TestSimpleRequest-simple",
+            "description": "A simple description"
+          }
+        },
+        "required": [
+          "data"
+        ]
+      },
+      "TestSimpleRequest-simple": {
+        "type": "object",
+        "properties": {
+          "a": {
+            "type": "string",
+            "description": "A simple description"
+          },
+          "b": {
+            "type": "number",
+            "format": "int32",
+            "deprecated": true
+          }
+        },
+        "required": [
+          "a",
+          "b"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0068__param_wrapper.json

@@ -0,0 +1,82 @@
+{
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
+  "info": {
+    "title": "Test API",
+    "version": "1.33.7",
+    "description": "An amazing, fully-ish 😉 generated API spec",
+    "termsOfService": "https://example.com",
+    "contact": {
+      "name": "Homer Simpson",
+      "url": "https://gph.is/1NPUDiM",
+      "email": "chunkylover53@aol.com"
+    },
+    "license": {
+      "name": "MIT",
+      "url": "https://github.com/bkbnio/kompendium/blob/main/LICENSE"
+    }
+  },
+  "servers": [
+    {
+      "url": "https://myawesomeapi.com",
+      "description": "Production instance of my API"
+    },
+    {
+      "url": "https://staging.myawesomeapi.com",
+      "description": "Where the fun stuff happens"
+    }
+  ],
+  "paths": {
+    "/test": {
+      "get": {
+        "tags": [],
+        "summary": "Great Summary!",
+        "description": "testing more",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "A Successful Endeavor",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TestResponse"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": [
+        {
+          "name": "test",
+          "in": "query",
+          "schema": {
+            "type": "string"
+          },
+          "required": true,
+          "deprecated": false
+        }
+      ]
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0069__example_optional_req.json

@@ -0,0 +1,136 @@
+{
+  "openapi": "3.1.0",
+  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
+  "info": {
+    "title": "Test API",
+    "version": "1.33.7",
+    "description": "An amazing, fully-ish 😉 generated API spec",
+    "termsOfService": "https://example.com",
+    "contact": {
+      "name": "Homer Simpson",
+      "url": "https://gph.is/1NPUDiM",
+      "email": "chunkylover53@aol.com"
+    },
+    "license": {
+      "name": "MIT",
+      "url": "https://github.com/bkbnio/kompendium/blob/main/LICENSE"
+    }
+  },
+  "servers": [
+    {
+      "url": "https://myawesomeapi.com",
+      "description": "Production instance of my API"
+    },
+    {
+      "url": "https://staging.myawesomeapi.com",
+      "description": "Where the fun stuff happens"
+    }
+  ],
+  "paths": {
+    "/": {
+      "post": {
+        "tags": [],
+        "summary": "Great Summary!",
+        "description": "testing more",
+        "parameters": [],
+        "requestBody": {
+          "description": "You gotta send it",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/TestRequest"
+              },
+              "examples": {
+                "Testerina": {
+                  "value": {
+                    "fieldName": {
+                      "nesty": "asdf"
+                    },
+                    "b": 1.5,
+                    "aaa": []
+                  }
+                }
+              }
+            }
+          },
+          "required": false
+        },
+        "responses": {
+          "200": {
+            "description": "A Successful Endeavor",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TestResponse"
+                },
+                "examples": {
+                  "Testerino": {
+                    "value": {
+                      "c": "Heya"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "TestResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      },
+      "TestRequest": {
+        "type": "object",
+        "properties": {
+          "aaa": {
+            "items": {
+              "type": "number",
+              "format": "int64"
+            },
+            "type": "array"
+          },
+          "b": {
+            "type": "number",
+            "format": "double"
+          },
+          "fieldName": {
+            "$ref": "#/components/schemas/TestNested"
+          }
+        },
+        "required": [
+          "aaa",
+          "b",
+          "fieldName"
+        ]
+      },
+      "TestNested": {
+        "type": "object",
+        "properties": {
+          "nesty": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "nesty"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/testFixtures/kotlin/io/bkbn/kompendium/core/fixtures/TestModels.kt

@@ -180,6 +180,10 @@ data class SerialNameObject(
   val camelCaseName: String
 )
 
+data class GenericObject<T>(
+  val data: T
+)
+
 enum class Color {
   RED,
   GREEN,

detekt.yml

@@ -22,6 +22,8 @@ formatting:
     indentSize: 2
   ImportOrdering:
     active: false
+  EnumEntryNameCase:
+    active: false
 naming:
   ConstructorParameterNaming:
     active: false

docs/SUMMARY.md

@@ -1,13 +1,13 @@
 # Summary 
 
 * [Introduction](index.md)
-* [Helpers](helpers/index.md)
-  * [Protobuf java converter](helpers/protobuf_java_converter.md)
-* [Concepts](concepts/index.md)
-  * [Enrichment](concepts/enrichment.md)
 * [Plugins](plugins/index.md)
   * [Notarized Application](plugins/notarized_application.md)
   * [Notarized Route](plugins/notarized_route.md)
   * [Notarized Locations](plugins/notarized_locations.md)
   * [Notarized Resources](plugins/notarized_resources.md)
+* [Concepts](concepts/index.md)
+  * [Enrichment](concepts/enrichment.md)
+* [Helpers](helpers/index.md)
+  * [Protobuf java converter](helpers/protobuf_java_converter.md)
 * [The Playground](playground.md)

gradle.properties

@@ -1,5 +1,5 @@
 # Kompendium
-project.version=3.12.0
+project.version=3.14.3
 # Kotlin
 kotlin.code.style=official
 # Gradle
@@ -9,6 +9,6 @@ org.gradle.jvmargs=-Xmx2000m
 org.gradle.parallel=true
 
 # Dependencies
-ktorVersion=2.2.3
+ktorVersion=2.3.0
-kotestVersion=5.5.5
+kotestVersion=5.6.2
-detektVersion=1.21.0
+detektVersion=1.22.0

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.1.1-bin.zip
+networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradlew

@@ -55,7 +55,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -80,13 +80,10 @@ do
     esac
 done
 
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
+# This is normally unused
-
+# shellcheck disable=SC2034
-APP_NAME="Gradle"
 APP_BASE_NAME=${0##*/}
-
+APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -143,12 +140,16 @@ fi
 if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
@@ -193,6 +194,10 @@ if "$cygwin" || "$msys" ; then
     done
 fi
 
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
 # Collect all arguments for the java command;
 #   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
 #     shell script including quotes and variable substitutions, so put them in

gradlew.bat

@@ -26,6 +26,7 @@ if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
 if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 

json-schema/build.gradle.kts

@@ -23,8 +23,8 @@ dependencies {
   // Kompendium
   api(projects.kompendiumEnrichment)
 
-  implementation("org.jetbrains.kotlin:kotlin-reflect:1.8.10")
+  implementation("org.jetbrains.kotlin:kotlin-reflect:1.8.21")
-  implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1")
+  implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.5.1")
 
   // Formatting
   detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:$detektVersion")

json-schema/src/main/kotlin/io/bkbn/kompendium/json/schema/handler/SimpleObjectHandler.kt

@@ -34,7 +34,6 @@ object SimpleObjectHandler {
     schemaConfigurator: SchemaConfigurator,
     enrichment: TypeEnrichment<*>?,
   ): JsonSchema {
-
     cache[type.getSlug(enrichment)] = ReferenceDefinition(type.getReferenceSlug(enrichment))
 
     val typeMap = clazz.typeParameters.zip(type.arguments).toMap()
@@ -134,8 +133,8 @@ object SimpleObjectHandler {
       ?: error("This indicates a bug in Kompendium, please open a GitHub issue")
     return SchemaGenerator.fromTypeToSchema(type, cache, schemaConfigurator, propEnrichment?.typeEnrichment).let {
       if (it.isOrContainsObjectOrEnumDef()) {
-        cache[type.getSlug(propEnrichment)] = it
+        cache[type.getSlug(propEnrichment?.typeEnrichment)] = it
-        ReferenceDefinition(type.getReferenceSlug(propEnrichment))
+        ReferenceDefinition(type.getReferenceSlug(propEnrichment?.typeEnrichment))
       } else {
         it
       }
@@ -176,6 +175,7 @@ object SimpleObjectHandler {
       maxItems = maxItems,
       uniqueItems = uniqueItems,
     )
+
     is EnumDefinition -> schema.copy(deprecated = deprecated, description = description)
     is MapDefinition -> schema.copy(deprecated = deprecated, description = description)
     is NullableDefinition -> schema.copy(deprecated = deprecated, description = description)

json-schema/src/test/kotlin/io/bkbn/kompendium/json/schema/SchemaGeneratorTest.kt

@@ -7,11 +7,12 @@ import io.bkbn.kompendium.core.fixtures.ObjectWithEnum
 import io.bkbn.kompendium.core.fixtures.SerialNameObject
 import io.bkbn.kompendium.core.fixtures.SimpleEnum
 import io.bkbn.kompendium.core.fixtures.SlammaJamma
-import io.bkbn.kompendium.core.fixtures.TestHelpers.getFileSnapshot
 import io.bkbn.kompendium.core.fixtures.TestResponse
 import io.bkbn.kompendium.core.fixtures.TestSimpleRequest
 import io.bkbn.kompendium.core.fixtures.TransientObject
 import io.bkbn.kompendium.core.fixtures.UnbackedObject
+import io.bkbn.kompendium.core.fixtures.GenericObject
+import io.bkbn.kompendium.core.fixtures.TestHelpers.getFileSnapshot
 import io.bkbn.kompendium.enrichment.TypeEnrichment
 import io.bkbn.kompendium.json.schema.definition.JsonSchema
 import io.kotest.assertions.json.shouldEqualJson
@@ -62,6 +63,9 @@ class SchemaGeneratorTest : DescribeSpec({
     it("Can generate the schema for object with SerialName annotation") {
       jsonSchemaTest<SerialNameObject>("T0020__serial_name_object.json")
     }
+    it("Can generate the schema for object with generic property") {
+      jsonSchemaTest<GenericObject<TestSimpleRequest>>("T0024__generic_object.json")
+    }
   }
   describe("Enums") {
     it("Can generate the schema for a simple enum") {
@@ -135,6 +139,24 @@ class SchemaGeneratorTest : DescribeSpec({
         }
       )
     }
+    it("Can properly assign a reference to a generic object") {
+      jsonSchemaTest<GenericObject<TestSimpleRequest>>(
+        snapshotName = "T0025__enrichment_generic_object.json",
+        enrichment = TypeEnrichment("generic") {
+          GenericObject<TestSimpleRequest>::data {
+            description = "This is a generic param"
+            typeEnrichment = TypeEnrichment("simple") {
+              TestSimpleRequest::a {
+                description = "This is a simple description"
+              }
+              TestSimpleRequest::b {
+                deprecated = true
+              }
+            }
+          }
+        }
+      )
+    }
   }
 }) {
   companion object {

json-schema/src/test/resources/T0024__generic_object.json

@@ -0,0 +1,11 @@
+{
+  "type": "object",
+  "properties": {
+    "data": {
+      "$ref": "#/components/schemas/TestSimpleRequest"
+    }
+  },
+  "required": [
+    "data"
+  ]
+}

json-schema/src/test/resources/T0025__enrichment_generic_object.json

@@ -0,0 +1,12 @@
+{
+  "type": "object",
+  "properties": {
+    "data": {
+      "description": "This is a generic param",
+      "$ref": "#/components/schemas/TestSimpleRequest-simple"
+    }
+  },
+  "required": [
+    "data"
+  ]
+}

locations/build.gradle.kts

@@ -22,8 +22,8 @@ dependencies {
   // IMPLEMENTATION
 
   implementation(projects.kompendiumCore)
-  implementation("io.ktor:ktor-server-core:2.2.3")
+  implementation("io.ktor:ktor-server-core:2.3.0")
-  implementation("io.ktor:ktor-server-locations:2.2.3")
+  implementation("io.ktor:ktor-server-locations:2.3.0")
 
   // TESTING
 

locations/src/test/kotlin/io/bkbn/kompendium/locations/util/TestModels.kt

@@ -7,6 +7,7 @@ data class Listing(val name: String, val page: Int)
 data class Type(val name: String) {
   @Location("/edit")
   data class Edit(val parent: Type)
+
   @Location("/other/{page}")
   data class Other(val parent: Type, val page: Int)
 }

oas/build.gradle.kts

@@ -22,7 +22,7 @@ dependencies {
 
   api(projects.kompendiumJsonSchema)
   api(projects.kompendiumEnrichment)
-  implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1")
+  implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.5.1")
 
   // Formatting
   detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:$detektVersion")

playground/build.gradle.kts

@@ -37,12 +37,12 @@ dependencies {
   implementation("org.apache.logging.log4j:log4j-api-kotlin:1.2.0")
   implementation("org.apache.logging.log4j:log4j-api:2.20.0")
   implementation("org.apache.logging.log4j:log4j-core:2.20.0")
-  implementation("org.slf4j:slf4j-api:2.0.6")
+  implementation("org.slf4j:slf4j-api:2.0.7")
-  implementation("org.slf4j:slf4j-simple:2.0.6")
+  implementation("org.slf4j:slf4j-simple:2.0.7")
 
 
-  implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1")
+  implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.5.1")
   implementation("org.jetbrains.kotlinx:kotlinx-datetime:0.4.0")
 
-  implementation("joda-time:joda-time:2.12.2")
+  implementation("joda-time:joda-time:2.12.5")
 }

protobuf-java-converter/build.gradle.kts

@@ -22,9 +22,9 @@ dependencies {
 
 
   implementation(projects.kompendiumJsonSchema)
-  implementation("com.google.protobuf:protobuf-java:3.22.0")
+  implementation("com.google.protobuf:protobuf-java:3.23.1")
-  implementation("org.jetbrains.kotlin:kotlin-reflect:1.8.10")
+  implementation("org.jetbrains.kotlin:kotlin-reflect:1.8.21")
-  implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1")
+  implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.5.1")
 
   // Formatting
   detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:$detektVersion")

resources/build.gradle.kts

@@ -22,8 +22,8 @@ dependencies {
   // IMPLEMENTATION
 
   implementation(projects.kompendiumCore)
-  implementation("io.ktor:ktor-server-core:2.2.3")
+  implementation("io.ktor:ktor-server-core:2.3.0")
-  implementation("io.ktor:ktor-server-resources:2.2.3")
+  implementation("io.ktor:ktor-server-resources:2.3.0")
 
   // TESTING
 

resources/src/test/kotlin/io/bkbn/kompendium/resources/util/TestModels.kt

@@ -11,6 +11,7 @@ data class Type(val name: String) {
   @Serializable
   @Resource("/edit")
   data class Edit(val parent: Type)
+
   @Serializable
   @Resource("/other/{page}")
   data class Other(val parent: Type, val page: Int)