feat: support no request body for post, put and patch (#427)

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

.github/workflows/autoupdate.yml

@@ -1,12 +0,0 @@
-name: autoupdate
-on:
-  push:
-    branches: [ main ]
-jobs:
-  autoupdate:
-    name: autoupdate
-    runs-on: ubuntu-latest
-    steps:
-      - uses: docker://chinthakagodawita/autoupdate-action:v1
-        env:
-          GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'

CHANGELOG.md

@@ -12,6 +12,56 @@
 
 ## Released
 
+## [3.13.0] - March 15th, 2023
+
+### Changed
+
+- Post, Put, and Patch now support not providing request info
+
+## [3.12.0] - March 14th, 2023
+
+### Added
+
+- Add support for swagger documentation
+
+## [3.11.0] - January 5th, 2023
+
+### Added
+
+- Support for type constraints.
+
+## [3.10.0] - January 4th, 2023
+
+### Added
+
+- Support for type enrichments!  `deprecated` and `description` to start
+
+## [3.9.0] - November 15th, 2022
+
+### Added
+
+- `protobuf-java-converter` module for converting generated protobuf objects to `JsonSchema` representations
+
+### Changed
+
+- Application `rootPath` is no longer prefixed to serialized route path when `NotarizedRoute` is resolved
+
+## [3.8.0] - November 9th, 2022
+
+### Added
+
+- Add support for NotarizedResource plugin scoped to route
+
+### Changed
+
+- Support registering same path with different authentication and methods
+
+## [3.7.0] - November 5th, 2022
+
+### Added
+
+- Allow users to override media type in request and response
+
 ## [3.6.0] - November 5th, 2022
 
 ### Changed

build.gradle.kts

@@ -1,12 +1,12 @@
 plugins {
-  kotlin("jvm") version "1.7.20" apply false
-  kotlin("plugin.serialization") version "1.7.20" apply false
+  kotlin("jvm") version "1.8.10" apply false
+  kotlin("plugin.serialization") version "1.8.10" 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.1.0"
+  id("io.github.gradle-nexus.publish-plugin") version "1.2.0"
 }
 
 gitHooks {

core/build.gradle.kts

@@ -33,7 +33,6 @@ dependencies {
   implementation("io.ktor:ktor-server-html-builder:$ktorVersion")
   implementation("io.ktor:ktor-server-content-negotiation:$ktorVersion")
   implementation("io.ktor:ktor-serialization-kotlinx-json:$ktorVersion")
-  implementation("ch.qos.logback:logback-classic:1.4.4")
 
   // Formatting
   detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:$detektVersion")
@@ -58,7 +57,7 @@ dependencies {
   testFixturesApi("io.ktor:ktor-client:$ktorVersion")
   testFixturesApi("io.ktor:ktor-client-cio:$ktorVersion")
 
-  testFixturesApi("dev.forst:ktor-api-key:2.1.3")
+  testFixturesApi("dev.forst:ktor-api-key:2.2.2")
 
   testFixturesApi("org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1")
 }

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

@@ -1,13 +1,16 @@
 package io.bkbn.kompendium.core.metadata
 
+import io.bkbn.kompendium.enrichment.TypeEnrichment
 import io.bkbn.kompendium.oas.payload.MediaType
 import kotlin.reflect.KType
 import kotlin.reflect.typeOf
 
 class RequestInfo private constructor(
   val requestType: KType,
+  val typeEnrichment: TypeEnrichment<*>?,
   val description: String,
-  val examples: Map<String, MediaType.Example>?
+  val examples: Map<String, MediaType.Example>?,
+  val mediaTypes: Set<String>
 ) {
 
   companion object {
@@ -20,14 +23,23 @@ class RequestInfo private constructor(
 
   class Builder {
     private var requestType: KType? = null
+    private var typeEnrichment: TypeEnrichment<*>? = null
     private var description: String? = null
     private var examples: Map<String, MediaType.Example>? = null
+    private var mediaTypes: Set<String>? = null
 
     fun requestType(t: KType) = apply {
       this.requestType = t
     }
 
-    inline fun <reified T> requestType() = apply { requestType(typeOf<T>()) }
+    fun enrichment(t: TypeEnrichment<*>) = apply {
+      this.typeEnrichment = t
+    }
+
+    inline fun <reified T> requestType(enrichment: TypeEnrichment<T>? = null) = apply {
+      requestType(typeOf<T>())
+      enrichment?.let { enrichment(it) }
+    }
 
     fun description(s: String) = apply { this.description = s }
 
@@ -35,10 +47,16 @@ class RequestInfo private constructor(
       this.examples = e.toMap().mapValues { (_, v) -> MediaType.Example(v) }
     }
 
+    fun mediaTypes(vararg m: String) = apply {
+      this.mediaTypes = m.toSet()
+    }
+
     fun build() = RequestInfo(
       requestType = requestType ?: error("Request type must be present"),
       description = description ?: error("Description must be present"),
-      examples = examples
+      typeEnrichment = typeEnrichment,
+      examples = examples,
+      mediaTypes = mediaTypes ?: setOf("application/json")
     )
   }
 }

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

@@ -1,5 +1,6 @@
 package io.bkbn.kompendium.core.metadata
 
+import io.bkbn.kompendium.enrichment.TypeEnrichment
 import io.bkbn.kompendium.oas.payload.MediaType
 import io.ktor.http.HttpStatusCode
 import kotlin.reflect.KType
@@ -8,8 +9,10 @@ import kotlin.reflect.typeOf
 class ResponseInfo private constructor(
   val responseCode: HttpStatusCode,
   val responseType: KType,
+  val typeEnrichment: TypeEnrichment<*>?,
   val description: String,
-  val examples: Map<String, MediaType.Example>?
+  val examples: Map<String, MediaType.Example>?,
+  val mediaTypes: Set<String>
 ) {
 
   companion object {
@@ -23,8 +26,10 @@ class ResponseInfo private constructor(
   class Builder {
     private var responseCode: HttpStatusCode? = null
     private var responseType: KType? = null
+    private var typeEnrichment: TypeEnrichment<*>? = null
     private var description: String? = null
     private var examples: Map<String, MediaType.Example>? = null
+    private var mediaTypes: Set<String>? = null
 
     fun responseCode(code: HttpStatusCode) = apply {
       this.responseCode = code
@@ -34,7 +39,14 @@ class ResponseInfo private constructor(
       this.responseType = t
     }
 
-    inline fun <reified T> responseType() = apply { responseType(typeOf<T>()) }
+    fun enrichment(t: TypeEnrichment<*>) = apply {
+      this.typeEnrichment = t
+    }
+
+    inline fun <reified T> responseType(enrichment: TypeEnrichment<T>? = null) = apply {
+      responseType(typeOf<T>())
+      enrichment?.let { enrichment(it) }
+    }
 
     fun description(s: String) = apply { this.description = s }
 
@@ -42,11 +54,17 @@ class ResponseInfo private constructor(
       this.examples = e.toMap().mapValues { (_, v) -> MediaType.Example(v) }
     }
 
+    fun mediaTypes(vararg m: String) = apply {
+      this.mediaTypes = m.toSet()
+    }
+
     fun build() = ResponseInfo(
       responseCode = responseCode ?: error("You must provide a response code in order to build a Response!"),
       responseType = responseType ?: error("You must provide a response type in order to build a Response!"),
       description = description ?: error("You must provide a description in order to build a Response!"),
-      examples = examples
+      typeEnrichment = typeEnrichment,
+      examples = examples,
+      mediaTypes = mediaTypes ?: setOf("application/json")
     )
   }
 }

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

@@ -10,16 +10,17 @@ import io.bkbn.kompendium.core.metadata.PostInfo
 import io.bkbn.kompendium.core.metadata.PutInfo
 import io.bkbn.kompendium.core.util.Helpers.addToSpec
 import io.bkbn.kompendium.core.util.SpecConfig
+import io.bkbn.kompendium.oas.OpenApiSpec
 import io.bkbn.kompendium.oas.path.Path
-import io.bkbn.kompendium.oas.path.PathOperation
 import io.bkbn.kompendium.oas.payload.Parameter
 import io.ktor.server.application.ApplicationCallPipeline
 import io.ktor.server.application.Hook
+import io.ktor.server.application.PluginBuilder
 import io.ktor.server.application.createRouteScopedPlugin
 import io.ktor.server.routing.Route
+import io.ktor.server.routing.application
 
 object NotarizedRoute {
-
   class Config : SpecConfig {
     override var tags: Set<String> = emptySet()
     override var parameters: List<Parameter> = emptyList()
@@ -31,7 +32,6 @@ object NotarizedRoute {
     override var head: HeadInfo? = null
     override var options: OptionsInfo? = null
     override var security: Map<String, List<String>>? = null
-    internal var path: Path? = null
   }
 
   private object InstallHook : Hook<(ApplicationCallPipeline) -> Unit> {
@@ -44,69 +44,53 @@ object NotarizedRoute {
     name = "NotarizedRoute",
     createConfiguration = ::Config
   ) {
-
     // This is required in order to introspect the route path and authentication
     on(InstallHook) {
       val route = it as? Route ?: return@on
       val spec = application.attributes[KompendiumAttributes.openApiSpec]
       val routePath = route.calculateRoutePath()
       val authMethods = route.collectAuthMethods()
-      pluginConfig.path?.addDefaultAuthMethods(authMethods)
-      require(spec.paths[routePath] == null) {
-        """
-          The specified path ${Parameter.Location.path} has already been documented!
-          Please make sure that all notarized paths are unique
-        """.trimIndent()
+
+      addToSpec(spec, routePath, authMethods)
     }
-      spec.paths[routePath] = pluginConfig.path
-        ?: error("This indicates a bug in Kompendium. Please file a GitHub issue!")
   }
 
-    val spec = application.attributes[KompendiumAttributes.openApiSpec]
+  fun <T : SpecConfig> PluginBuilder<T>.addToSpec(
+    spec: OpenApiSpec,
+    fullPath: String,
+    authMethods: List<String>
+  ) {
+    val path = spec.paths[fullPath] ?: Path()
+
+    path.parameters = path.parameters?.plus(pluginConfig.parameters) ?: pluginConfig.parameters
     val serializableReader = application.attributes[KompendiumAttributes.schemaConfigurator]
 
-    val path = Path()
-    path.parameters = pluginConfig.parameters
+    pluginConfig.get?.addToSpec(path, spec, pluginConfig, serializableReader, fullPath, authMethods)
+    pluginConfig.delete?.addToSpec(path, spec, pluginConfig, serializableReader, fullPath, authMethods)
+    pluginConfig.head?.addToSpec(path, spec, pluginConfig, serializableReader, fullPath, authMethods)
+    pluginConfig.options?.addToSpec(path, spec, pluginConfig, serializableReader, fullPath, authMethods)
+    pluginConfig.post?.addToSpec(path, spec, pluginConfig, serializableReader, fullPath, authMethods)
+    pluginConfig.put?.addToSpec(path, spec, pluginConfig, serializableReader, fullPath, authMethods)
+    pluginConfig.patch?.addToSpec(path, spec, pluginConfig, serializableReader, fullPath, authMethods)
 
-    pluginConfig.get?.addToSpec(path, spec, pluginConfig, serializableReader)
-    pluginConfig.delete?.addToSpec(path, spec, pluginConfig, serializableReader)
-    pluginConfig.head?.addToSpec(path, spec, pluginConfig, serializableReader)
-    pluginConfig.options?.addToSpec(path, spec, pluginConfig, serializableReader)
-    pluginConfig.post?.addToSpec(path, spec, pluginConfig, serializableReader)
-    pluginConfig.put?.addToSpec(path, spec, pluginConfig, serializableReader)
-    pluginConfig.patch?.addToSpec(path, spec, pluginConfig, serializableReader)
-
-    pluginConfig.path = path
+    spec.paths[fullPath] = path
   }
 
-  private fun Route.calculateRoutePath() = toString().replace(Regex("/\\(.+\\)"), "")
-  private fun Route.collectAuthMethods() = toString()
+  fun Route.calculateRoutePath() = toString()
+    .let {
+      application.environment.rootPath.takeIf { root -> root.isNotEmpty() }
+        ?.let { root ->
+          val sanitizedRoute = if (root.startsWith("/")) root else "/$root"
+          it.replace(sanitizedRoute, "")
+        }
+        ?: it
+    }
+    .replace(Regex("/\\(.+\\)"), "")
+
+  fun Route.collectAuthMethods() = toString()
     .split("/")
     .filter { it.contains(Regex("\\(authenticate .*\\)")) }
     .map { it.replace("(authenticate ", "").replace(")", "") }
     .map { it.split(", ") }
     .flatten()
-
-  private fun Path.addDefaultAuthMethods(methods: List<String>) {
-    get?.addDefaultAuthMethods(methods)
-    put?.addDefaultAuthMethods(methods)
-    post?.addDefaultAuthMethods(methods)
-    delete?.addDefaultAuthMethods(methods)
-    options?.addDefaultAuthMethods(methods)
-    head?.addDefaultAuthMethods(methods)
-    patch?.addDefaultAuthMethods(methods)
-    trace?.addDefaultAuthMethods(methods)
-  }
-
-  private fun PathOperation.addDefaultAuthMethods(methods: List<String>) {
-    methods.forEach { m ->
-      if (security == null || security?.all { s -> !s.containsKey(m) } == true) {
-        if (security == null) {
-          security = mutableListOf(mapOf(m to emptyList()))
-        } else {
-          security?.add(mapOf(m to emptyList()))
-        }
-      }
-    }
-  }
 }

core/src/main/kotlin/io/bkbn/kompendium/core/routes/Redoc.kt

@@ -18,7 +18,7 @@ import kotlinx.html.unsafe
 /**
  * Provides an out-of-the-box route to view docs using ReDoc on the specified [path].
  * @param pageTitle Webpage title you wish to be displayed on your docs
- * @param route path to docs resource
+ * @param path path to docs resource
  * @param specUrl url to point ReDoc to the OpenAPI json document
  */
 fun Route.redoc(pageTitle: String = "Docs", path: String = "/docs", specUrl: String = "/openapi.json") {

core/src/main/kotlin/io/bkbn/kompendium/core/routes/Swagger.kt

@@ -0,0 +1,91 @@
+package io.bkbn.kompendium.core.routes
+
+import io.ktor.server.application.call
+import io.ktor.server.html.respondHtml
+import io.ktor.server.routing.Route
+import io.ktor.server.routing.get
+import io.ktor.server.routing.route
+import kotlinx.html.body
+import kotlinx.html.div
+import kotlinx.html.head
+import kotlinx.html.id
+import kotlinx.html.link
+import kotlinx.html.meta
+import kotlinx.html.script
+import kotlinx.html.title
+import kotlinx.html.unsafe
+
+/**
+ * Provides an out-of-the-box route to view docs using Swagger
+ * @see <a href="https://swagger.io/specification/">Swagger OpenApi Specification</a>
+ * for the latest supported open api version.
+ * @param pageTitle Webpage title you wish to be displayed on your docs
+ * @param path path to docs resource
+ * @param specUrl url to point Swagger to the OpenAPI json document
+ * @param swaggerVersion version of swagger-ui distribution
+ */
+fun Route.swagger(
+  pageTitle: String = "Docs",
+  path: String = "/swagger-ui",
+  specUrl: String = "/openapi.json",
+  swaggerVersion: String? = null
+) {
+  val swaggerVersionSuffix = if (swaggerVersion == null) "" else "@$swaggerVersion"
+
+  route(path) {
+    get {
+      call.respondHtml {
+        head {
+          title {
+            +pageTitle
+          }
+          meta {
+            charset = "utf-8"
+          }
+          meta {
+            name = "viewport"
+            content = "width=device-width, initial-scale=1"
+          }
+          link {
+            href = "https://unpkg.com/swagger-ui-dist$swaggerVersionSuffix/swagger-ui.css"
+            rel = "stylesheet"
+          }
+        }
+        body {
+          div {
+            id = "swagger-ui"
+          }
+          script {
+            src = "https://unpkg.com/swagger-ui-dist$swaggerVersionSuffix/swagger-ui-standalone-preset.js"
+          }
+          script {
+            src = "https://unpkg.com/swagger-ui-dist$swaggerVersionSuffix/swagger-ui-bundle.js"
+          }
+          unsafe {
+            +"""
+              <script>
+                window.onload = function () {
+                  // Build a system
+                  const ui = SwaggerUIBundle({
+                    url: "$specUrl",
+                    dom_id: '#swagger-ui',
+                    deepLinking: true,
+                    presets: [
+                      SwaggerUIBundle.presets.apis,
+                      SwaggerUIStandalonePreset
+                    ],
+                    plugins: [
+                      SwaggerUIBundle.plugins.DownloadUrl
+                    ],
+                    layout: "StandaloneLayout",
+                  })
+                  window.ui = ui
+                }
+              </script>
+            """.trimIndent()
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -10,13 +10,14 @@ import io.bkbn.kompendium.core.metadata.PatchInfo
 import io.bkbn.kompendium.core.metadata.PostInfo
 import io.bkbn.kompendium.core.metadata.PutInfo
 import io.bkbn.kompendium.core.metadata.ResponseInfo
+import io.bkbn.kompendium.enrichment.TypeEnrichment
 import io.bkbn.kompendium.json.schema.SchemaConfigurator
 import io.bkbn.kompendium.json.schema.SchemaGenerator
 import io.bkbn.kompendium.json.schema.definition.NullableDefinition
 import io.bkbn.kompendium.json.schema.definition.OneOfDefinition
 import io.bkbn.kompendium.json.schema.definition.ReferenceDefinition
 import io.bkbn.kompendium.json.schema.util.Helpers.getReferenceSlug
-import io.bkbn.kompendium.json.schema.util.Helpers.getSimpleSlug
+import io.bkbn.kompendium.json.schema.util.Helpers.getSlug
 import io.bkbn.kompendium.oas.OpenApiSpec
 import io.bkbn.kompendium.oas.path.Path
 import io.bkbn.kompendium.oas.path.PathOperation
@@ -24,32 +25,62 @@ import io.bkbn.kompendium.oas.payload.MediaType
 import io.bkbn.kompendium.oas.payload.Request
 import io.bkbn.kompendium.oas.payload.Response
 import kotlin.reflect.KClass
+import kotlin.reflect.KMutableProperty1
 import kotlin.reflect.KType
 
 object Helpers {
 
-  fun MethodInfo.addToSpec(path: Path, spec: OpenApiSpec, config: SpecConfig, schemaConfigurator: SchemaConfigurator) {
+  private fun PathOperation.addDefaultAuthMethods(methods: List<String>) {
+    methods.forEach { m ->
+      if (security == null || security?.all { s -> !s.containsKey(m) } == true) {
+        if (security == null) {
+          security = mutableListOf(mapOf(m to emptyList()))
+        } else {
+          security?.add(mapOf(m to emptyList()))
+        }
+      }
+    }
+  }
+
+  fun MethodInfo.addToSpec(
+    path: Path,
+    spec: OpenApiSpec,
+    config: SpecConfig,
+    schemaConfigurator: SchemaConfigurator,
+    routePath: String,
+    authMethods: List<String> = emptyList()
+  ) {
     SchemaGenerator.fromTypeOrUnit(
-      this.response.responseType,
-      spec.components.schemas, schemaConfigurator
+      type = this.response.responseType,
+      cache = spec.components.schemas,
+      schemaConfigurator = schemaConfigurator,
+      enrichment = this.response.typeEnrichment,
     )?.let { schema ->
-      spec.components.schemas[this.response.responseType.getSimpleSlug()] = schema
+      spec.components.schemas[this.response.responseType.getSlug(this.response.typeEnrichment)] = schema
     }
 
     errors.forEach { error ->
-      SchemaGenerator.fromTypeOrUnit(error.responseType, spec.components.schemas, schemaConfigurator)?.let { schema ->
-        spec.components.schemas[error.responseType.getSimpleSlug()] = schema
+      SchemaGenerator.fromTypeOrUnit(
+        type = error.responseType,
+        cache = spec.components.schemas,
+        schemaConfigurator = schemaConfigurator,
+        enrichment = error.typeEnrichment,
+      )?.let { schema ->
+        spec.components.schemas[error.responseType.getSlug(error.typeEnrichment)] = schema
       }
     }
 
     when (this) {
       is MethodInfoWithRequest -> {
+        this.request?.let { reqInfo ->
           SchemaGenerator.fromTypeOrUnit(
-          this.request.requestType,
-          spec.components.schemas,
-          schemaConfigurator
+            type = reqInfo.requestType,
+            cache = spec.components.schemas,
+            schemaConfigurator = schemaConfigurator,
+            enrichment = reqInfo.typeEnrichment,
           )?.let { schema ->
-          spec.components.schemas[this.request.requestType.getSimpleSlug()] = schema
+            spec.components.schemas[reqInfo.requestType.getSlug(reqInfo.typeEnrichment)] = schema
+          }
         }
       }
 
@@ -57,15 +88,25 @@ object Helpers {
     }
 
     val operations = this.toPathOperation(config)
+    operations.addDefaultAuthMethods(authMethods)
 
-    when (this) {
-      is DeleteInfo -> path.delete = operations
-      is GetInfo -> path.get = operations
-      is HeadInfo -> path.head = operations
-      is PatchInfo -> path.patch = operations
-      is PostInfo -> path.post = operations
-      is PutInfo -> path.put = operations
-      is OptionsInfo -> path.options = operations
+    fun setOperation(
+      property: KMutableProperty1<Path, PathOperation?>
+    ) {
+      require(property.get(path) == null) {
+        "A route has already been registered for path: $routePath and method: ${property.name.uppercase()}"
+      }
+      property.set(path, operations)
+    }
+
+    return when (this) {
+      is DeleteInfo -> setOperation(Path::delete)
+      is GetInfo -> setOperation(Path::get)
+      is HeadInfo -> setOperation(Path::head)
+      is PatchInfo -> setOperation(Path::patch)
+      is PostInfo -> setOperation(Path::post)
+      is PutInfo -> setOperation(Path::put)
+      is OptionsInfo -> setOperation(Path::options)
     }
   }
 
@@ -82,18 +123,28 @@ object Helpers {
       ?.map { listOf(it).toMap() }
       ?.toMutableList(),
     requestBody = when (this) {
-      is MethodInfoWithRequest -> Request(
-        description = this.request.description,
-        content = this.request.requestType.toReferenceContent(this.request.examples),
+      is MethodInfoWithRequest -> this.request?.let { reqInfo ->
+        Request(
+          description = reqInfo.description,
+          content = reqInfo.requestType.toReferenceContent(
+            examples = reqInfo.examples,
+            mediaTypes = reqInfo.mediaTypes,
+            enrichment = reqInfo.typeEnrichment
+          ),
           required = true
         )
+      }
 
       else -> null
     },
     responses = mapOf(
       this.response.responseCode.value to Response(
         description = this.response.description,
-        content = this.response.responseType.toReferenceContent(this.response.examples)
+        content = this.response.responseType.toReferenceContent(
+          examples = this.response.examples,
+          mediaTypes = this.response.mediaTypes,
+          enrichment = this.response.typeEnrichment
+        )
       )
     ).plus(this.errors.toResponseMap())
   )
@@ -101,21 +152,33 @@ object Helpers {
   private fun List<ResponseInfo>.toResponseMap(): Map<Int, Response> = associate { error ->
     error.responseCode.value to Response(
       description = error.description,
-      content = error.responseType.toReferenceContent(error.examples)
+      content = error.responseType.toReferenceContent(
+        examples = error.examples,
+        mediaTypes = error.mediaTypes,
+        enrichment = error.typeEnrichment
+      )
     )
   }
 
-  private fun KType.toReferenceContent(examples: Map<String, MediaType.Example>?): Map<String, MediaType>? =
+  private fun KType.toReferenceContent(
+    examples: Map<String, MediaType.Example>?,
+    mediaTypes: Set<String>,
+    enrichment: TypeEnrichment<*>?
+  ): Map<String, MediaType>? =
     when (this.classifier as KClass<*>) {
       Unit::class -> null
-      else -> mapOf(
-        "application/json" to MediaType(
-          schema = if (this.isMarkedNullable) OneOfDefinition(
+      else -> mediaTypes.associateWith {
+        MediaType(
+          schema = if (this.isMarkedNullable) {
+            OneOfDefinition(
               NullableDefinition(),
-            ReferenceDefinition(this.getReferenceSlug())
-          ) else ReferenceDefinition(this.getReferenceSlug()),
+              ReferenceDefinition(this.getReferenceSlug(enrichment))
+            )
+          } else {
+            ReferenceDefinition(this.getReferenceSlug(enrichment))
+          },
           examples = examples
         )
-      )
+      }
     }
 }

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

@@ -2,57 +2,71 @@ package io.bkbn.kompendium.core
 
 import dev.forst.ktor.apikey.apiKey
 import io.bkbn.kompendium.core.fixtures.TestHelpers.openApiTestAllSerializers
-import io.bkbn.kompendium.core.util.TestModules.complexRequest
-import io.bkbn.kompendium.core.util.TestModules.customAuthConfig
-import io.bkbn.kompendium.core.util.TestModules.customFieldNameResponse
-import io.bkbn.kompendium.core.util.TestModules.dateTimeString
-import io.bkbn.kompendium.core.util.TestModules.defaultAuthConfig
-import io.bkbn.kompendium.core.util.TestModules.defaultField
-import io.bkbn.kompendium.core.util.TestModules.defaultParameter
-import io.bkbn.kompendium.core.util.TestModules.exampleParams
-import io.bkbn.kompendium.core.util.TestModules.genericException
-import io.bkbn.kompendium.core.util.TestModules.genericPolymorphicResponse
-import io.bkbn.kompendium.core.util.TestModules.genericPolymorphicResponseMultipleImpls
-import io.bkbn.kompendium.core.util.TestModules.gnarlyGenericResponse
-import io.bkbn.kompendium.core.util.TestModules.headerParameter
-import io.bkbn.kompendium.core.util.TestModules.ignoredFieldsResponse
-import io.bkbn.kompendium.core.util.TestModules.multipleAuthStrategies
-import io.bkbn.kompendium.core.util.TestModules.multipleExceptions
-import io.bkbn.kompendium.core.util.TestModules.nestedGenericCollection
-import io.bkbn.kompendium.core.util.TestModules.nestedGenericMultipleParamsCollection
-import io.bkbn.kompendium.core.util.TestModules.nestedGenericResponse
-import io.bkbn.kompendium.core.util.TestModules.nestedTypeName
-import io.bkbn.kompendium.core.util.TestModules.nestedUnderRoot
-import io.bkbn.kompendium.core.util.TestModules.nonRequiredParam
-import io.bkbn.kompendium.core.util.TestModules.nonRequiredParams
-import io.bkbn.kompendium.core.util.TestModules.notarizedDelete
-import io.bkbn.kompendium.core.util.TestModules.notarizedGet
-import io.bkbn.kompendium.core.util.TestModules.notarizedHead
-import io.bkbn.kompendium.core.util.TestModules.notarizedOptions
-import io.bkbn.kompendium.core.util.TestModules.notarizedPatch
-import io.bkbn.kompendium.core.util.TestModules.notarizedPost
-import io.bkbn.kompendium.core.util.TestModules.notarizedPut
-import io.bkbn.kompendium.core.util.TestModules.nullableEnumField
-import io.bkbn.kompendium.core.util.TestModules.nullableField
-import io.bkbn.kompendium.core.util.TestModules.nullableNestedObject
-import io.bkbn.kompendium.core.util.TestModules.nullableReference
-import io.bkbn.kompendium.core.util.TestModules.polymorphicCollectionResponse
-import io.bkbn.kompendium.core.util.TestModules.polymorphicException
-import io.bkbn.kompendium.core.util.TestModules.polymorphicMapResponse
-import io.bkbn.kompendium.core.util.TestModules.polymorphicResponse
-import io.bkbn.kompendium.core.util.TestModules.primitives
-import io.bkbn.kompendium.core.util.TestModules.reqRespExamples
-import io.bkbn.kompendium.core.util.TestModules.requiredParams
-import io.bkbn.kompendium.core.util.TestModules.returnsList
-import io.bkbn.kompendium.core.util.TestModules.rootRoute
-import io.bkbn.kompendium.core.util.TestModules.simpleGenericResponse
-import io.bkbn.kompendium.core.util.TestModules.simplePathParsing
-import io.bkbn.kompendium.core.util.TestModules.simpleRecursive
-import io.bkbn.kompendium.core.util.TestModules.singleException
-import io.bkbn.kompendium.core.util.TestModules.topLevelNullable
-import io.bkbn.kompendium.core.util.TestModules.trailingSlash
-import io.bkbn.kompendium.core.util.TestModules.unbackedFieldsResponse
-import io.bkbn.kompendium.core.util.TestModules.withOperationId
+import io.bkbn.kompendium.core.util.arrayConstraints
+import io.bkbn.kompendium.core.util.complexRequest
+import io.bkbn.kompendium.core.util.customAuthConfig
+import io.bkbn.kompendium.core.util.customFieldNameResponse
+import io.bkbn.kompendium.core.util.dateTimeString
+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.enrichedComplexGenericType
+import io.bkbn.kompendium.core.util.enrichedNestedCollection
+import io.bkbn.kompendium.core.util.enrichedSimpleRequest
+import io.bkbn.kompendium.core.util.enrichedSimpleResponse
+import io.bkbn.kompendium.core.util.exampleParams
+import io.bkbn.kompendium.core.util.genericException
+import io.bkbn.kompendium.core.util.genericPolymorphicResponse
+import io.bkbn.kompendium.core.util.genericPolymorphicResponseMultipleImpls
+import io.bkbn.kompendium.core.util.gnarlyGenericResponse
+import io.bkbn.kompendium.core.util.headerParameter
+import io.bkbn.kompendium.core.util.ignoredFieldsResponse
+import io.bkbn.kompendium.core.util.intConstraints
+import io.bkbn.kompendium.core.util.multipleAuthStrategies
+import io.bkbn.kompendium.core.util.multipleExceptions
+import io.bkbn.kompendium.core.util.nestedGenericCollection
+import io.bkbn.kompendium.core.util.nestedGenericMultipleParamsCollection
+import io.bkbn.kompendium.core.util.nestedGenericResponse
+import io.bkbn.kompendium.core.util.nestedTypeName
+import io.bkbn.kompendium.core.util.nestedUnderRoot
+import io.bkbn.kompendium.core.util.nonRequiredParam
+import io.bkbn.kompendium.core.util.nonRequiredParams
+import io.bkbn.kompendium.core.util.notarizedDelete
+import io.bkbn.kompendium.core.util.notarizedGet
+import io.bkbn.kompendium.core.util.notarizedHead
+import io.bkbn.kompendium.core.util.notarizedOptions
+import io.bkbn.kompendium.core.util.notarizedPatch
+import io.bkbn.kompendium.core.util.notarizedPost
+import io.bkbn.kompendium.core.util.notarizedPut
+import io.bkbn.kompendium.core.util.nullableEnumField
+import io.bkbn.kompendium.core.util.nullableField
+import io.bkbn.kompendium.core.util.nullableNestedObject
+import io.bkbn.kompendium.core.util.nullableReference
+import io.bkbn.kompendium.core.util.overrideMediaTypes
+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.requiredParams
+import io.bkbn.kompendium.core.util.returnsList
+import io.bkbn.kompendium.core.util.rootRoute
+import io.bkbn.kompendium.core.util.samePathDifferentMethodsAndAuth
+import io.bkbn.kompendium.core.util.samePathSameMethod
+import io.bkbn.kompendium.core.util.simpleGenericResponse
+import io.bkbn.kompendium.core.util.simplePathParsing
+import io.bkbn.kompendium.core.util.simpleRecursive
+import io.bkbn.kompendium.core.util.singleException
+import io.bkbn.kompendium.core.util.stringConstraints
+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.unbackedFieldsResponse
+import io.bkbn.kompendium.core.util.withOperationId
 import io.bkbn.kompendium.json.schema.definition.TypeDefinition
 import io.bkbn.kompendium.json.schema.exception.UnknownSchemaException
 import io.bkbn.kompendium.oas.component.Components
@@ -74,8 +88,9 @@ import io.ktor.server.auth.UserIdPrincipal
 import io.ktor.server.auth.basic
 import io.ktor.server.auth.jwt.jwt
 import io.ktor.server.auth.oauth
-import kotlin.reflect.typeOf
+import java.net.URI
 import java.time.Instant
+import kotlin.reflect.typeOf
 
 class KompendiumTest : DescribeSpec({
   describe("Notarized Open API Metadata Tests") {
@@ -112,6 +127,12 @@ class KompendiumTest : DescribeSpec({
     it("Can notarize a route with non-required params") {
       openApiTestAllSerializers("T0011__non_required_params.json") { nonRequiredParams() }
     }
+    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() }
+    }
   }
   describe("Route Parsing") {
     it("Can parse a simple path and store it under the expected route") {
@@ -247,15 +268,65 @@ class KompendiumTest : DescribeSpec({
     it("Can handle top level nullable types") {
       openApiTestAllSerializers("T0051__top_level_nullable.json") { topLevelNullable() }
     }
+    it("Can handle multiple registrations for different methods with the same path and different auth") {
+      openApiTestAllSerializers(
+        "T0053__same_path_different_methods_and_auth.json",
+        applicationSetup = {
+          install(Authentication) {
+            basic("basic") {
+              realm = "Ktor Server"
+              validate { UserIdPrincipal("Placeholder") }
+            }
+          }
+        },
+        specOverrides = {
+          this.copy(
+            components = Components(
+              securitySchemes = mutableMapOf(
+                "basic" to BasicAuth()
+              )
+            )
+          )
+        }
+      ) { samePathDifferentMethodsAndAuth() }
+    }
+    it("Can generate paths without application root-path") {
+      openApiTestAllSerializers(
+        "T0054__app_with_rootpath.json",
+        applicationEnvironmentBuilder = {
+          rootPath = "/example"
+        },
+        specOverrides = {
+          copy(
+            servers = servers.map { it.copy(url = URI("${it.url}/example")) }.toMutableList()
+          )
+        }
+      ) { notarizedGet() }
+    }
   }
   describe("Error Handling") {
     it("Throws a clear exception when an unidentified type is encountered") {
       val exception = shouldThrow<UnknownSchemaException> { openApiTestAllSerializers("") { dateTimeString() } }
       exception.message should startWith("An unknown type was encountered: class java.time.Instant")
     }
+    it("Throws an exception when same method for same path has been previously registered") {
+      val exception = shouldThrow<IllegalArgumentException> {
+        openApiTestAllSerializers(
+          snapshotName = "",
+          applicationSetup = {
+            install(Authentication) {
+              basic("basic") {
+                realm = "Ktor Server"
+                validate { UserIdPrincipal("Placeholder") }
+              }
+            }
+          },
+        ) {
+          samePathSameMethod()
+        }
+      }
+      exception.message should startWith("A route has already been registered for path: /test/{a} and method: GET")
     }
-  describe("Constraints") {
-    // TODO Assess strategies here
   }
   describe("Formats") {
     it("Can set a format for a simple type schema") {
@@ -364,4 +435,40 @@ class KompendiumTest : DescribeSpec({
       ) { multipleAuthStrategies() }
     }
   }
+  describe("Enrichment") {
+    it("Can enrich a simple request") {
+      openApiTestAllSerializers("T0055__enriched_simple_request.json") { enrichedSimpleRequest() }
+    }
+    it("Can enrich a simple response") {
+      openApiTestAllSerializers("T0058__enriched_simple_response.json") { enrichedSimpleResponse() }
+    }
+    it("Can enrich a nested collection") {
+      openApiTestAllSerializers("T0056__enriched_nested_collection.json") { enrichedNestedCollection() }
+    }
+    it("Can enrich a complex generic type") {
+      openApiTestAllSerializers("T0057__enriched_complex_generic_type.json") { enrichedComplexGenericType() }
+    }
+  }
+  describe("Constraints") {
+    it("Can apply constraints to an int field") {
+      openApiTestAllSerializers("T0059__int_constraints.json") { intConstraints() }
+    }
+    it("Can apply constraints to a double field") {
+      openApiTestAllSerializers("T0060__double_constraints.json") { doubleConstraints() }
+    }
+    it("Can apply a min and max length to a string field") {
+      openApiTestAllSerializers("T0061__string_min_max_constraints.json") { stringConstraints() }
+    }
+    it("Can apply a pattern to a string field") {
+      openApiTestAllSerializers("T0062__string_pattern_constraints.json") { stringPatternConstraints() }
+    }
+    it("Can apply a content encoding and media type to a string field") {
+      openApiTestAllSerializers("T0063__string_content_encoding_constraints.json") {
+        stringContentEncodingConstraints()
+      }
+    }
+    it("Can apply constraints to an array field") {
+      openApiTestAllSerializers("T0064__array_constraints.json") { arrayConstraints() }
+    }
+  }
 })

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

@@ -0,0 +1,51 @@
+package io.bkbn.kompendium.core.util
+
+import io.bkbn.kompendium.core.fixtures.TestResponse
+import io.bkbn.kompendium.core.metadata.GetInfo
+import io.bkbn.kompendium.core.plugin.NotarizedRoute
+import io.bkbn.kompendium.core.util.TestModules.defaultPathDescription
+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.ktor.http.HttpStatusCode
+import io.ktor.server.application.install
+import io.ktor.server.auth.authenticate
+import io.ktor.server.routing.Routing
+import io.ktor.server.routing.route
+
+fun Routing.defaultAuthConfig() {
+  authenticate("basic") {
+    route(rootPath) {
+      basicGetGenerator<TestResponse>()
+    }
+  }
+}
+
+fun Routing.customAuthConfig() {
+  authenticate("auth-oauth-google") {
+    route(rootPath) {
+      install(NotarizedRoute()) {
+        get = GetInfo.builder {
+          summary(defaultPathSummary)
+          description(defaultPathDescription)
+          response {
+            description(defaultResponseDescription)
+            responseCode(HttpStatusCode.OK)
+            responseType<TestResponse>()
+          }
+          security = mapOf(
+            "auth-oauth-google" to listOf("read:pets")
+          )
+        }
+      }
+    }
+  }
+}
+
+fun Routing.multipleAuthStrategies() {
+  authenticate("jwt", "api-key") {
+    route(rootPath) {
+      basicGetGenerator<TestResponse>()
+    }
+  }
+}

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

@@ -0,0 +1,160 @@
+package io.bkbn.kompendium.core.util
+
+import io.bkbn.kompendium.core.fixtures.DoubleResponse
+import io.bkbn.kompendium.core.fixtures.Page
+import io.bkbn.kompendium.core.fixtures.TestCreatedResponse
+import io.bkbn.kompendium.core.fixtures.TestNested
+import io.bkbn.kompendium.core.metadata.GetInfo
+import io.bkbn.kompendium.core.plugin.NotarizedRoute
+import io.bkbn.kompendium.core.util.TestModules.defaultPath
+import io.bkbn.kompendium.enrichment.TypeEnrichment
+import io.ktor.http.HttpStatusCode
+import io.ktor.server.application.install
+import io.ktor.server.routing.Routing
+import io.ktor.server.routing.route
+
+fun Routing.intConstraints() {
+  route(defaultPath) {
+    install(NotarizedRoute()) {
+      get = GetInfo.builder {
+        summary("Get an int")
+        description("Get an int")
+        response {
+          responseCode(HttpStatusCode.OK)
+          description("An int")
+          responseType(
+            enrichment = TypeEnrichment("example") {
+              TestCreatedResponse::id {
+                minimum = 2
+                maximum = 100
+                multipleOf = 2
+              }
+            }
+          )
+          responseCode(HttpStatusCode.OK)
+        }
+      }
+    }
+  }
+}
+
+fun Routing.doubleConstraints() {
+  route(defaultPath) {
+    install(NotarizedRoute()) {
+      get = GetInfo.builder {
+        summary("Get a double")
+        description("Get a double")
+        response {
+          responseCode(HttpStatusCode.OK)
+          description("A double")
+          responseType(
+            enrichment = TypeEnrichment("example") {
+              DoubleResponse::payload {
+                minimum = 2.0
+                maximum = 100.0
+                multipleOf = 2.0
+              }
+            }
+          )
+          responseCode(HttpStatusCode.OK)
+        }
+      }
+    }
+  }
+}
+
+fun Routing.stringConstraints() {
+  route(defaultPath) {
+    install(NotarizedRoute()) {
+      get = GetInfo.builder {
+        summary("Get a string")
+        description("Get a string with constraints")
+        response {
+          responseCode(HttpStatusCode.OK)
+          description("A string")
+          responseType(
+            enrichment = TypeEnrichment("example") {
+              TestNested::nesty {
+                maxLength = 10
+                minLength = 2
+              }
+            }
+          )
+          responseCode(HttpStatusCode.OK)
+        }
+      }
+    }
+  }
+}
+
+fun Routing.stringPatternConstraints() {
+  route(defaultPath) {
+    install(NotarizedRoute()) {
+      get = GetInfo.builder {
+        summary("Get a string")
+        description("This is a description")
+        response {
+          responseCode(HttpStatusCode.OK)
+          description("A string")
+          responseType(
+            enrichment = TypeEnrichment("example") {
+              TestNested::nesty {
+                pattern = "[a-z]+"
+              }
+            }
+          )
+          responseCode(HttpStatusCode.OK)
+        }
+      }
+    }
+  }
+}
+
+fun Routing.stringContentEncodingConstraints() {
+  route(defaultPath) {
+    install(NotarizedRoute()) {
+      get = GetInfo.builder {
+        summary("Get a string")
+        description("This is a description")
+        response {
+          responseCode(HttpStatusCode.OK)
+          description("A string")
+          responseType(
+            enrichment = TypeEnrichment("example") {
+              TestNested::nesty {
+                contentEncoding = "base64"
+                contentMediaType = "image/png"
+              }
+            }
+          )
+          responseCode(HttpStatusCode.OK)
+        }
+      }
+    }
+  }
+}
+
+fun Routing.arrayConstraints() {
+  route(defaultPath) {
+    install(NotarizedRoute()) {
+      get = GetInfo.builder {
+        summary("Get an array")
+        description("Get an array of strings")
+        response {
+          responseCode(HttpStatusCode.OK)
+          description("An array")
+          responseType(
+            enrichment = TypeEnrichment("example") {
+              Page<String>::content {
+                minItems = 2
+                maxItems = 10
+                uniqueItems = true
+              }
+            }
+          )
+          responseCode(HttpStatusCode.OK)
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,10 @@
+package io.bkbn.kompendium.core.util
+
+import io.bkbn.kompendium.core.fixtures.SerialNameObject
+import io.bkbn.kompendium.core.fixtures.TransientObject
+import io.bkbn.kompendium.core.fixtures.UnbackedObject
+import io.ktor.server.routing.Routing
+
+fun Routing.ignoredFieldsResponse() = basicGetGenerator<TransientObject>()
+fun Routing.unbackedFieldsResponse() = basicGetGenerator<UnbackedObject>()
+fun Routing.customFieldNameResponse() = basicGetGenerator<SerialNameObject>()

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

@@ -0,0 +1,16 @@
+package io.bkbn.kompendium.core.util
+
+import io.bkbn.kompendium.core.fixtures.TestResponse
+import io.bkbn.kompendium.json.schema.definition.TypeDefinition
+import io.bkbn.kompendium.oas.payload.Parameter
+import io.ktor.server.routing.Routing
+
+fun Routing.defaultParameter() = basicGetGenerator<TestResponse>(
+  params = listOf(
+    Parameter(
+      name = "id",
+      `in` = Parameter.Location.path,
+      schema = TypeDefinition.STRING.withDefault("IDK")
+    )
+  )
+)

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

@@ -0,0 +1,137 @@
+package io.bkbn.kompendium.core.util
+
+import io.bkbn.kompendium.core.fixtures.ComplexRequest
+import io.bkbn.kompendium.core.fixtures.MultiNestedGenerics
+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.metadata.GetInfo
+import io.bkbn.kompendium.core.metadata.PostInfo
+import io.bkbn.kompendium.core.plugin.NotarizedRoute
+import io.bkbn.kompendium.enrichment.TypeEnrichment
+import io.ktor.http.HttpStatusCode
+import io.ktor.server.application.install
+import io.ktor.server.routing.Routing
+import io.ktor.server.routing.route
+
+fun Routing.enrichedSimpleResponse() {
+  route("/enriched") {
+    install(NotarizedRoute()) {
+      get = GetInfo.builder {
+        summary(TestModules.defaultPathSummary)
+        description(TestModules.defaultPathDescription)
+        response {
+          responseType(
+            enrichment = TypeEnrichment("simple") {
+              TestResponse::c {
+                description = "A simple description"
+              }
+            }
+          )
+          description("A good response")
+          responseCode(HttpStatusCode.Created)
+        }
+      }
+    }
+  }
+}
+
+fun Routing.enrichedSimpleRequest() {
+  route("/example") {
+    install(NotarizedRoute()) {
+      parameters = TestModules.defaultParams
+      post = PostInfo.builder {
+        summary(TestModules.defaultPathSummary)
+        description(TestModules.defaultPathDescription)
+        request {
+          requestType(
+            enrichment = TypeEnrichment("simple") {
+              TestSimpleRequest::a {
+                description = "A simple description"
+              }
+              TestSimpleRequest::b {
+                deprecated = true
+              }
+            }
+          )
+          description("A test request")
+        }
+        response {
+          responseCode(HttpStatusCode.Created)
+          responseType<TestCreatedResponse>()
+          description(TestModules.defaultResponseDescription)
+        }
+      }
+    }
+  }
+}
+
+fun Routing.enrichedNestedCollection() {
+  route("/example") {
+    install(NotarizedRoute()) {
+      parameters = TestModules.defaultParams
+      post = PostInfo.builder {
+        summary(TestModules.defaultPathSummary)
+        description(TestModules.defaultPathDescription)
+        request {
+          requestType(
+            enrichment = TypeEnrichment("simple") {
+              ComplexRequest::tables {
+                description = "A nested item"
+                typeEnrichment = TypeEnrichment("nested") {
+                  NestedComplexItem::name {
+                    description = "A nested description"
+                  }
+                }
+              }
+            }
+          )
+          description("A test request")
+        }
+        response {
+          responseCode(HttpStatusCode.Created)
+          responseType<TestCreatedResponse>()
+          description(TestModules.defaultResponseDescription)
+        }
+      }
+    }
+  }
+}
+
+fun Routing.enrichedComplexGenericType() {
+  route("/example") {
+    install(NotarizedRoute()) {
+      parameters = TestModules.defaultParams
+      post = PostInfo.builder {
+        summary(TestModules.defaultPathSummary)
+        description(TestModules.defaultPathDescription)
+        request {
+          requestType(
+            enrichment = TypeEnrichment("simple") {
+              MultiNestedGenerics<String, ComplexRequest>::content {
+                description = "Getting pretty crazy"
+                typeEnrichment = TypeEnrichment("nested") {
+                  ComplexRequest::tables {
+                    description = "A nested item"
+                    typeEnrichment = TypeEnrichment("nested") {
+                      NestedComplexItem::name {
+                        description = "A nested description"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          )
+          description("A test request")
+        }
+        response {
+          responseCode(HttpStatusCode.Created)
+          responseType<TestCreatedResponse>()
+          description(TestModules.defaultResponseDescription)
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,16 @@
+package io.bkbn.kompendium.core.util
+
+import io.bkbn.kompendium.core.fixtures.TestResponse
+import io.bkbn.kompendium.core.util.TestModules.defaultPath
+import io.ktor.server.auth.authenticate
+import io.ktor.server.routing.Routing
+import io.ktor.server.routing.route
+
+fun Routing.samePathSameMethod() {
+  route(defaultPath) {
+    basicGetGenerator<TestResponse>()
+    authenticate("basic") {
+      basicGetGenerator<TestResponse>()
+    }
+  }
+}

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

@@ -0,0 +1,57 @@
+package io.bkbn.kompendium.core.util
+
+import io.bkbn.kompendium.core.fixtures.TestNested
+import io.bkbn.kompendium.core.fixtures.TestRequest
+import io.bkbn.kompendium.core.fixtures.TestResponse
+import io.bkbn.kompendium.core.metadata.PostInfo
+import io.bkbn.kompendium.core.plugin.NotarizedRoute
+import io.bkbn.kompendium.core.util.TestModules.defaultPathDescription
+import io.bkbn.kompendium.core.util.TestModules.defaultPathSummary
+import io.bkbn.kompendium.core.util.TestModules.defaultRequestDescription
+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.Parameter
+import io.ktor.http.HttpStatusCode
+import io.ktor.server.application.install
+import io.ktor.server.routing.Routing
+import io.ktor.server.routing.route
+
+fun Routing.reqRespExamples() {
+  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())
+          )
+        }
+        response {
+          description(defaultResponseDescription)
+          responseCode(HttpStatusCode.OK)
+          responseType<TestResponse>()
+          examples(
+            "Testerino" to TestResponse("Heya")
+          )
+        }
+      }
+    }
+  }
+}
+
+fun Routing.exampleParams() = basicGetGenerator<TestResponse>(
+  params = listOf(
+    Parameter(
+      name = "id",
+      `in` = Parameter.Location.path,
+      schema = TypeDefinition.STRING,
+      examples = mapOf(
+        "foo" to Parameter.Example("testing")
+      )
+    )
+  )
+)

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

@@ -0,0 +1,105 @@
+package io.bkbn.kompendium.core.util
+
+import io.bkbn.kompendium.core.fixtures.ExceptionResponse
+import io.bkbn.kompendium.core.fixtures.Flibbity
+import io.bkbn.kompendium.core.fixtures.FlibbityGibbit
+import io.bkbn.kompendium.core.fixtures.TestResponse
+import io.bkbn.kompendium.core.metadata.GetInfo
+import io.bkbn.kompendium.core.plugin.NotarizedRoute
+import io.bkbn.kompendium.core.util.TestModules.defaultPathDescription
+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.ktor.http.HttpStatusCode
+import io.ktor.server.application.install
+import io.ktor.server.routing.Routing
+import io.ktor.server.routing.route
+
+fun Routing.singleException() {
+  route(rootPath) {
+    install(NotarizedRoute()) {
+      get = GetInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+        response {
+          description(defaultResponseDescription)
+          responseCode(HttpStatusCode.OK)
+          responseType<TestResponse>()
+        }
+        canRespond {
+          description("Bad Things Happened")
+          responseCode(HttpStatusCode.BadRequest)
+          responseType<ExceptionResponse>()
+        }
+      }
+    }
+  }
+}
+
+fun Routing.multipleExceptions() {
+  route(rootPath) {
+    install(NotarizedRoute()) {
+      get = GetInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+        response {
+          description(defaultResponseDescription)
+          responseCode(HttpStatusCode.OK)
+          responseType<TestResponse>()
+        }
+        canRespond {
+          description("Bad Things Happened")
+          responseCode(HttpStatusCode.BadRequest)
+          responseType<ExceptionResponse>()
+        }
+        canRespond {
+          description("Access Denied")
+          responseCode(HttpStatusCode.Forbidden)
+          responseType<ExceptionResponse>()
+        }
+      }
+    }
+  }
+}
+
+fun Routing.polymorphicException() {
+  route(rootPath) {
+    install(NotarizedRoute()) {
+      get = GetInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+        response {
+          description(defaultResponseDescription)
+          responseCode(HttpStatusCode.OK)
+          responseType<TestResponse>()
+        }
+        canRespond {
+          description("Bad Things Happened")
+          responseCode(HttpStatusCode.InternalServerError)
+          responseType<FlibbityGibbit>()
+        }
+      }
+    }
+  }
+}
+
+fun Routing.genericException() {
+  route(rootPath) {
+    install(NotarizedRoute()) {
+      get = GetInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+        response {
+          description(defaultResponseDescription)
+          responseCode(HttpStatusCode.OK)
+          responseType<TestResponse>()
+        }
+        canRespond {
+          description("Bad Things Happened")
+          responseCode(HttpStatusCode.BadRequest)
+          responseType<Flibbity<String>>()
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,80 @@
+package io.bkbn.kompendium.core.util
+
+import io.bkbn.kompendium.core.fixtures.ColumnSchema
+import io.bkbn.kompendium.core.fixtures.DateTimeString
+import io.bkbn.kompendium.core.fixtures.ManyThings
+import io.bkbn.kompendium.core.fixtures.Nested
+import io.bkbn.kompendium.core.fixtures.NullableEnum
+import io.bkbn.kompendium.core.fixtures.ProfileUpdateRequest
+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.metadata.GetInfo
+import io.bkbn.kompendium.core.metadata.PutInfo
+import io.bkbn.kompendium.core.plugin.NotarizedRoute
+import io.bkbn.kompendium.core.util.TestModules.defaultParams
+import io.bkbn.kompendium.core.util.TestModules.defaultPath
+import io.bkbn.kompendium.core.util.TestModules.defaultPathDescription
+import io.bkbn.kompendium.core.util.TestModules.defaultPathSummary
+import io.bkbn.kompendium.core.util.TestModules.defaultRequestDescription
+import io.bkbn.kompendium.core.util.TestModules.defaultResponseDescription
+import io.bkbn.kompendium.json.schema.definition.TypeDefinition
+import io.bkbn.kompendium.oas.payload.Parameter
+import io.ktor.http.HttpStatusCode
+import io.ktor.server.application.install
+import io.ktor.server.auth.authenticate
+import io.ktor.server.routing.Routing
+import io.ktor.server.routing.route
+
+fun Routing.withOperationId() = basicGetGenerator<TestResponse>(operationId = "getThisDude")
+fun Routing.nullableNestedObject() = basicGetGenerator<ProfileUpdateRequest>()
+fun Routing.nullableEnumField() = basicGetGenerator<NullableEnum>()
+fun Routing.nullableReference() = basicGetGenerator<ManyThings>()
+fun Routing.dateTimeString() = basicGetGenerator<DateTimeString>()
+fun Routing.headerParameter() = basicGetGenerator<TestResponse>(
+  params = listOf(
+    Parameter(
+      name = "X-User-Email",
+      `in` = Parameter.Location.header,
+      schema = TypeDefinition.STRING,
+      required = true
+    )
+  )
+)
+
+fun Routing.nestedTypeName() = basicGetGenerator<Nested.Response>()
+fun Routing.topLevelNullable() = basicGetGenerator<TestResponse?>()
+fun Routing.simpleRecursive() = basicGetGenerator<ColumnSchema>()
+fun Routing.samePathDifferentMethodsAndAuth() {
+  route(defaultPath) {
+    install(NotarizedRoute()) {
+      parameters = defaultParams
+      get = GetInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+        response {
+          description(defaultResponseDescription)
+          responseCode(HttpStatusCode.OK)
+          responseType<TestResponse>()
+        }
+      }
+    }
+    authenticate("basic") {
+      install(NotarizedRoute()) {
+        put = PutInfo.builder {
+          summary(defaultPathSummary)
+          description(defaultPathDescription)
+          request {
+            description(defaultRequestDescription)
+            requestType<TestSimpleRequest>()
+          }
+          response {
+            description(defaultResponseDescription)
+            responseCode(HttpStatusCode.Created)
+            responseType<TestCreatedResponse>()
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,317 @@
+package io.bkbn.kompendium.core.util
+
+import io.bkbn.kompendium.core.fixtures.ComplexRequest
+import io.bkbn.kompendium.core.fixtures.TestCreatedResponse
+import io.bkbn.kompendium.core.fixtures.TestRequest
+import io.bkbn.kompendium.core.fixtures.TestResponse
+import io.bkbn.kompendium.core.fixtures.TestSimpleRequest
+import io.bkbn.kompendium.core.metadata.DeleteInfo
+import io.bkbn.kompendium.core.metadata.GetInfo
+import io.bkbn.kompendium.core.metadata.HeadInfo
+import io.bkbn.kompendium.core.metadata.OptionsInfo
+import io.bkbn.kompendium.core.metadata.PatchInfo
+import io.bkbn.kompendium.core.metadata.PostInfo
+import io.bkbn.kompendium.core.metadata.PutInfo
+import io.bkbn.kompendium.core.plugin.NotarizedRoute
+import io.bkbn.kompendium.core.util.TestModules.defaultParams
+import io.bkbn.kompendium.core.util.TestModules.defaultPath
+import io.bkbn.kompendium.core.util.TestModules.defaultPathDescription
+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.Parameter
+import io.ktor.http.HttpStatusCode
+import io.ktor.server.application.call
+import io.ktor.server.application.install
+import io.ktor.server.response.respond
+import io.ktor.server.response.respondText
+import io.ktor.server.routing.Routing
+import io.ktor.server.routing.delete
+import io.ktor.server.routing.get
+import io.ktor.server.routing.head
+import io.ktor.server.routing.options
+import io.ktor.server.routing.patch
+import io.ktor.server.routing.post
+import io.ktor.server.routing.put
+import io.ktor.server.routing.route
+
+fun Routing.notarizedGet() {
+  route(defaultPath) {
+    install(NotarizedRoute()) {
+      parameters = defaultParams
+      get = GetInfo.builder {
+        response {
+          responseCode(HttpStatusCode.OK)
+          responseType<TestResponse>()
+          description(defaultResponseDescription)
+        }
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+      }
+    }
+    get {
+      call.respondText { "hey dude ‼️ congrats on the get request" }
+    }
+  }
+}
+
+fun Routing.notarizedPost() {
+  route(defaultPath) {
+    install(NotarizedRoute()) {
+      parameters = defaultParams
+      post = PostInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+        request {
+          requestType<TestSimpleRequest>()
+          description("A Test request")
+        }
+        response {
+          responseCode(HttpStatusCode.Created)
+          responseType<TestCreatedResponse>()
+          description(defaultResponseDescription)
+        }
+      }
+    }
+    post {
+      call.respondText { "hey dude ‼️ congrats on the post request" }
+    }
+  }
+}
+
+fun Routing.notarizedPut() {
+  route(defaultPath) {
+    install(NotarizedRoute()) {
+      parameters = defaultParams
+      put = PutInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+        request {
+          requestType<TestSimpleRequest>()
+          description("A Test request")
+        }
+        response {
+          responseCode(HttpStatusCode.Created)
+          responseType<TestCreatedResponse>()
+          description(defaultResponseDescription)
+        }
+      }
+    }
+    put {
+      call.respondText { "hey dude ‼️ congrats on the post request" }
+    }
+  }
+}
+
+fun Routing.notarizedDelete() {
+  route(defaultPath) {
+    install(NotarizedRoute()) {
+      parameters = defaultParams
+      delete = DeleteInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+        response {
+          responseCode(HttpStatusCode.NoContent)
+          responseType<Unit>()
+          description(defaultResponseDescription)
+        }
+      }
+    }
+  }
+  delete {
+    call.respond(HttpStatusCode.NoContent)
+  }
+}
+
+fun Routing.notarizedPatch() {
+  route(defaultPath) {
+    install(NotarizedRoute()) {
+      parameters = defaultParams
+      patch = PatchInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+        request {
+          description("A Test request")
+          requestType<TestSimpleRequest>()
+        }
+        response {
+          responseCode(HttpStatusCode.Created)
+          responseType<TestCreatedResponse>()
+          description(defaultResponseDescription)
+        }
+      }
+    }
+    patch {
+      call.respond(HttpStatusCode.Created) { TestCreatedResponse(123, "Nice!") }
+    }
+  }
+}
+
+fun Routing.notarizedHead() {
+  route(defaultPath) {
+    install(NotarizedRoute()) {
+      parameters = defaultParams
+      head = HeadInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+
+        response {
+          description("great!")
+          responseCode(HttpStatusCode.Created)
+          responseType<Unit>()
+        }
+      }
+    }
+    head {
+      call.respond(HttpStatusCode.OK)
+    }
+  }
+}
+
+fun Routing.notarizedOptions() {
+  route(defaultPath) {
+    install(NotarizedRoute()) {
+      parameters = defaultParams
+      options = OptionsInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+        response {
+          responseCode(HttpStatusCode.OK)
+          responseType<TestResponse>()
+          description("nice")
+        }
+      }
+    }
+    options {
+      call.respond(HttpStatusCode.NoContent)
+    }
+  }
+}
+
+fun Routing.complexRequest() {
+  route(rootPath) {
+    install(NotarizedRoute()) {
+      put = PutInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+        request {
+          requestType<ComplexRequest>()
+          description("A Complex request")
+        }
+        response {
+          responseCode(HttpStatusCode.Created)
+          responseType<TestCreatedResponse>()
+          description(defaultResponseDescription)
+        }
+      }
+    }
+    patch {
+      call.respond(HttpStatusCode.Created, TestCreatedResponse(123, "nice!"))
+    }
+  }
+}
+
+fun Routing.primitives() {
+  route(rootPath) {
+    install(NotarizedRoute()) {
+      put = PutInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+        request {
+          requestType<Int>()
+          description("A Test Request")
+        }
+        response {
+          responseCode(HttpStatusCode.Created)
+          responseType<Boolean>()
+          description(defaultResponseDescription)
+        }
+      }
+    }
+  }
+}
+
+fun Routing.returnsList() {
+  route(defaultPath) {
+    install(NotarizedRoute()) {
+      parameters = defaultParams
+      get = GetInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+        response {
+          description("A Successful List-y Endeavor")
+          responseCode(HttpStatusCode.OK)
+          responseType<List<TestResponse>>()
+        }
+      }
+    }
+  }
+}
+
+fun Routing.nonRequiredParams() {
+  route("/optional") {
+    install(NotarizedRoute()) {
+      parameters = listOf(
+        Parameter(
+          name = "notRequired",
+          `in` = Parameter.Location.query,
+          schema = TypeDefinition.STRING,
+          required = false,
+        ),
+        Parameter(
+          name = "required",
+          `in` = Parameter.Location.query,
+          schema = TypeDefinition.STRING
+        )
+      )
+      get = GetInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+        response {
+          responseType<Unit>()
+          description("Empty")
+          responseCode(HttpStatusCode.NoContent)
+        }
+      }
+    }
+  }
+}
+
+fun Routing.overrideMediaTypes() {
+  route("/media_types") {
+    install(NotarizedRoute()) {
+      put = PutInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+        request {
+          mediaTypes("multipart/form-data", "application/json")
+          requestType<TestRequest>()
+          description("A cool request")
+        }
+        response {
+          mediaTypes("application/xml")
+          responseType<TestResponse>()
+          description("A good response")
+          responseCode(HttpStatusCode.Created)
+        }
+      }
+    }
+  }
+}
+
+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/PolymorphismAndGenerics.kt

@@ -0,0 +1,22 @@
+package io.bkbn.kompendium.core.util
+
+import io.bkbn.kompendium.core.fixtures.Barzo
+import io.bkbn.kompendium.core.fixtures.ComplexRequest
+import io.bkbn.kompendium.core.fixtures.Flibbity
+import io.bkbn.kompendium.core.fixtures.FlibbityGibbit
+import io.bkbn.kompendium.core.fixtures.Foosy
+import io.bkbn.kompendium.core.fixtures.Gibbity
+import io.bkbn.kompendium.core.fixtures.MultiNestedGenerics
+import io.bkbn.kompendium.core.fixtures.Page
+import io.ktor.server.routing.Routing
+
+fun Routing.polymorphicResponse() = basicGetGenerator<FlibbityGibbit>()
+fun Routing.polymorphicCollectionResponse() = basicGetGenerator<List<FlibbityGibbit>>()
+fun Routing.polymorphicMapResponse() = basicGetGenerator<Map<String, FlibbityGibbit>>()
+fun Routing.simpleGenericResponse() = basicGetGenerator<Gibbity<String>>()
+fun Routing.gnarlyGenericResponse() = basicGetGenerator<Foosy<Barzo<Int>, String>>()
+fun Routing.nestedGenericResponse() = basicGetGenerator<Gibbity<Map<String, String>>>()
+fun Routing.genericPolymorphicResponse() = basicGetGenerator<Flibbity<Double>>()
+fun Routing.genericPolymorphicResponseMultipleImpls() = basicGetGenerator<Flibbity<FlibbityGibbit>>()
+fun Routing.nestedGenericCollection() = basicGetGenerator<Page<Int>>()
+fun Routing.nestedGenericMultipleParamsCollection() = basicGetGenerator<MultiNestedGenerics<String, ComplexRequest>>()

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

@@ -0,0 +1,32 @@
+package io.bkbn.kompendium.core.util
+
+import io.bkbn.kompendium.core.fixtures.DefaultField
+import io.bkbn.kompendium.core.fixtures.NullableField
+import io.bkbn.kompendium.core.fixtures.TestResponse
+import io.bkbn.kompendium.json.schema.definition.TypeDefinition
+import io.bkbn.kompendium.oas.payload.Parameter
+import io.ktor.server.routing.Routing
+
+fun Routing.requiredParams() = basicGetGenerator<TestResponse>(
+  params = listOf(
+    Parameter(
+      name = "id",
+      `in` = Parameter.Location.path,
+      schema = TypeDefinition.STRING
+    )
+  )
+)
+
+fun Routing.nonRequiredParam() = basicGetGenerator<TestResponse>(
+  params = listOf(
+    Parameter(
+      name = "id",
+      `in` = Parameter.Location.query,
+      schema = TypeDefinition.STRING,
+      required = false
+    )
+  )
+)
+
+fun Routing.defaultField() = basicGetGenerator<DefaultField>()
+fun Routing.nullableField() = basicGetGenerator<NullableField>()

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

@@ -0,0 +1,102 @@
+package io.bkbn.kompendium.core.util
+
+import io.bkbn.kompendium.core.fixtures.TestResponse
+import io.bkbn.kompendium.core.metadata.GetInfo
+import io.bkbn.kompendium.core.plugin.NotarizedRoute
+import io.bkbn.kompendium.core.util.TestModules.defaultParams
+import io.bkbn.kompendium.core.util.TestModules.defaultPathDescription
+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.Parameter
+import io.ktor.http.HttpStatusCode
+import io.ktor.server.application.install
+import io.ktor.server.routing.Routing
+import io.ktor.server.routing.route
+
+fun Routing.simplePathParsing() {
+  route("/this") {
+    route("/is") {
+      route("/a") {
+        route("/complex") {
+          route("path") {
+            route("with/an/{id}") {
+              install(NotarizedRoute()) {
+                get = GetInfo.builder {
+                  parameters = listOf(
+                    Parameter(
+                      name = "id",
+                      `in` = Parameter.Location.path,
+                      schema = TypeDefinition.STRING
+                    )
+                  )
+                  summary(defaultPathSummary)
+                  description(defaultPathDescription)
+                  response {
+                    description(defaultResponseDescription)
+                    responseCode(HttpStatusCode.OK)
+                    responseType<TestResponse>()
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}
+
+fun Routing.rootRoute() {
+  route(rootPath) {
+    install(NotarizedRoute()) {
+      parameters = listOf(defaultParams.last())
+      get = GetInfo.builder {
+        summary(defaultPathSummary)
+        description(defaultPathDescription)
+        response {
+          description(defaultResponseDescription)
+          responseCode(HttpStatusCode.OK)
+          responseType<TestResponse>()
+        }
+      }
+    }
+  }
+}
+
+fun Routing.nestedUnderRoot() {
+  route("/") {
+    route("/testerino") {
+      install(NotarizedRoute()) {
+        get = GetInfo.builder {
+          summary(defaultPathSummary)
+          description(defaultPathDescription)
+          response {
+            description(defaultResponseDescription)
+            responseCode(HttpStatusCode.OK)
+            responseType<TestResponse>()
+          }
+        }
+      }
+    }
+  }
+}
+
+fun Routing.trailingSlash() {
+  route("/test") {
+    route("/") {
+      install(NotarizedRoute()) {
+        get = GetInfo.builder {
+          summary(defaultPathSummary)
+          description(defaultPathDescription)
+          response {
+            description(defaultResponseDescription)
+            responseCode(HttpStatusCode.OK)
+            responseType<TestResponse>()
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -1,66 +1,29 @@
 package io.bkbn.kompendium.core.util
 
-import io.bkbn.kompendium.core.fixtures.Barzo
-import io.bkbn.kompendium.core.fixtures.ColumnSchema
-import io.bkbn.kompendium.core.fixtures.ComplexRequest
-import io.bkbn.kompendium.core.fixtures.DateTimeString
-import io.bkbn.kompendium.core.fixtures.DefaultField
-import io.bkbn.kompendium.core.fixtures.ExceptionResponse
-import io.bkbn.kompendium.core.fixtures.Flibbity
-import io.bkbn.kompendium.core.fixtures.FlibbityGibbit
-import io.bkbn.kompendium.core.fixtures.Foosy
-import io.bkbn.kompendium.core.fixtures.Gibbity
-import io.bkbn.kompendium.core.fixtures.ManyThings
-import io.bkbn.kompendium.core.fixtures.MultiNestedGenerics
-import io.bkbn.kompendium.core.fixtures.Nested
-import io.bkbn.kompendium.core.fixtures.NullableEnum
-import io.bkbn.kompendium.core.fixtures.NullableField
-import io.bkbn.kompendium.core.fixtures.Page
-import io.bkbn.kompendium.core.fixtures.ProfileUpdateRequest
-import io.bkbn.kompendium.core.fixtures.SerialNameObject
-import io.bkbn.kompendium.core.fixtures.TestCreatedResponse
-import io.bkbn.kompendium.core.fixtures.TestNested
-import io.bkbn.kompendium.core.fixtures.TestRequest
-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.metadata.DeleteInfo
 import io.bkbn.kompendium.core.metadata.GetInfo
-import io.bkbn.kompendium.core.metadata.HeadInfo
-import io.bkbn.kompendium.core.metadata.OptionsInfo
-import io.bkbn.kompendium.core.metadata.PatchInfo
-import io.bkbn.kompendium.core.metadata.PostInfo
-import io.bkbn.kompendium.core.metadata.PutInfo
 import io.bkbn.kompendium.core.plugin.NotarizedRoute
+import io.bkbn.kompendium.core.util.TestModules.defaultPathDescription
+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.Parameter
 import io.ktor.http.HttpStatusCode
-import io.ktor.server.application.call
 import io.ktor.server.application.install
-import io.ktor.server.auth.authenticate
-import io.ktor.server.response.respond
-import io.ktor.server.response.respondText
 import io.ktor.server.routing.Route
 import io.ktor.server.routing.Routing
-import io.ktor.server.routing.delete
-import io.ktor.server.routing.get
-import io.ktor.server.routing.head
-import io.ktor.server.routing.options
-import io.ktor.server.routing.patch
-import io.ktor.server.routing.post
-import io.ktor.server.routing.put
 import io.ktor.server.routing.route
 
 object TestModules {
-  private const val defaultPath = "/test/{a}"
-  private const val rootPath = "/"
-  private const val defaultResponseDescription = "A Successful Endeavor"
-  private const val defaultRequestDescription = "You gotta send it"
-  private const val defaultPathSummary = "Great Summary!"
-  private const val defaultPathDescription = "testing more"
 
-  private val defaultParams = listOf(
+  const val defaultPath = "/test/{a}"
+  const val rootPath = "/"
+  const val defaultResponseDescription = "A Successful Endeavor"
+  const val defaultRequestDescription = "You gotta send it"
+  const val defaultPathSummary = "Great Summary!"
+  const val defaultPathDescription = "testing more"
+
+  val defaultParams = listOf(
     Parameter(
       name = "a",
       `in` = Parameter.Location.path,
@@ -72,601 +35,21 @@ object TestModules {
       schema = TypeDefinition.INT
     )
   )
+}
 
-  fun Routing.notarizedGet() {
-    route(defaultPath) {
-      install(NotarizedRoute()) {
-        parameters = defaultParams
-        get = GetInfo.builder {
-          response {
-            responseCode(HttpStatusCode.OK)
-            responseType<TestResponse>()
-            description(defaultResponseDescription)
-          }
-          summary(defaultPathSummary)
-          description(defaultPathDescription)
-        }
-      }
-      get {
-        call.respondText { "hey dude ‼️ congrats on the get request" }
-      }
-    }
-  }
-
-  fun Routing.notarizedPost() {
-    route(defaultPath) {
-      install(NotarizedRoute()) {
-        parameters = defaultParams
-        post = PostInfo.builder {
-          summary(defaultPathSummary)
-          description(defaultPathDescription)
-          request {
-            requestType<TestSimpleRequest>()
-            description("A Test request")
-          }
-          response {
-            responseCode(HttpStatusCode.Created)
-            responseType<TestCreatedResponse>()
-            description(defaultResponseDescription)
-          }
-        }
-      }
-      post {
-        call.respondText { "hey dude ‼️ congrats on the post request" }
-      }
-    }
-  }
-
-  fun Routing.notarizedPut() {
-    route(defaultPath) {
-      install(NotarizedRoute()) {
-        parameters = defaultParams
-        put = PutInfo.builder {
-          summary(defaultPathSummary)
-          description(defaultPathDescription)
-          request {
-            requestType<TestSimpleRequest>()
-            description("A Test request")
-          }
-          response {
-            responseCode(HttpStatusCode.Created)
-            responseType<TestCreatedResponse>()
-            description(defaultResponseDescription)
-          }
-        }
-      }
-      put {
-        call.respondText { "hey dude ‼️ congrats on the post request" }
-      }
-    }
-  }
-
-  fun Routing.notarizedDelete() {
-    route(defaultPath) {
-      install(NotarizedRoute()) {
-        parameters = defaultParams
-        delete = DeleteInfo.builder {
-          summary(defaultPathSummary)
-          description(defaultPathDescription)
-          response {
-            responseCode(HttpStatusCode.NoContent)
-            responseType<Unit>()
-            description(defaultResponseDescription)
-          }
-        }
-      }
-    }
-    delete {
-      call.respond(HttpStatusCode.NoContent)
-    }
-  }
-
-  fun Routing.notarizedPatch() {
-    route(defaultPath) {
-      install(NotarizedRoute()) {
-        parameters = defaultParams
-        patch = PatchInfo.builder {
-          summary(defaultPathSummary)
-          description(defaultPathDescription)
-          request {
-            description("A Test request")
-            requestType<TestSimpleRequest>()
-          }
-          response {
-            responseCode(HttpStatusCode.Created)
-            responseType<TestCreatedResponse>()
-            description(defaultResponseDescription)
-          }
-        }
-      }
-      patch {
-        call.respond(HttpStatusCode.Created) { TestCreatedResponse(123, "Nice!") }
-      }
-    }
-  }
-
-  fun Routing.notarizedHead() {
-    route(defaultPath) {
-      install(NotarizedRoute()) {
-        parameters = defaultParams
-        head = HeadInfo.builder {
-          summary(defaultPathSummary)
-          description(defaultPathDescription)
-
-          response {
-            description("great!")
-            responseCode(HttpStatusCode.Created)
-            responseType<Unit>()
-          }
-        }
-      }
-      head {
-        call.respond(HttpStatusCode.OK)
-      }
-    }
-  }
-
-  fun Routing.notarizedOptions() {
-    route(defaultPath) {
-      install(NotarizedRoute()) {
-        parameters = defaultParams
-        options = OptionsInfo.builder {
-          summary(defaultPathSummary)
-          description(defaultPathDescription)
-          response {
-            responseCode(HttpStatusCode.OK)
-            responseType<TestResponse>()
-            description("nice")
-          }
-        }
-      }
-      options {
-        call.respond(HttpStatusCode.NoContent)
-      }
-    }
-  }
-
-  fun Routing.complexRequest() {
-    route(rootPath) {
-      install(NotarizedRoute()) {
-        put = PutInfo.builder {
-          summary(defaultPathSummary)
-          description(defaultPathDescription)
-          request {
-            requestType<ComplexRequest>()
-            description("A Complex request")
-          }
-          response {
-            responseCode(HttpStatusCode.Created)
-            responseType<TestCreatedResponse>()
-            description(defaultResponseDescription)
-          }
-        }
-      }
-      patch {
-        call.respond(HttpStatusCode.Created, TestCreatedResponse(123, "nice!"))
-      }
-    }
-  }
-
-  fun Routing.primitives() {
-    route(rootPath) {
-      install(NotarizedRoute()) {
-        put = PutInfo.builder {
-          summary(defaultPathSummary)
-          description(defaultPathDescription)
-          request {
-            requestType<Int>()
-            description("A Test Request")
-          }
-          response {
-            responseCode(HttpStatusCode.Created)
-            responseType<Boolean>()
-            description(defaultResponseDescription)
-          }
-        }
-      }
-    }
-  }
-
-  fun Routing.returnsList() {
-    route(defaultPath) {
-      install(NotarizedRoute()) {
-        parameters = defaultParams
-        get = GetInfo.builder {
-          summary(defaultPathSummary)
-          description(defaultPathDescription)
-          response {
-            description("A Successful List-y Endeavor")
-            responseCode(HttpStatusCode.OK)
-            responseType<List<TestResponse>>()
-          }
-        }
-      }
-    }
-  }
-
-  fun Routing.nonRequiredParams() {
-    route("/optional") {
-      install(NotarizedRoute()) {
-        parameters = listOf(
-          Parameter(
-            name = "notRequired",
-            `in` = Parameter.Location.query,
-            schema = TypeDefinition.STRING,
-            required = false,
-          ),
-          Parameter(
-            name = "required",
-            `in` = Parameter.Location.query,
-            schema = TypeDefinition.STRING
-          )
-        )
-        get = GetInfo.builder {
-          summary(defaultPathSummary)
-          description(defaultPathDescription)
-          response {
-            responseType<Unit>()
-            description("Empty")
-            responseCode(HttpStatusCode.NoContent)
-          }
-        }
-      }
-    }
-  }
-
-  fun Routing.simplePathParsing() {
-    route("/this") {
-      route("/is") {
-        route("/a") {
-          route("/complex") {
-            route("path") {
-              route("with/an/{id}") {
-                install(NotarizedRoute()) {
-                  get = GetInfo.builder {
-                    parameters = listOf(
-                      Parameter(
-                        name = "id",
-                        `in` = Parameter.Location.path,
-                        schema = TypeDefinition.STRING
-                      )
-                    )
-                    summary(defaultPathSummary)
-                    description(defaultPathDescription)
-                    response {
-                      description(defaultResponseDescription)
-                      responseCode(HttpStatusCode.OK)
-                      responseType<TestResponse>()
-                    }
-                  }
-                }
-              }
-            }
-          }
-        }
-      }
-    }
-  }
-
-  fun Routing.rootRoute() {
-    route(rootPath) {
-      install(NotarizedRoute()) {
-        parameters = listOf(defaultParams.last())
-        get = GetInfo.builder {
-          summary(defaultPathSummary)
-          description(defaultPathDescription)
-          response {
-            description(defaultResponseDescription)
-            responseCode(HttpStatusCode.OK)
-            responseType<TestResponse>()
-          }
-        }
-      }
-    }
-  }
-
-  fun Routing.nestedUnderRoot() {
-    route("/") {
-      route("/testerino") {
-        install(NotarizedRoute()) {
-          get = GetInfo.builder {
-            summary(defaultPathSummary)
-            description(defaultPathDescription)
-            response {
-              description(defaultResponseDescription)
-              responseCode(HttpStatusCode.OK)
-              responseType<TestResponse>()
-            }
-          }
-        }
-      }
-    }
-  }
-
-  fun Routing.trailingSlash() {
-    route("/test") {
-      route("/") {
-        install(NotarizedRoute()) {
-          get = GetInfo.builder {
-            summary(defaultPathSummary)
-            description(defaultPathDescription)
-            response {
-              description(defaultResponseDescription)
-              responseCode(HttpStatusCode.OK)
-              responseType<TestResponse>()
-            }
-          }
-        }
-      }
-    }
-  }
-
-  fun Routing.singleException() {
-    route(rootPath) {
-      install(NotarizedRoute()) {
-        get = GetInfo.builder {
-          summary(defaultPathSummary)
-          description(defaultPathDescription)
-          response {
-            description(defaultResponseDescription)
-            responseCode(HttpStatusCode.OK)
-            responseType<TestResponse>()
-          }
-          canRespond {
-            description("Bad Things Happened")
-            responseCode(HttpStatusCode.BadRequest)
-            responseType<ExceptionResponse>()
-          }
-        }
-      }
-    }
-  }
-
-  fun Routing.multipleExceptions() {
-    route(rootPath) {
-      install(NotarizedRoute()) {
-        get = GetInfo.builder {
-          summary(defaultPathSummary)
-          description(defaultPathDescription)
-          response {
-            description(defaultResponseDescription)
-            responseCode(HttpStatusCode.OK)
-            responseType<TestResponse>()
-          }
-          canRespond {
-            description("Bad Things Happened")
-            responseCode(HttpStatusCode.BadRequest)
-            responseType<ExceptionResponse>()
-          }
-          canRespond {
-            description("Access Denied")
-            responseCode(HttpStatusCode.Forbidden)
-            responseType<ExceptionResponse>()
-          }
-        }
-      }
-    }
-  }
-
-  fun Routing.polymorphicException() {
-    route(rootPath) {
-      install(NotarizedRoute()) {
-        get = GetInfo.builder {
-          summary(defaultPathSummary)
-          description(defaultPathDescription)
-          response {
-            description(defaultResponseDescription)
-            responseCode(HttpStatusCode.OK)
-            responseType<TestResponse>()
-          }
-          canRespond {
-            description("Bad Things Happened")
-            responseCode(HttpStatusCode.InternalServerError)
-            responseType<FlibbityGibbit>()
-          }
-        }
-      }
-    }
-  }
-
-  fun Routing.genericException() {
-    route(rootPath) {
-      install(NotarizedRoute()) {
-        get = GetInfo.builder {
-          summary(defaultPathSummary)
-          description(defaultPathDescription)
-          response {
-            description(defaultResponseDescription)
-            responseCode(HttpStatusCode.OK)
-            responseType<TestResponse>()
-          }
-          canRespond {
-            description("Bad Things Happened")
-            responseCode(HttpStatusCode.BadRequest)
-            responseType<Flibbity<String>>()
-          }
-        }
-      }
-    }
-  }
-
-  fun Routing.reqRespExamples() {
-    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())
-            )
-          }
-          response {
-            description(defaultResponseDescription)
-            responseCode(HttpStatusCode.OK)
-            responseType<TestResponse>()
-            examples(
-              "Testerino" to TestResponse("Heya")
-            )
-          }
-        }
-      }
-    }
-  }
-
-  fun Routing.exampleParams() = basicGetGenerator<TestResponse>(
-    params = listOf(
-      Parameter(
-        name = "id",
-        `in` = Parameter.Location.path,
-        schema = TypeDefinition.STRING,
-        examples = mapOf(
-          "foo" to Parameter.Example("testing")
-        )
-      )
-    )
-  )
-
-  fun Routing.defaultParameter() = basicGetGenerator<TestResponse>(
-    params = listOf(
-      Parameter(
-        name = "id",
-        `in` = Parameter.Location.path,
-        schema = TypeDefinition.STRING.withDefault("IDK")
-      )
-    )
-  )
-
-  fun Routing.requiredParams() = basicGetGenerator<TestResponse>(
-    params = listOf(
-      Parameter(
-        name = "id",
-        `in` = Parameter.Location.path,
-        schema = TypeDefinition.STRING
-      )
-    )
-  )
-
-  fun Routing.nonRequiredParam() = basicGetGenerator<TestResponse>(
-    params = listOf(
-      Parameter(
-        name = "id",
-        `in` = Parameter.Location.query,
-        schema = TypeDefinition.STRING,
-        required = false
-      )
-    )
-  )
-
-  fun Routing.defaultField() = basicGetGenerator<DefaultField>()
-
-  fun Routing.nullableField() = basicGetGenerator<NullableField>()
-
-  fun Routing.polymorphicResponse() = basicGetGenerator<FlibbityGibbit>()
-
-  fun Routing.ignoredFieldsResponse() = basicGetGenerator<TransientObject>()
-
-  fun Routing.unbackedFieldsResponse() = basicGetGenerator<UnbackedObject>()
-
-  fun Routing.customFieldNameResponse() = basicGetGenerator<SerialNameObject>()
-
-  fun Routing.polymorphicCollectionResponse() = basicGetGenerator<List<FlibbityGibbit>>()
-
-  fun Routing.polymorphicMapResponse() = basicGetGenerator<Map<String, FlibbityGibbit>>()
-
-  fun Routing.simpleGenericResponse() = basicGetGenerator<Gibbity<String>>()
-
-  fun Routing.gnarlyGenericResponse() = basicGetGenerator<Foosy<Barzo<Int>, String>>()
-
-  fun Routing.nestedGenericResponse() = basicGetGenerator<Gibbity<Map<String, String>>>()
-
-  fun Routing.genericPolymorphicResponse() = basicGetGenerator<Flibbity<Double>>()
-
-  fun Routing.genericPolymorphicResponseMultipleImpls() = basicGetGenerator<Flibbity<FlibbityGibbit>>()
-
-  fun Routing.nestedGenericCollection() = basicGetGenerator<Page<Int>>()
-
-  fun Routing.nestedGenericMultipleParamsCollection() = basicGetGenerator<MultiNestedGenerics<String, ComplexRequest>>()
-
-  fun Routing.withOperationId() = basicGetGenerator<TestResponse>(operationId = "getThisDude")
-
-  fun Routing.nullableNestedObject() = basicGetGenerator<ProfileUpdateRequest>()
-
-  fun Routing.nullableEnumField() = basicGetGenerator<NullableEnum>()
-
-  fun Routing.nullableReference() = basicGetGenerator<ManyThings>()
-
-  fun Routing.dateTimeString() = basicGetGenerator<DateTimeString>()
-
-  fun Routing.headerParameter() = basicGetGenerator<TestResponse>(
-    params = listOf(
-      Parameter(
-        name = "X-User-Email",
-        `in` = Parameter.Location.header,
-        schema = TypeDefinition.STRING,
-        required = true
-      )
-    )
-  )
-
-  fun Routing.nestedTypeName() = basicGetGenerator<Nested.Response>()
-
-  fun Routing.topLevelNullable() = basicGetGenerator<TestResponse?>()
-
-  fun Routing.simpleRecursive() = basicGetGenerator<ColumnSchema>()
-
-  fun Routing.defaultAuthConfig() {
-    authenticate("basic") {
-      route(rootPath) {
-        basicGetGenerator<TestResponse>()
-      }
-    }
-  }
-
-  fun Routing.customAuthConfig() {
-    authenticate("auth-oauth-google") {
-      route(rootPath) {
-        install(NotarizedRoute()) {
-          get = GetInfo.builder {
-            summary(defaultPathSummary)
-            description(defaultPathDescription)
-            response {
-              description(defaultResponseDescription)
-              responseCode(HttpStatusCode.OK)
-              responseType<TestResponse>()
-            }
-            security = mapOf(
-              "auth-oauth-google" to listOf("read:pets")
-            )
-          }
-        }
-      }
-    }
-  }
-
-  fun Routing.multipleAuthStrategies() {
-    authenticate("jwt", "api-key") {
-      route(rootPath) {
-        basicGetGenerator<TestResponse>()
-      }
-    }
-  }
-
-  private inline fun <reified T> Routing.basicGetGenerator(
+internal inline fun <reified T> Routing.basicGetGenerator(
   params: List<Parameter> = emptyList(),
   operationId: String? = null
-  ) {
+) {
   route(rootPath) {
     basicGetGenerator<T>(params, operationId)
   }
-  }
+}
 
-  private inline fun <reified T> Route.basicGetGenerator(
+internal inline fun <reified T> Route.basicGetGenerator(
   params: List<Parameter> = emptyList(),
   operationId: String? = null
-  ) {
+) {
   install(NotarizedRoute()) {
     get = GetInfo.builder {
       summary(defaultPathSummary)
@@ -680,5 +63,4 @@ object TestModules {
       }
     }
   }
-  }
 }

core/src/test/resources/T0052__override_media_types.json

@@ -0,0 +1,123 @@
+{
+  "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": {
+    "/media_types": {
+      "put": {
+        "tags": [],
+        "summary": "Great Summary!",
+        "description": "testing more",
+        "parameters": [],
+        "requestBody": {
+          "description": "A cool request",
+          "content": {
+            "multipart/form-data": {
+              "schema": {
+                "$ref": "#/components/schemas/TestRequest"
+              }
+            },
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/TestRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "A good response",
+            "content": {
+              "application/xml": {
+                "schema": {
+                  "$ref": "#/components/schemas/TestResponse"
+                }
+              }
+            }
+          }
+        },
+        "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/test/resources/T0053__same_path_different_methods_and_auth.json

@@ -0,0 +1,164 @@
+{
+  "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",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TestResponse"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "put": {
+        "tags": [],
+        "summary": "Great Summary!",
+        "description": "testing more",
+        "parameters": [],
+        "requestBody": {
+          "description": "You gotta send it",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/TestSimpleRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "A Successful Endeavor",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TestCreatedResponse"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false,
+        "security": [
+          {
+            "basic": []
+          }
+        ]
+      },
+      "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"
+        ]
+      },
+      "TestCreatedResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          },
+          "id": {
+            "type": "number",
+            "format": "int32"
+          }
+        },
+        "required": [
+          "c",
+          "id"
+        ]
+      },
+      "TestSimpleRequest": {
+        "type": "object",
+        "properties": {
+          "a": {
+            "type": "string"
+          },
+          "b": {
+            "type": "number",
+            "format": "int32"
+          }
+        },
+        "required": [
+          "a",
+          "b"
+        ]
+      }
+    },
+    "securitySchemes": {
+      "basic": {
+        "type": "http",
+        "scheme": "basic"
+      }
+    }
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0054__app_with_rootpath.json

@@ -0,0 +1,92 @@
+{
+  "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/example",
+      "description": "Production instance of my API"
+    },
+    {
+      "url": "https://staging.myawesomeapi.com/example",
+      "description": "Where the fun stuff happens"
+    }
+  ],
+  "paths": {
+    "/test/{a}": {
+      "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": "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/T0055__enriched_simple_request.json

@@ -0,0 +1,126 @@
+{
+  "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": {
+      "post": {
+        "tags": [],
+        "summary": "Great Summary!",
+        "description": "testing more",
+        "parameters": [],
+        "requestBody": {
+          "description": "A test request",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/TestSimpleRequest-simple"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "A Successful Endeavor",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TestCreatedResponse"
+                }
+              }
+            }
+          }
+        },
+        "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": {
+      "TestCreatedResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          },
+          "id": {
+            "type": "number",
+            "format": "int32"
+          }
+        },
+        "required": [
+          "c",
+          "id"
+        ]
+      },
+      "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/T0056__enriched_nested_collection.json

@@ -0,0 +1,168 @@
+{
+  "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": {
+      "post": {
+        "tags": [],
+        "summary": "Great Summary!",
+        "description": "testing more",
+        "parameters": [],
+        "requestBody": {
+          "description": "A test request",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ComplexRequest-simple"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "A Successful Endeavor",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TestCreatedResponse"
+                }
+              }
+            }
+          }
+        },
+        "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": {
+      "TestCreatedResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          },
+          "id": {
+            "type": "number",
+            "format": "int32"
+          }
+        },
+        "required": [
+          "c",
+          "id"
+        ]
+      },
+      "ComplexRequest-simple": {
+        "type": "object",
+        "properties": {
+          "amazingField": {
+            "type": "string"
+          },
+          "org": {
+            "type": "string"
+          },
+          "tables": {
+            "items": {
+              "$ref": "#/components/schemas/NestedComplexItem-nested"
+            },
+            "description": "A nested item",
+            "type": "array"
+          }
+        },
+        "required": [
+          "amazingField",
+          "org",
+          "tables"
+        ]
+      },
+      "NestedComplexItem-nested": {
+        "type": "object",
+        "properties": {
+          "alias": {
+            "additionalProperties": {
+              "$ref": "#/components/schemas/CrazyItem"
+            },
+            "type": "object"
+          },
+          "name": {
+            "type": "string",
+            "description": "A nested description"
+          }
+        },
+        "required": [
+          "alias",
+          "name"
+        ]
+      },
+      "CrazyItem": {
+        "type": "object",
+        "properties": {
+          "enumeration": {
+            "$ref": "#/components/schemas/SimpleEnum"
+          }
+        },
+        "required": [
+          "enumeration"
+        ]
+      },
+      "SimpleEnum": {
+        "type": "string",
+        "enum": [
+          "ONE",
+          "TWO"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0057__enriched_complex_generic_type.json

@@ -0,0 +1,183 @@
+{
+  "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": {
+      "post": {
+        "tags": [],
+        "summary": "Great Summary!",
+        "description": "testing more",
+        "parameters": [],
+        "requestBody": {
+          "description": "A test request",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/MultiNestedGenerics-String-ComplexRequest-simple"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "A Successful Endeavor",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TestCreatedResponse"
+                }
+              }
+            }
+          }
+        },
+        "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": {
+      "TestCreatedResponse": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          },
+          "id": {
+            "type": "number",
+            "format": "int32"
+          }
+        },
+        "required": [
+          "c",
+          "id"
+        ]
+      },
+      "MultiNestedGenerics-String-ComplexRequest-simple": {
+        "type": "object",
+        "properties": {
+          "content": {
+            "additionalProperties": {
+              "$ref": "#/components/schemas/ComplexRequest-nested"
+            },
+            "description": "Getting pretty crazy",
+            "type": "object"
+          }
+        },
+        "required": [
+          "content"
+        ]
+      },
+      "ComplexRequest-nested": {
+        "type": "object",
+        "properties": {
+          "amazingField": {
+            "type": "string"
+          },
+          "org": {
+            "type": "string"
+          },
+          "tables": {
+            "items": {
+              "$ref": "#/components/schemas/NestedComplexItem-nested"
+            },
+            "description": "A nested item",
+            "type": "array"
+          }
+        },
+        "required": [
+          "amazingField",
+          "org",
+          "tables"
+        ]
+      },
+      "NestedComplexItem-nested": {
+        "type": "object",
+        "properties": {
+          "alias": {
+            "additionalProperties": {
+              "$ref": "#/components/schemas/CrazyItem"
+            },
+            "type": "object"
+          },
+          "name": {
+            "type": "string",
+            "description": "A nested description"
+          }
+        },
+        "required": [
+          "alias",
+          "name"
+        ]
+      },
+      "CrazyItem": {
+        "type": "object",
+        "properties": {
+          "enumeration": {
+            "$ref": "#/components/schemas/SimpleEnum"
+          }
+        },
+        "required": [
+          "enumeration"
+        ]
+      },
+      "SimpleEnum": {
+        "type": "string",
+        "enum": [
+          "ONE",
+          "TWO"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0058__enriched_simple_response.json

@@ -0,0 +1,73 @@
+{
+  "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": {
+    "/enriched": {
+      "get": {
+        "tags": [],
+        "summary": "Great Summary!",
+        "description": "testing more",
+        "parameters": [],
+        "responses": {
+          "201": {
+            "description": "A good response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TestResponse-simple"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "TestResponse-simple": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string",
+            "description": "A simple description"
+          }
+        },
+        "required": [
+          "c"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0059__int_constraints.json

@@ -0,0 +1,80 @@
+{
+  "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": "Get an int",
+        "description": "Get an int",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "An int",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TestCreatedResponse-example"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "TestCreatedResponse-example": {
+        "type": "object",
+        "properties": {
+          "c": {
+            "type": "string"
+          },
+          "id": {
+            "type": "number",
+            "format": "int32",
+            "multipleOf": 2,
+            "maximum": 100,
+            "minimum": 2
+          }
+        },
+        "required": [
+          "c",
+          "id"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0060__double_constraints.json

@@ -0,0 +1,76 @@
+{
+  "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": "Get a double",
+        "description": "Get a double",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "A double",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/DoubleResponse-example"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "DoubleResponse-example": {
+        "type": "object",
+        "properties": {
+          "payload": {
+            "type": "number",
+            "format": "double",
+            "multipleOf": 2.0,
+            "maximum": 100.0,
+            "minimum": 2.0
+          }
+        },
+        "required": [
+          "payload"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0061__string_min_max_constraints.json

@@ -0,0 +1,74 @@
+{
+  "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": "Get a string",
+        "description": "Get a string with constraints",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "A string",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TestNested-example"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "TestNested-example": {
+        "type": "object",
+        "properties": {
+          "nesty": {
+            "type": "string",
+            "maxLength": 10,
+            "minLength": 2
+          }
+        },
+        "required": [
+          "nesty"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0062__string_pattern_constraints.json

@@ -0,0 +1,73 @@
+{
+  "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": "Get a string",
+        "description": "This is a description",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "A string",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TestNested-example"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "TestNested-example": {
+        "type": "object",
+        "properties": {
+          "nesty": {
+            "type": "string",
+            "pattern": "[a-z]+"
+          }
+        },
+        "required": [
+          "nesty"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0063__string_content_encoding_constraints.json

@@ -0,0 +1,74 @@
+{
+  "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": "Get a string",
+        "description": "This is a description",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "A string",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/TestNested-example"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "TestNested-example": {
+        "type": "object",
+        "properties": {
+          "nesty": {
+            "type": "string",
+            "contentEncoding": "base64",
+            "contentMediaType": "image/png"
+          }
+        },
+        "required": [
+          "nesty"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

core/src/test/resources/T0064__array_constraints.json

@@ -0,0 +1,103 @@
+{
+  "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": "Get an array",
+        "description": "Get an array of strings",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "An array",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Page-String-example"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "parameters": []
+    }
+  },
+  "webhooks": {},
+  "components": {
+    "schemas": {
+      "Page-String-example": {
+        "type": "object",
+        "properties": {
+          "content": {
+            "items": {
+              "type": "string"
+            },
+            "maxItems": 10,
+            "minItems": 2,
+            "uniqueItems": true,
+            "type": "array"
+          },
+          "number": {
+            "type": "number",
+            "format": "int32"
+          },
+          "numberOfElements": {
+            "type": "number",
+            "format": "int32"
+          },
+          "size": {
+            "type": "number",
+            "format": "int32"
+          },
+          "totalElements": {
+            "type": "number",
+            "format": "int64"
+          },
+          "totalPages": {
+            "type": "number",
+            "format": "int32"
+          }
+        },
+        "required": [
+          "content",
+          "number",
+          "numberOfElements",
+          "size",
+          "totalElements",
+          "totalPages"
+        ]
+      }
+    },
+    "securitySchemes": {}
+  },
+  "security": [],
+  "tags": []
+}

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/testFixtures/kotlin/io/bkbn/kompendium/core/fixtures/TestHelpers.kt

@@ -5,6 +5,7 @@ import com.fasterxml.jackson.databind.SerializationFeature
 import io.bkbn.kompendium.core.fixtures.TestSpecs.defaultSpec
 import io.bkbn.kompendium.core.plugin.NotarizedApplication
 import io.bkbn.kompendium.core.routes.redoc
+import io.bkbn.kompendium.core.routes.swagger
 import io.bkbn.kompendium.json.schema.KotlinXSchemaConfigurator
 import io.bkbn.kompendium.json.schema.definition.JsonSchema
 import io.bkbn.kompendium.oas.OpenApiSpec
@@ -21,13 +22,14 @@ import io.ktor.serialization.gson.gson
 import io.ktor.serialization.jackson.jackson
 import io.ktor.serialization.kotlinx.json.json
 import io.ktor.server.application.Application
+import io.ktor.server.engine.ApplicationEngineEnvironmentBuilder
 import io.ktor.server.plugins.contentnegotiation.ContentNegotiation
 import io.ktor.server.routing.Routing
 import io.ktor.server.testing.ApplicationTestBuilder
 import io.ktor.server.testing.testApplication
-import kotlin.reflect.KType
-import kotlinx.serialization.json.Json
 import java.io.File
+import kotlinx.serialization.json.Json
+import kotlin.reflect.KType
 
 object TestHelpers {
   private const val OPEN_API_ENDPOINT = "/openapi.json"
@@ -43,8 +45,8 @@ object TestHelpers {
    * exists as expected, and that the content matches the expected blob found in the specified file
    * @param snapshotName The snapshot file to retrieve from the resources folder
    */
-  private suspend fun ApplicationTestBuilder.compareOpenAPISpec(snapshotName: String) {
-    val response = client.get(OPEN_API_ENDPOINT)
+  private suspend fun ApplicationTestBuilder.compareOpenAPISpec(rootPath: String, snapshotName: String) {
+    val response = client.get("$rootPath$OPEN_API_ENDPOINT")
     response shouldHaveStatus HttpStatusCode.OK
     response.bodyAsText() shouldNot beBlank()
     response.bodyAsText() shouldEqualJson getFileSnapshot(snapshotName)
@@ -61,11 +63,36 @@ object TestHelpers {
     customTypes: Map<KType, JsonSchema> = emptyMap(),
     applicationSetup: Application.() -> Unit = { },
     specOverrides: OpenApiSpec.() -> OpenApiSpec = { this },
+    applicationEnvironmentBuilder: ApplicationEngineEnvironmentBuilder.() -> Unit = {},
     routeUnderTest: Routing.() -> Unit
   ) {
-    openApiTest(snapshotName, SupportedSerializer.KOTLINX, routeUnderTest, applicationSetup, specOverrides, customTypes)
-    openApiTest(snapshotName, SupportedSerializer.JACKSON, routeUnderTest, applicationSetup, specOverrides, customTypes)
-    openApiTest(snapshotName, SupportedSerializer.GSON, routeUnderTest, applicationSetup, specOverrides, customTypes)
+    openApiTest(
+      snapshotName,
+      SupportedSerializer.KOTLINX,
+      routeUnderTest,
+      applicationSetup,
+      specOverrides,
+      customTypes,
+      applicationEnvironmentBuilder
+    )
+    openApiTest(
+      snapshotName,
+      SupportedSerializer.JACKSON,
+      routeUnderTest,
+      applicationSetup,
+      specOverrides,
+      customTypes,
+      applicationEnvironmentBuilder
+    )
+    openApiTest(
+      snapshotName,
+      SupportedSerializer.GSON,
+      routeUnderTest,
+      applicationSetup,
+      specOverrides,
+      customTypes,
+      applicationEnvironmentBuilder
+    )
   }
 
   private fun openApiTest(
@@ -74,8 +101,10 @@ object TestHelpers {
     routeUnderTest: Routing.() -> Unit,
     applicationSetup: Application.() -> Unit,
     specOverrides: OpenApiSpec.() -> OpenApiSpec,
-    typeOverrides: Map<KType, JsonSchema> = emptyMap()
+    typeOverrides: Map<KType, JsonSchema> = emptyMap(),
+    applicationBuilder: ApplicationEngineEnvironmentBuilder.() -> Unit = {}
   ) = testApplication {
+    environment(applicationBuilder)
     install(NotarizedApplication()) {
       customTypes = typeOverrides
       spec = defaultSpec().specOverrides()
@@ -102,9 +131,11 @@ object TestHelpers {
     }
     application(applicationSetup)
     routing {
+      swagger()
       redoc()
       routeUnderTest()
     }
-    compareOpenAPISpec(snapshotName)
+    val root = ApplicationEngineEnvironmentBuilder().apply(applicationBuilder).rootPath
+    compareOpenAPISpec(root, snapshotName)
   }
 }

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

@@ -12,6 +12,9 @@ import java.time.Instant
 @Serializable
 data class TestNested(val nesty: String)
 
+@Serializable
+data class DoubleResponse(val payload: Double)
+
 @Serializable
 data class TestRequest(
   val fieldName: TestNested,

docs/SUMMARY.md

@@ -1,6 +1,10 @@
 # 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)

docs/concepts/enrichment.md

@@ -0,0 +1,106 @@
+Kompendium allows users to enrich their data types with additional information. This can be done by defining a
+`TypeEnrichment` object and passing it to the `enrichment` parameter of the relevant `requestType` or `responseType`.
+
+```kotlin
+data class SimpleData(val a: String, val b: Int? = null)
+
+val myEnrichment = TypeEnrichment<SimpleData>(id = "simple-enrichment") {
+  SimpleData::a {
+    description = "This will update the field description"
+  }
+  SimpleData::b {
+    // Will indicate in the UI that the field will be removed soon
+    deprecated = true
+  }
+}
+
+// In your route documentation
+fun Routing.enrichedSimpleRequest() {
+  route("/example") {
+    install(NotarizedRoute()) {
+      parameters = TestModules.defaultParams
+      post = PostInfo.builder {
+        summary(TestModules.defaultPathSummary)
+        description(TestModules.defaultPathDescription)
+        request {
+          requestType<SimpleData>(enrichment = myEnrichment) // Simply attach the enrichment to the request
+          description("A test request")
+        }
+        response {
+          responseCode(HttpStatusCode.Created)
+          responseType<TestCreatedResponse>()
+          description(TestModules.defaultResponseDescription)
+        }
+      }
+    }
+  }
+}
+```
+
+{% hint style="warning" %}
+An enrichment must provide an `id` field that is unique to the data class that is being enriched. This is because
+under the hood, Kompendium appends this id to the data class identifier in order to support multiple different
+enrichments
+on the same data class.
+
+If you provide duplicate ids, all but the first enrichment will be ignored, as Kompendium will view that as a cache hit,
+and skip analyzing the new enrichment.
+{% endhint %}
+
+### Nested Enrichments
+
+Enrichments are portable and composable, meaning that we can take an enrichment for a child data class
+and apply it inside a parent data class using the `typeEnrichment` property.
+
+```kotlin
+data class ParentData(val a: String, val b: ChildData)
+data class ChildData(val c: String, val d: Int? = null)
+
+val childEnrichment = TypeEnrichment<ChildData>(id = "child-enrichment") {
+  ChildData::c {
+    description = "This will update the field description of field c on child data"
+  }
+  ChildData::d {
+    description = "This will update the field description of field d on child data"
+  }
+}
+
+val parentEnrichment = TypeEnrichment<ParentData>(id = "parent-enrichment") {
+  ParentData::a {
+    description = "This will update the field description"
+  }
+  ParentData::b {
+    description = "This will update the field description of field b on parent data"
+    typeEnrichment = childEnrichment // Will apply the child enrichment to the internals of field b
+  }
+}
+```
+
+## Available Enrichments
+
+All enrichments support the following properties:
+
+- description -> Provides a reader friendly description of the field in the object
+- deprecated -> Indicates that the field is deprecated and should not be used
+
+### String
+
+- minLength -> The minimum length of the string
+- maxLength -> The maximum length of the string
+- pattern -> A regex pattern that the string must match
+- contentEncoding -> The encoding of the string
+- contentMediaType -> The media type of the string
+
+### Numbers
+
+- minimum -> The minimum value of the number
+- maximum -> The maximum value of the number
+- exclusiveMinimum -> Indicates that the minimum value is exclusive
+- exclusiveMaximum -> Indicates that the maximum value is exclusive
+- multipleOf -> Indicates that the number must be a multiple of the provided value
+
+### Arrays
+
+- minItems -> The minimum number of items in the array
+- maxItems -> The maximum number of items in the array
+- uniqueItems -> Indicates that the array must contain unique items

docs/concepts/index.md

@@ -0,0 +1,2 @@
+Various concepts that are core to Kompendium but not necessarily exclusive 
+to any given module or plugin

docs/helpers/index.md

@@ -0,0 +1,7 @@
+Helper modules help you to interact with Kompendium.
+
+Some functionality is not possible or difficult to do with Kompendium by default. Modules in this folder help you to get
+functionality that would otherwise be difficult.
+
+The first one of which is [Protobuf java converter](protobuf_java_converter.md) which translates java protobuf classes 
+to `customTypes` entries.

docs/helpers/protobuf_java_converter.md

@@ -0,0 +1,153 @@
+The `Protobuf java converter` functions allow you to generate documentation from your generated Java classes.
+Since Kompendium relies a lot on `KProperties` we have yet to find a way to connect this with our Java.
+For now the documentation is generated for the `customTypes` in `NotarizedApplication`.
+
+## Usage with Kotlinx
+
+setup:
+```kotlin
+ install(ContentNegotiation) {
+  json(Json {
+    encodeDefaults = false
+    // Combine the kompendium serializers with your custom java proto serializers 
+    serializersModule =
+      KompendiumSerializersModule.module + SerializersModule { serializersModule = yourCustomProtoSerializers }
+  })
+}
+```
+
+For one message and all its nested sub messages:
+```kotlin
+private fun Application.mainModule() {
+  // ...
+  install(NotarizedApplication()) {
+    spec = baseSpec
+    customTypes = MyJavaProto.getDefaultInstance().createCustomTypesForTypeAndSubTypes().toMap()
+  }
+}
+```
+
+For multiple messages and their submesages:
+```kotlin
+private fun Application.mainModule() {
+  // ...
+  install(NotarizedApplication()) {
+    spec = baseSpec
+    customTypes = MyJavaProto.getDefaultInstance().createCustomTypesForTypeAndSubTypes()
+      .plus(AnotherJavaProto.getDefaultInstance().createCustomTypesForTypeAndSubTypes()).toMap()
+  }
+}
+```
+
+### Example User
+
+The protobuf that is used on our endpoint
+```proto
+message User {
+  string id = 1;
+  string email = 2;
+  string mobile_phone = 3;
+  string name = 4;
+}
+```
+
+A custom serializer deserializer:
+```kotlin
+@OptIn(ExperimentalSerializationApi::class)
+object UserSerializer : KSerializer<User> {
+
+  override val descriptor: SerialDescriptor = buildClassSerialDescriptor("User") {
+    element("id", serialDescriptor<String>())
+    element("email", serialDescriptor<String>())
+    element("mobile_phone", serialDescriptor<String>())
+    element("name", serialDescriptor<String>())
+  }
+
+  override fun deserialize(decoder: Decoder): User {
+    return decoder.decodeStructure(descriptor) {
+      var id: String? = null
+      var email: String? = null
+      var mobilePhone: String? = null
+      var name: String? = null
+
+      loop@ while (true) {
+        when (val index = decodeElementIndex(descriptor)) {
+          CompositeDecoder.DECODE_DONE -> break@loop
+          0 -> id = decodeStringElement(descriptor, index)
+          1 -> email = decodeStringElement(descriptor, index)
+          2 -> mobilePhone = decodeStringElement(descriptor, index)
+          3 -> name = decodeStringElement(descriptor, index)
+          else -> throw   RuntimeException(
+            "Unexpected index field ${descriptor.getElementName(index)}"
+          )
+        }
+      }
+      // building the protobuf object
+      val user = User.newBuilder().apply {
+        id?.let { v -> this.id = v }
+        email?.let { v -> this.email = v }
+        mobilePhone?.let { v -> this.mobilePhone = v }
+        name?.let { v -> this.name = v }
+      }.build()
+      user
+    }
+  }
+
+  override fun serialize(encoder: Encoder, value: User) {
+    encoder.encodeStructure(descriptor) {
+      encodeStringElement(descriptor, 0, value.id)
+      encodeStringElement(descriptor, 1, value.email)
+      encodeStringElement(descriptor, 2, value.mobilePhone)
+      encodeStringElement(descriptor, 3, value.name)
+    }
+  }
+}
+```
+Setting the content type:
+```kotlin
+install(ContentNegotiation) {
+  json(Json {
+    encodeDefaults = false
+    // Combine the kompendium serializers with your custom java proto serializers 
+    serializersModule =
+      KompendiumSerializersModule.module + SerializersModule { 
+        serializersModule = SerializersModule {
+          contextual(UserSerializer)
+        }
+      }
+  })
+}
+```
+The installation of the noterized application:
+```kotlin
+install(NotarizedApplication()) {
+  spec = baseSpec
+  customTypes = User.getDefaultInstance().createCustomTypesForTypeAndSubTypes().toMap()
+}
+```
+Route configuration as you normally would with one exception which is `createType()` to create kotlin type from a javaClass.
+
+```kotlin
+private fun Route.userDocumentation() {
+  install(NotarizedRoute()) {
+    post = PostInfo.builder {
+      summary("My User API")
+      description("Create a user")
+      request {
+        requestType(User::class.createType())
+        description("My user creation object")
+      }
+      response {
+        responseCode(HttpStatusCode.OK)
+        responseType(CreateUserResponse::class.createType())
+        description("Returns simulation object")
+      }
+      canRespond {
+        responseCode(HttpStatusCode.NotFound)
+        responseType<String>()
+        description("Indicates that the user could not be found")
+      }
+    }
+  }
+}
+```

docs/plugins/notarized_resources.md

@@ -4,6 +4,12 @@ You can read more about it [here](https://ktor.io/docs/type-safe-routing.html).
 
 Kompendium supports Ktor-Resources through an ancillary module `kompendium-resources`
 
+{% hint style="warning" %}
+The resources module contains _two_ plugins: `KompendiumResources` and `KompendiumResource`. You will find more
+information on both below, but in a nutshell, the former is an application level plugin intended to define your entire
+application, while the latter is a route level approach should you wish to split out your route definitions.
+{% endhint %}
+
 ## Adding the Artifact
 
 Prior to documenting your resources, you will need to add the artifact to your gradle build file.
@@ -14,9 +20,11 @@ dependencies {
 }
 ```
 
-## Installing Plugin
+## NotarizedResources
 
-Once you have installed the dependency, you can install the plugin. The `NotarizedResources` plugin is an _application_ level plugin, and **must** be install after both the `NotarizedApplication` plugin and the Ktor `Resources` plugin.
+The `NotarizedResources` plugin is an _application_ level plugin, and **must** be installed after both the
+`NotarizedApplication` plugin and the Ktor `Resources` plugin. It is intended to be used to document your entire
+application in a single block.
 
 ```kotlin
 private fun Application.mainModule() {
@@ -54,7 +62,64 @@ private fun Application.mainModule() {
 }
 ```
 
-Here, the `resources` property is a map of `KClass<*>` to `ResourceMetadata` instance describing that resource. This metadata is functionally identical to how a standard `NotarizedRoute` is defined.
+Here, the `resources` property is a map of `KClass<*>` to `ResourceMetadata` instance describing that resource. This
+metadata is functionally identical to how a standard `NotarizedRoute` is defined.
 
-> ⚠️ If you try to map a class that is not annotated with the ktor `@Resource` annotation, you will get a runtime
-> exception!
+{% hint style="danger" %}
+If you try to map a class that is not annotated with the ktor `@Resource` annotation, you will get a runtime exception!
+{% endhint %}
+
+## NotarizedResource
+
+If you prefer a route-based approach similar to `NotarizedRoute`, you can use the `NotarizedResource<MyResourceType>()`
+plugin instead of `NotarizedResources`. It will combine paths from any parent route with the route defined in the
+resource, exactly as Ktor itself does:
+
+```kotlin
+@Serializable
+@Resource("/list/{name}/page/{page}")
+data class Listing(val name: String, val page: Int)
+
+private fun Application.mainModule() {
+  install(Resources)
+  route("/api") {
+    listingDocumentation()
+    get<Listing> { listing ->
+      call.respondText("Listing ${listing.name}, page ${listing.page}")
+    }
+  }
+}
+
+private fun Route.listingDocumentation() {
+  install(NotarizedResource<Listing>()) {
+    parameters = listOf(
+      Parameter(
+        name = "name",
+        `in` = Parameter.Location.path,
+        schema = TypeDefinition.STRING
+      ),
+      Parameter(
+        name = "page",
+        `in` = Parameter.Location.path,
+        schema = TypeDefinition.INT
+      )
+    )
+    get = GetInfo.builder {
+      summary("Get user by id")
+      description("A very neat endpoint!")
+      response {
+        responseCode(HttpStatusCode.OK)
+        responseType<ExampleResponse>()
+        description("Will return whether or not the user is real 😱")
+      }
+    }
+  }
+}
+```
+
+In this case, the generated path will be `/api/list/{name}/page/{page}`, combining the route prefix with the path in the
+resource.
+
+{% hint style="danger" %}
+If you try to map a class that is not annotated with the ktor `@Resource` annotation, you will get a runtime exception!
+{% endhint %}

docs/plugins/notarized_route.md

@@ -165,3 +165,42 @@ get = GetInfo.builder {
   }
 }
 ```
+
+## Media Types
+
+By default, Kompendium will set the only media type to "application/json". If you would like to override the media type
+for a specific request or response (including errors), you can do so with the `mediaTypes` method
+
+```kotlin
+get = GetInfo.builder {
+  summary("Get user by id")
+  description("A very neat endpoint!")
+  response {
+    mediaTypes("application/xml")
+    responseCode(HttpStatusCode.OK)
+    responseType<ExampleResponse>()
+    description("Will return whether or not the user is real 😱")
+  }
+}
+```
+
+## Partial Authentication
+
+One might want to have a public GET endpoint but a protected PUT endpoint. This can be achieved by registering two
+separate notarized routes. Note that you will get an error if you try to register the same method twice, as each path
+can only have one registration per method. Example:
+
+```kotlin
+route("/user/{id}") {
+  get = GetInfo.builder {
+    // ...
+  }
+  // ...
+  authenticate {
+    put = PutInfo.builder {
+      // ...
+    }
+    // ...
+  }
+}
+```

enrichment/build.gradle.kts

@@ -0,0 +1,34 @@
+plugins {
+  kotlin("jvm")
+  id("io.bkbn.sourdough.library.jvm")
+  id("io.gitlab.arturbosch.detekt")
+  id("com.adarshr.test-logger")
+  id("maven-publish")
+  id("java-library")
+  id("signing")
+  id("org.jetbrains.kotlinx.kover")
+}
+
+sourdoughLibrary {
+  libraryName.set("Kompendium Type Enrichment")
+  libraryDescription.set("Utility library for creating portable type enrichments")
+  compilerArgs.set(listOf("-opt-in=kotlin.RequiresOptIn"))
+}
+
+dependencies {
+  // Versions
+  val detektVersion: String by project
+
+  // Formatting
+  detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:$detektVersion")
+
+  testImplementation(testFixtures(projects.kompendiumCore))
+}
+
+testing {
+  suites {
+    named("test", JvmTestSuite::class) {
+      useJUnitJupiter()
+    }
+  }
+}

enrichment/src/main/kotlin/io/bkbn/kompendium/enrichment/Enrichment.kt

@@ -0,0 +1,3 @@
+package io.bkbn.kompendium.enrichment
+
+sealed interface Enrichment

enrichment/src/main/kotlin/io/bkbn/kompendium/enrichment/PropertyEnrichment.kt

@@ -0,0 +1,36 @@
+package io.bkbn.kompendium.enrichment
+
+/**
+ * Reference https://json-schema.org/draft/2020-12/json-schema-validation.html#name-multipleof
+ */
+class PropertyEnrichment : Enrichment {
+  // Metadata
+  var deprecated: Boolean? = null
+  var description: String? = null
+  var typeEnrichment: TypeEnrichment<*>? = null
+
+  // Number and Integer Constraints
+  var multipleOf: Number? = null
+  var maximum: Number? = null
+  var exclusiveMaximum: Number? = null
+  var minimum: Number? = null
+  var exclusiveMinimum: Number? = null
+
+  // String constraints
+  var maxLength: Int? = null
+  var minLength: Int? = null
+  var pattern: String? = null
+  var contentEncoding: String? = null
+  var contentMediaType: String? = null
+  // TODO how to handle contentSchema?
+
+  // Array constraints
+  var maxItems: Int? = null
+  var minItems: Int? = null
+  var uniqueItems: Boolean? = null
+  // TODO How to handle contains, minContains, maxContains?
+
+  // Object constraints
+  var maxProperties: Int? = null
+  var minProperties: Int? = null
+}

enrichment/src/main/kotlin/io/bkbn/kompendium/enrichment/TypeEnrichment.kt

@@ -0,0 +1,25 @@
+package io.bkbn.kompendium.enrichment
+
+import kotlin.reflect.KProperty
+import kotlin.reflect.KProperty1
+
+class TypeEnrichment<T>(val id: String) : Enrichment {
+
+  private val enrichments: MutableMap<KProperty1<*, *>, Enrichment> = mutableMapOf()
+
+  fun getEnrichmentForProperty(property: KProperty<*>): Enrichment? = enrichments[property]
+
+  operator fun <R> KProperty1<T, R>.invoke(init: PropertyEnrichment.() -> Unit) {
+    require(!enrichments.containsKey(this)) { "${this.name} has already been registered" }
+    val propertyEnrichment = PropertyEnrichment()
+    init.invoke(propertyEnrichment)
+    enrichments[this] = propertyEnrichment
+  }
+
+  companion object {
+    inline operator fun <reified T> invoke(id: String, init: TypeEnrichment<T>.() -> Unit): TypeEnrichment<T> {
+      val builder = TypeEnrichment<T>(id)
+      return builder.apply(init)
+    }
+  }
+}

gradle.properties

@@ -1,13 +1,14 @@
 # Kompendium
-project.version=3.6.0
+project.version=3.13.0
 # Kotlin
 kotlin.code.style=official
 # Gradle
 org.gradle.vfs.watch=true
 org.gradle.vfs.verbose=true
 org.gradle.jvmargs=-Xmx2000m
+org.gradle.parallel=true
 
 # Dependencies
-ktorVersion=2.1.3
-kotestVersion=5.5.4
+ktorVersion=2.2.3
+kotestVersion=5.5.5
 detektVersion=1.21.0

gradle/wrapper/gradle-wrapper.properties

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

gradlew

@@ -205,6 +205,12 @@ set -- \
         org.gradle.wrapper.GradleWrapperMain \
         "$@"
 
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+    die "xargs is not available"
+fi
+
 # Use "xargs" to parse quoted args.
 #
 # With -n1 it outputs one arg per line, with the quotes and backslashes removed.

gradlew.bat

@@ -14,7 +14,7 @@
 @rem limitations under the License.
 @rem
 
-@if "%DEBUG%" == "" @echo off
+@if "%DEBUG%"=="" @echo off
 @rem ##########################################################################
 @rem
 @rem  Gradle startup script for Windows
@@ -25,7 +25,7 @@
 if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
-if "%DIRNAME%" == "" set DIRNAME=.
+if "%DIRNAME%"=="" set DIRNAME=.
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
@@ -40,7 +40,7 @@ if defined JAVA_HOME goto findJavaFromJavaHome
 
 set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto execute
+if %ERRORLEVEL% equ 0 goto execute
 
 echo.
 echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
@@ -75,13 +75,15 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
 :end
 @rem End local scope for the variables with windows NT shell
-if "%ERRORLEVEL%"=="0" goto mainEnd
+if %ERRORLEVEL% equ 0 goto mainEnd
 
 :fail
 rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
 rem the _cmd.exe /c_ return code!
-if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
-exit /b 1
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
 
 :mainEnd
 if "%OS%"=="Windows_NT" endlocal

json-schema/build.gradle.kts

@@ -20,7 +20,10 @@ dependencies {
   // Versions
   val detektVersion: String by project
 
-  implementation("org.jetbrains.kotlin:kotlin-reflect:1.7.20")
+  // Kompendium
+  api(projects.kompendiumEnrichment)
+
+  implementation("org.jetbrains.kotlin:kotlin-reflect:1.8.10")
   implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1")
 
   // Formatting

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

@@ -1,5 +1,6 @@
 package io.bkbn.kompendium.json.schema
 
+import io.bkbn.kompendium.enrichment.TypeEnrichment
 import io.bkbn.kompendium.json.schema.definition.JsonSchema
 import io.bkbn.kompendium.json.schema.definition.NullableDefinition
 import io.bkbn.kompendium.json.schema.definition.OneOfDefinition
@@ -9,28 +10,26 @@ import io.bkbn.kompendium.json.schema.handler.EnumHandler
 import io.bkbn.kompendium.json.schema.handler.MapHandler
 import io.bkbn.kompendium.json.schema.handler.SealedObjectHandler
 import io.bkbn.kompendium.json.schema.handler.SimpleObjectHandler
-import io.bkbn.kompendium.json.schema.util.Helpers.getSimpleSlug
+import io.bkbn.kompendium.json.schema.util.Helpers.getSlug
+import java.util.UUID
 import kotlin.reflect.KClass
 import kotlin.reflect.KType
 import kotlin.reflect.full.isSubclassOf
-import kotlin.reflect.typeOf
-import java.util.UUID
 
 object SchemaGenerator {
 
-  inline fun <reified T : Any?> fromTypeToSchema(
-    cache: MutableMap<String, JsonSchema> = mutableMapOf(),
-    schemaConfigurator: SchemaConfigurator = SchemaConfigurator.Default()
-  ) = fromTypeToSchema(typeOf<T>(), cache, schemaConfigurator)
-
   fun fromTypeToSchema(
     type: KType,
     cache: MutableMap<String, JsonSchema>,
-    schemaConfigurator: SchemaConfigurator
+    schemaConfigurator: SchemaConfigurator,
+    enrichment: TypeEnrichment<*>? = null
   ): JsonSchema {
-    cache[type.getSimpleSlug()]?.let {
+    val slug = type.getSlug(enrichment)
+
+    cache[slug]?.let {
       return it
     }
+
     return when (val clazz = type.classifier as KClass<*>) {
       Unit::class -> error(
         """
@@ -48,14 +47,14 @@ object SchemaGenerator {
       Boolean::class -> checkForNull(type, TypeDefinition.BOOLEAN)
       UUID::class -> checkForNull(type, TypeDefinition.UUID)
       else -> when {
-        clazz.isSubclassOf(Enum::class) -> EnumHandler.handle(type, clazz, cache)
-        clazz.isSubclassOf(Collection::class) -> CollectionHandler.handle(type, cache, schemaConfigurator)
-        clazz.isSubclassOf(Map::class) -> MapHandler.handle(type, cache, schemaConfigurator)
+        clazz.isSubclassOf(Enum::class) -> EnumHandler.handle(type, clazz, cache, enrichment)
+        clazz.isSubclassOf(Collection::class) -> CollectionHandler.handle(type, cache, schemaConfigurator, enrichment)
+        clazz.isSubclassOf(Map::class) -> MapHandler.handle(type, cache, schemaConfigurator, enrichment)
         else -> {
           if (clazz.isSealed) {
-            SealedObjectHandler.handle(type, clazz, cache, schemaConfigurator)
+            SealedObjectHandler.handle(type, clazz, cache, schemaConfigurator, enrichment)
           } else {
-            SimpleObjectHandler.handle(type, clazz, cache, schemaConfigurator)
+            SimpleObjectHandler.handle(type, clazz, cache, schemaConfigurator, enrichment)
           }
         }
       }
@@ -65,11 +64,12 @@ object SchemaGenerator {
   fun fromTypeOrUnit(
     type: KType,
     cache: MutableMap<String, JsonSchema> = mutableMapOf(),
-    schemaConfigurator: SchemaConfigurator
+    schemaConfigurator: SchemaConfigurator,
+    enrichment: TypeEnrichment<*>? = null
   ): JsonSchema? =
     when (type.classifier as KClass<*>) {
       Unit::class -> null
-      else -> fromTypeToSchema(type, cache, schemaConfigurator)
+      else -> fromTypeToSchema(type, cache, schemaConfigurator, enrichment)
     }
 
   private fun checkForNull(type: KType, schema: JsonSchema): JsonSchema = when (type.isMarkedNullable) {

json-schema/src/main/kotlin/io/bkbn/kompendium/json/schema/definition/AnyOfDefinition.kt

@@ -3,4 +3,8 @@ package io.bkbn.kompendium.json.schema.definition
 import kotlinx.serialization.Serializable
 
 @Serializable
-data class AnyOfDefinition(val anyOf: Set<JsonSchema>) : JsonSchema
+data class AnyOfDefinition(
+  val anyOf: Set<JsonSchema>,
+  override val deprecated: Boolean? = null,
+  override val description: String? = null,
+) : JsonSchema

json-schema/src/main/kotlin/io/bkbn/kompendium/json/schema/definition/ArrayDefinition.kt

@@ -4,7 +4,14 @@ import kotlinx.serialization.Serializable
 
 @Serializable
 data class ArrayDefinition(
-  val items: JsonSchema
+  val items: JsonSchema,
+  override val deprecated: Boolean? = null,
+  override val description: String? = null,
+
+  // Constraints
+  val maxItems: Int? = null,
+  val minItems: Int? = null,
+  val uniqueItems: Boolean? = null,
 ) : JsonSchema {
   val type: String = "array"
 }

json-schema/src/main/kotlin/io/bkbn/kompendium/json/schema/definition/EnumDefinition.kt

@@ -5,5 +5,7 @@ import kotlinx.serialization.Serializable
 @Serializable
 data class EnumDefinition(
   val type: String,
-  val enum: Set<String>
+  val enum: Set<String>,
+  override val deprecated: Boolean? = null,
+  override val description: String? = null,
 ) : JsonSchema

json-schema/src/main/kotlin/io/bkbn/kompendium/json/schema/definition/JsonSchema.kt

@@ -11,6 +11,9 @@ import kotlinx.serialization.encoding.Encoder
 @Serializable(with = JsonSchema.Serializer::class)
 sealed interface JsonSchema {
 
+  val description: String?
+  val deprecated: Boolean?
+
   object Serializer : KSerializer<JsonSchema> {
     override val descriptor: SerialDescriptor = PrimitiveSerialDescriptor("JsonSchema", PrimitiveKind.STRING)
     override fun deserialize(decoder: Decoder): JsonSchema {

json-schema/src/main/kotlin/io/bkbn/kompendium/json/schema/definition/MapDefinition.kt

@@ -4,7 +4,9 @@ import kotlinx.serialization.Serializable
 
 @Serializable
 data class MapDefinition(
-  val additionalProperties: JsonSchema
+  val additionalProperties: JsonSchema,
+  override val deprecated: Boolean? = null,
+  override val description: String? = null,
 ) : JsonSchema {
   val type: String = "object"
 }

json-schema/src/main/kotlin/io/bkbn/kompendium/json/schema/definition/NullableDefinition.kt

@@ -3,4 +3,8 @@ package io.bkbn.kompendium.json.schema.definition
 import kotlinx.serialization.Serializable
 
 @Serializable
-data class NullableDefinition(val type: String = "null") : JsonSchema
+data class NullableDefinition(
+  val type: String = "null",
+  override val deprecated: Boolean? = null,
+  override val description: String? = null,
+) : JsonSchema

json-schema/src/main/kotlin/io/bkbn/kompendium/json/schema/definition/OneOfDefinition.kt

@@ -3,6 +3,10 @@ package io.bkbn.kompendium.json.schema.definition
 import kotlinx.serialization.Serializable
 
 @Serializable
-data class OneOfDefinition(val oneOf: Set<JsonSchema>) : JsonSchema {
+data class OneOfDefinition(
+  val oneOf: Set<JsonSchema>,
+  override val deprecated: Boolean? = null,
+  override val description: String? = null,
+) : JsonSchema {
   constructor(vararg types: JsonSchema) : this(types.toSet())
 }

json-schema/src/main/kotlin/io/bkbn/kompendium/json/schema/definition/ReferenceDefinition.kt

@@ -3,4 +3,8 @@ package io.bkbn.kompendium.json.schema.definition
 import kotlinx.serialization.Serializable
 
 @Serializable
-data class ReferenceDefinition(val `$ref`: String) : JsonSchema
+data class ReferenceDefinition(
+  val `$ref`: String,
+  override val deprecated: Boolean? = null,
+  override val description: String? = null,
+) : JsonSchema

json-schema/src/main/kotlin/io/bkbn/kompendium/json/schema/definition/TypeDefinition.kt

@@ -1,5 +1,6 @@
 package io.bkbn.kompendium.json.schema.definition
 
+import io.bkbn.kompendium.json.schema.util.Serializers
 import kotlinx.serialization.Contextual
 import kotlinx.serialization.Serializable
 
@@ -7,10 +8,35 @@ import kotlinx.serialization.Serializable
 data class TypeDefinition(
   val type: String,
   val format: String? = null,
-  val description: String? = null,
   val properties: Map<String, JsonSchema>? = null,
   val required: Set<String>? = null,
   @Contextual val default: Any? = null,
+  override val deprecated: Boolean? = null,
+  override val description: String? = null,
+  // Constraints
+
+  // Number
+  @Serializable(with = Serializers.Number::class)
+  val multipleOf: Number? = null,
+  @Serializable(with = Serializers.Number::class)
+  val maximum: Number? = null,
+  @Serializable(with = Serializers.Number::class)
+  val exclusiveMaximum: Number? = null,
+  @Serializable(with = Serializers.Number::class)
+  val minimum: Number? = null,
+  @Serializable(with = Serializers.Number::class)
+  val exclusiveMinimum: Number? = null,
+
+  // String
+  val maxLength: Int? = null,
+  val minLength: Int? = null,
+  val pattern: String? = null,
+  val contentEncoding: String? = null,
+  val contentMediaType: String? = null,
+
+  // Object
+  val maxProperties: Int? = null,
+  val minProperties: Int? = null,
 ) : JsonSchema {
 
   fun withDefault(default: Any): TypeDefinition = this.copy(default = default)

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

@@ -1,5 +1,6 @@
 package io.bkbn.kompendium.json.schema.handler
 
+import io.bkbn.kompendium.enrichment.TypeEnrichment
 import io.bkbn.kompendium.json.schema.SchemaConfigurator
 import io.bkbn.kompendium.json.schema.SchemaGenerator
 import io.bkbn.kompendium.json.schema.definition.ArrayDefinition
@@ -9,17 +10,22 @@ import io.bkbn.kompendium.json.schema.definition.OneOfDefinition
 import io.bkbn.kompendium.json.schema.definition.ReferenceDefinition
 import io.bkbn.kompendium.json.schema.definition.TypeDefinition
 import io.bkbn.kompendium.json.schema.util.Helpers.getReferenceSlug
-import io.bkbn.kompendium.json.schema.util.Helpers.getSimpleSlug
+import io.bkbn.kompendium.json.schema.util.Helpers.getSlug
 import kotlin.reflect.KType
 
 object CollectionHandler {
-  fun handle(type: KType, cache: MutableMap<String, JsonSchema>, schemaConfigurator: SchemaConfigurator): JsonSchema {
+  fun handle(
+    type: KType,
+    cache: MutableMap<String, JsonSchema>,
+    schemaConfigurator: SchemaConfigurator,
+    enrichment: TypeEnrichment<*>? = null
+  ): JsonSchema {
     val collectionType = type.arguments.first().type
       ?: error("This indicates a bug in Kompendium, please open a GitHub issue!")
-    val typeSchema = SchemaGenerator.fromTypeToSchema(collectionType, cache, schemaConfigurator).let {
+    val typeSchema = SchemaGenerator.fromTypeToSchema(collectionType, cache, schemaConfigurator, enrichment).let {
       if (it is TypeDefinition && it.type == "object") {
-        cache[collectionType.getSimpleSlug()] = it
-        ReferenceDefinition(collectionType.getReferenceSlug())
+        cache[collectionType.getSlug(enrichment)] = it
+        ReferenceDefinition(collectionType.getReferenceSlug(enrichment))
       } else {
         it
       }

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

@@ -1,16 +1,22 @@
 package io.bkbn.kompendium.json.schema.handler
 
+import io.bkbn.kompendium.enrichment.TypeEnrichment
 import io.bkbn.kompendium.json.schema.definition.EnumDefinition
 import io.bkbn.kompendium.json.schema.definition.JsonSchema
 import io.bkbn.kompendium.json.schema.definition.ReferenceDefinition
 import io.bkbn.kompendium.json.schema.util.Helpers.getReferenceSlug
-import io.bkbn.kompendium.json.schema.util.Helpers.getSimpleSlug
+import io.bkbn.kompendium.json.schema.util.Helpers.getSlug
 import kotlin.reflect.KClass
 import kotlin.reflect.KType
 
 object EnumHandler {
-  fun handle(type: KType, clazz: KClass<*>, cache: MutableMap<String, JsonSchema>): JsonSchema {
-    cache[type.getSimpleSlug()] = ReferenceDefinition(type.getReferenceSlug())
+  fun handle(
+    type: KType,
+    clazz: KClass<*>,
+    cache: MutableMap<String, JsonSchema>,
+    enrichment: TypeEnrichment<*>? = null
+  ): JsonSchema {
+    cache[type.getSlug(enrichment)] = ReferenceDefinition(type.getReferenceSlug(enrichment))
 
     val options = clazz.java.enumConstants.map { it.toString() }.toSet()
     return EnumDefinition(type = "string", enum = options)

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

@@ -1,5 +1,6 @@
 package io.bkbn.kompendium.json.schema.handler
 
+import io.bkbn.kompendium.enrichment.TypeEnrichment
 import io.bkbn.kompendium.json.schema.SchemaConfigurator
 import io.bkbn.kompendium.json.schema.SchemaGenerator
 import io.bkbn.kompendium.json.schema.definition.JsonSchema
@@ -9,21 +10,26 @@ import io.bkbn.kompendium.json.schema.definition.OneOfDefinition
 import io.bkbn.kompendium.json.schema.definition.ReferenceDefinition
 import io.bkbn.kompendium.json.schema.definition.TypeDefinition
 import io.bkbn.kompendium.json.schema.util.Helpers.getReferenceSlug
-import io.bkbn.kompendium.json.schema.util.Helpers.getSimpleSlug
+import io.bkbn.kompendium.json.schema.util.Helpers.getSlug
 import kotlin.reflect.KClass
 import kotlin.reflect.KType
 
 object MapHandler {
 
-  fun handle(type: KType, cache: MutableMap<String, JsonSchema>, schemaConfigurator: SchemaConfigurator): JsonSchema {
+  fun handle(
+    type: KType,
+    cache: MutableMap<String, JsonSchema>,
+    schemaConfigurator: SchemaConfigurator,
+    enrichment: TypeEnrichment<*>? = null
+  ): JsonSchema {
     require(type.arguments.first().type?.classifier as KClass<*> == String::class) {
       "JSON requires that map keys MUST be Strings.  You provided ${type.arguments.first().type}"
     }
     val valueType = type.arguments[1].type ?: error("this indicates a bug in Kompendium, please open a GitHub issue")
-    val valueSchema = SchemaGenerator.fromTypeToSchema(valueType, cache, schemaConfigurator).let {
+    val valueSchema = SchemaGenerator.fromTypeToSchema(valueType, cache, schemaConfigurator, enrichment).let {
       if (it is TypeDefinition && it.type == "object") {
-        cache[valueType.getSimpleSlug()] = it
-        ReferenceDefinition(valueType.getReferenceSlug())
+        cache[valueType.getSlug(enrichment)] = it
+        ReferenceDefinition(valueType.getReferenceSlug(enrichment))
       } else {
         it
       }

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

@@ -1,5 +1,6 @@
 package io.bkbn.kompendium.json.schema.handler
 
+import io.bkbn.kompendium.enrichment.TypeEnrichment
 import io.bkbn.kompendium.json.schema.SchemaConfigurator
 import io.bkbn.kompendium.json.schema.SchemaGenerator
 import io.bkbn.kompendium.json.schema.definition.AnyOfDefinition
@@ -7,7 +8,7 @@ import io.bkbn.kompendium.json.schema.definition.JsonSchema
 import io.bkbn.kompendium.json.schema.definition.ReferenceDefinition
 import io.bkbn.kompendium.json.schema.definition.TypeDefinition
 import io.bkbn.kompendium.json.schema.util.Helpers.getReferenceSlug
-import io.bkbn.kompendium.json.schema.util.Helpers.getSimpleSlug
+import io.bkbn.kompendium.json.schema.util.Helpers.getSlug
 import kotlin.reflect.KClass
 import kotlin.reflect.KType
 import kotlin.reflect.full.createType
@@ -18,15 +19,17 @@ object SealedObjectHandler {
     type: KType,
     clazz: KClass<*>,
     cache: MutableMap<String, JsonSchema>,
-    schemaConfigurator: SchemaConfigurator
+    schemaConfigurator: SchemaConfigurator,
+    enrichment: TypeEnrichment<*>? = null,
   ): JsonSchema {
     val subclasses = clazz.sealedSubclasses
       .map { it.createType(type.arguments) }
       .map { t ->
-        SchemaGenerator.fromTypeToSchema(t, cache, schemaConfigurator).let { js ->
+        SchemaGenerator.fromTypeToSchema(t, cache, schemaConfigurator, enrichment).let { js ->
           if (js is TypeDefinition && js.type == "object") {
-            cache[t.getSimpleSlug()] = js
-            ReferenceDefinition(t.getReferenceSlug())
+            val slug = t.getSlug(enrichment)
+            cache[slug] = js
+            ReferenceDefinition(t.getReferenceSlug(enrichment))
           } else {
             js
           }

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

@@ -1,16 +1,21 @@
 package io.bkbn.kompendium.json.schema.handler
 
+import io.bkbn.kompendium.enrichment.PropertyEnrichment
+import io.bkbn.kompendium.enrichment.TypeEnrichment
 import io.bkbn.kompendium.json.schema.SchemaConfigurator
 import io.bkbn.kompendium.json.schema.SchemaGenerator
+import io.bkbn.kompendium.json.schema.definition.AnyOfDefinition
+import io.bkbn.kompendium.json.schema.definition.ArrayDefinition
 import io.bkbn.kompendium.json.schema.definition.EnumDefinition
 import io.bkbn.kompendium.json.schema.definition.JsonSchema
+import io.bkbn.kompendium.json.schema.definition.MapDefinition
 import io.bkbn.kompendium.json.schema.definition.NullableDefinition
 import io.bkbn.kompendium.json.schema.definition.OneOfDefinition
 import io.bkbn.kompendium.json.schema.definition.ReferenceDefinition
 import io.bkbn.kompendium.json.schema.definition.TypeDefinition
 import io.bkbn.kompendium.json.schema.exception.UnknownSchemaException
 import io.bkbn.kompendium.json.schema.util.Helpers.getReferenceSlug
-import io.bkbn.kompendium.json.schema.util.Helpers.getSimpleSlug
+import io.bkbn.kompendium.json.schema.util.Helpers.getSlug
 import kotlin.reflect.KClass
 import kotlin.reflect.KProperty
 import kotlin.reflect.KType
@@ -26,26 +31,34 @@ object SimpleObjectHandler {
     type: KType,
     clazz: KClass<*>,
     cache: MutableMap<String, JsonSchema>,
-    schemaConfigurator: SchemaConfigurator
+    schemaConfigurator: SchemaConfigurator,
+    enrichment: TypeEnrichment<*>?,
   ): JsonSchema {
 
-    cache[type.getSimpleSlug()] = ReferenceDefinition(type.getReferenceSlug())
+    cache[type.getSlug(enrichment)] = ReferenceDefinition(type.getReferenceSlug(enrichment))
 
     val typeMap = clazz.typeParameters.zip(type.arguments).toMap()
     val props = schemaConfigurator.serializableMemberProperties(clazz)
       .filterNot { it.javaField == null }
       .associate { prop ->
+        val propTypeEnrichment = when (val pe = enrichment?.getEnrichmentForProperty(prop)) {
+          is PropertyEnrichment -> pe
+          else -> null
+        }
+
         val schema = when (prop.needsToInjectGenerics(typeMap)) {
-          true -> handleNestedGenerics(typeMap, prop, cache, schemaConfigurator)
+          true -> handleNestedGenerics(typeMap, prop, cache, schemaConfigurator, propTypeEnrichment)
           false -> when (typeMap.containsKey(prop.returnType.classifier)) {
-            true -> handleGenericProperty(prop, typeMap, cache, schemaConfigurator)
-            false -> handleProperty(prop, cache, schemaConfigurator)
+            true -> handleGenericProperty(prop, typeMap, cache, schemaConfigurator, propTypeEnrichment)
+            false -> handleProperty(prop, cache, schemaConfigurator, propTypeEnrichment?.typeEnrichment)
           }
         }
 
-        val nullCheckSchema = when (prop.returnType.isMarkedNullable && !schema.isNullable()) {
-          true -> OneOfDefinition(NullableDefinition(), schema)
-          false -> schema
+        val enrichedSchema = propTypeEnrichment?.applyToSchema(schema) ?: schema
+
+        val nullCheckSchema = when (prop.returnType.isMarkedNullable && !enrichedSchema.isNullable()) {
+          true -> OneOfDefinition(NullableDefinition(), enrichedSchema)
+          false -> enrichedSchema
         }
 
         schemaConfigurator.serializableName(prop) to nullCheckSchema
@@ -90,7 +103,8 @@ object SimpleObjectHandler {
     typeMap: Map<KTypeParameter, KTypeProjection>,
     prop: KProperty<*>,
     cache: MutableMap<String, JsonSchema>,
-    schemaConfigurator: SchemaConfigurator
+    schemaConfigurator: SchemaConfigurator,
+    propEnrichment: PropertyEnrichment?
   ): JsonSchema {
     val propClass = prop.returnType.classifier as KClass<*>
     val types = prop.returnType.arguments.map {
@@ -98,10 +112,11 @@ object SimpleObjectHandler {
       typeMap.filterKeys { k -> k.name == typeSymbol }.values.first()
     }
     val constructedType = propClass.createType(types)
-    return SchemaGenerator.fromTypeToSchema(constructedType, cache, schemaConfigurator).let {
+    return SchemaGenerator.fromTypeToSchema(constructedType, cache, schemaConfigurator, propEnrichment?.typeEnrichment)
+      .let {
         if (it.isOrContainsObjectOrEnumDef()) {
-        cache[constructedType.getSimpleSlug()] = it
-        ReferenceDefinition(prop.returnType.getReferenceSlug())
+          cache[constructedType.getSlug(propEnrichment)] = it
+          ReferenceDefinition(prop.returnType.getReferenceSlug(propEnrichment))
         } else {
           it
         }
@@ -112,14 +127,15 @@ object SimpleObjectHandler {
     prop: KProperty<*>,
     typeMap: Map<KTypeParameter, KTypeProjection>,
     cache: MutableMap<String, JsonSchema>,
-    schemaConfigurator: SchemaConfigurator
+    schemaConfigurator: SchemaConfigurator,
+    propEnrichment: PropertyEnrichment?
   ): JsonSchema {
     val type = typeMap[prop.returnType.classifier]?.type
       ?: error("This indicates a bug in Kompendium, please open a GitHub issue")
-    return SchemaGenerator.fromTypeToSchema(type, cache, schemaConfigurator).let {
+    return SchemaGenerator.fromTypeToSchema(type, cache, schemaConfigurator, propEnrichment?.typeEnrichment).let {
       if (it.isOrContainsObjectOrEnumDef()) {
-        cache[type.getSimpleSlug()] = it
-        ReferenceDefinition(type.getReferenceSlug())
+        cache[type.getSlug(propEnrichment)] = it
+        ReferenceDefinition(type.getReferenceSlug(propEnrichment))
       } else {
         it
       }
@@ -129,12 +145,13 @@ object SimpleObjectHandler {
   private fun handleProperty(
     prop: KProperty<*>,
     cache: MutableMap<String, JsonSchema>,
-    schemaConfigurator: SchemaConfigurator
+    schemaConfigurator: SchemaConfigurator,
+    propEnrichment: TypeEnrichment<*>?
   ): JsonSchema =
-    SchemaGenerator.fromTypeToSchema(prop.returnType, cache, schemaConfigurator).let {
+    SchemaGenerator.fromTypeToSchema(prop.returnType, cache, schemaConfigurator, propEnrichment).let {
       if (it.isOrContainsObjectOrEnumDef()) {
-        cache[prop.returnType.getSimpleSlug()] = it
-        ReferenceDefinition(prop.returnType.getReferenceSlug())
+        cache[prop.returnType.getSlug(propEnrichment)] = it
+        ReferenceDefinition(prop.returnType.getReferenceSlug(propEnrichment))
       } else {
         it
       }
@@ -149,4 +166,36 @@ object SimpleObjectHandler {
   }
 
   private fun JsonSchema.isNullable(): Boolean = this is OneOfDefinition && this.oneOf.any { it is NullableDefinition }
+
+  private fun PropertyEnrichment.applyToSchema(schema: JsonSchema): JsonSchema = when (schema) {
+    is AnyOfDefinition -> schema.copy(deprecated = deprecated, description = description)
+    is ArrayDefinition -> schema.copy(
+      deprecated = deprecated,
+      description = description,
+      minItems = minItems,
+      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)
+    is OneOfDefinition -> schema.copy(deprecated = deprecated, description = description)
+    is ReferenceDefinition -> schema.copy(deprecated = deprecated, description = description)
+    is TypeDefinition -> schema.copy(
+      deprecated = deprecated,
+      description = description,
+      multipleOf = multipleOf,
+      maximum = maximum,
+      exclusiveMaximum = exclusiveMaximum,
+      minimum = minimum,
+      exclusiveMinimum = exclusiveMinimum,
+      maxLength = maxLength,
+      minLength = minLength,
+      pattern = pattern,
+      contentEncoding = contentEncoding,
+      contentMediaType = contentMediaType,
+      maxProperties = maxProperties,
+      minProperties = minProperties,
+    )
+  }
 }

json-schema/src/main/kotlin/io/bkbn/kompendium/json/schema/util/Helpers.kt

@@ -1,5 +1,8 @@
 package io.bkbn.kompendium.json.schema.util
 
+import io.bkbn.kompendium.enrichment.Enrichment
+import io.bkbn.kompendium.enrichment.PropertyEnrichment
+import io.bkbn.kompendium.enrichment.TypeEnrichment
 import kotlin.reflect.KClass
 import kotlin.reflect.KType
 
@@ -7,12 +10,26 @@ object Helpers {
 
   private const val COMPONENT_SLUG = "#/components/schemas"
 
+  fun KType.getSlug(enrichment: Enrichment? = null) = when (enrichment) {
+    is TypeEnrichment<*> -> getEnrichedSlug(enrichment)
+    is PropertyEnrichment -> error("Slugs should not be generated for field enrichments")
+    null -> getSimpleSlug()
+  }
+
   fun KType.getSimpleSlug(): String = when {
     this.arguments.isNotEmpty() -> genericNameAdapter(this, classifier as KClass<*>)
     else -> (classifier as KClass<*>).kompendiumSlug() ?: error("Could not determine simple name for $this")
   }
 
-  fun KType.getReferenceSlug(): String = when {
+  private fun KType.getEnrichedSlug(enrichment: TypeEnrichment<*>) = getSimpleSlug() + "-${enrichment.id}"
+
+  fun KType.getReferenceSlug(enrichment: Enrichment? = null): String = when (enrichment) {
+    is TypeEnrichment<*> -> getSimpleReferenceSlug() + "-${enrichment.id}"
+    is PropertyEnrichment -> error("Reference slugs should never be generated for field enrichments")
+    null -> getSimpleReferenceSlug()
+  }
+
+  private fun KType.getSimpleReferenceSlug() = when {
     arguments.isNotEmpty() -> "$COMPONENT_SLUG/${genericNameAdapter(this, classifier as KClass<*>)}"
     else -> "$COMPONENT_SLUG/${(classifier as KClass<*>).kompendiumSlug()}"
   }

json-schema/src/main/kotlin/io/bkbn/kompendium/json/schema/util/Serializers.kt

@@ -0,0 +1,43 @@
+package io.bkbn.kompendium.json.schema.util
+
+import kotlinx.serialization.KSerializer
+import kotlinx.serialization.descriptors.PrimitiveKind
+import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor
+import kotlinx.serialization.descriptors.SerialDescriptor
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
+import java.util.UUID
+import kotlin.Number as KNumber
+
+object Serializers {
+
+  object Uuid : KSerializer<UUID> {
+    override val descriptor = PrimitiveSerialDescriptor("UUID", PrimitiveKind.STRING)
+
+    override fun deserialize(decoder: Decoder): UUID {
+      return UUID.fromString(decoder.decodeString())
+    }
+
+    override fun serialize(encoder: Encoder, value: UUID) {
+      encoder.encodeString(value.toString())
+    }
+  }
+
+  object Number : KSerializer<KNumber> {
+    override val descriptor: SerialDescriptor = PrimitiveSerialDescriptor("Number", PrimitiveKind.STRING)
+
+    override fun deserialize(decoder: Decoder): KNumber {
+      TODO("Not yet implemented")
+    }
+
+    override fun serialize(encoder: Encoder, value: KNumber) {
+      when (value) {
+        is Int -> encoder.encodeInt(value)
+        is Long -> encoder.encodeLong(value)
+        is Double -> encoder.encodeDouble(value)
+        is Float -> encoder.encodeFloat(value)
+        else -> throw IllegalArgumentException("Number is not a valid type")
+      }
+    }
+  }
+}

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

@@ -2,6 +2,7 @@ package io.bkbn.kompendium.json.schema
 
 import io.bkbn.kompendium.core.fixtures.ComplexRequest
 import io.bkbn.kompendium.core.fixtures.FlibbityGibbit
+import io.bkbn.kompendium.core.fixtures.NestedComplexItem
 import io.bkbn.kompendium.core.fixtures.ObjectWithEnum
 import io.bkbn.kompendium.core.fixtures.SerialNameObject
 import io.bkbn.kompendium.core.fixtures.SimpleEnum
@@ -11,12 +12,14 @@ 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.enrichment.TypeEnrichment
 import io.bkbn.kompendium.json.schema.definition.JsonSchema
 import io.kotest.assertions.json.shouldEqualJson
 import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.core.spec.style.DescribeSpec
 import kotlinx.serialization.json.Json
 import java.util.UUID
+import kotlin.reflect.typeOf
 
 class SchemaGeneratorTest : DescribeSpec({
   describe("Scalars") {
@@ -88,7 +91,13 @@ class SchemaGeneratorTest : DescribeSpec({
       jsonSchemaTest<Map<String, Int>>("T0012__scalar_map.json")
     }
     it("Throws an error when map keys are not strings") {
-      shouldThrow<IllegalArgumentException> { SchemaGenerator.fromTypeToSchema<Map<Int, Int>>() }
+      shouldThrow<IllegalArgumentException> {
+        SchemaGenerator.fromTypeToSchema(
+          typeOf<Map<Int, Int>>(),
+          cache = mutableMapOf(),
+          schemaConfigurator = KotlinXSchemaConfigurator()
+        )
+      }
     }
     it("Can generate the schema for a map of objects") {
       jsonSchemaTest<Map<String, TestResponse>>("T0013__object_map.json")
@@ -97,6 +106,36 @@ class SchemaGeneratorTest : DescribeSpec({
       jsonSchemaTest<Map<String, Int>?>("T0014__nullable_map.json")
     }
   }
+  describe("Enrichment") {
+    it("Can attach an enrichment to a simple type") {
+      jsonSchemaTest<TestSimpleRequest>(
+        snapshotName = "T0022__enriched_simple_object.json",
+        enrichment = TypeEnrichment("simple") {
+          TestSimpleRequest::a {
+            description = "This is a simple description"
+          }
+          TestSimpleRequest::b {
+            deprecated = true
+          }
+        }
+      )
+    }
+    it("Can properly assign a reference to a nested enrichment") {
+      jsonSchemaTest<ComplexRequest>(
+        snapshotName = "T0023__enriched_nested_reference.json",
+        enrichment = TypeEnrichment("example") {
+          ComplexRequest::tables {
+            description = "Collection of important items"
+            typeEnrichment = TypeEnrichment("table") {
+              NestedComplexItem::name {
+                description = "The name of the table"
+              }
+            }
+          }
+        }
+      )
+    }
+  }
 }) {
   companion object {
     private val json = Json {
@@ -107,11 +146,14 @@ class SchemaGeneratorTest : DescribeSpec({
 
     private fun JsonSchema.serialize() = json.encodeToString(JsonSchema.serializer(), this)
 
-    private inline fun <reified T> jsonSchemaTest(snapshotName: String) {
+    private inline fun <reified T> jsonSchemaTest(snapshotName: String, enrichment: TypeEnrichment<*>? = null) {
       // act
-      val schema = SchemaGenerator.fromTypeToSchema<T>(schemaConfigurator = KotlinXSchemaConfigurator())
-
-      // todo add cache assertions!!!
+      val schema = SchemaGenerator.fromTypeToSchema(
+        type = typeOf<T>(),
+        cache = mutableMapOf(),
+        schemaConfigurator = KotlinXSchemaConfigurator(),
+        enrichment = enrichment,
+      )
 
       // assert
       schema.serialize() shouldEqualJson getFileSnapshot(snapshotName)

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

@@ -0,0 +1,18 @@
+{
+  "type": "object",
+  "properties": {
+    "a": {
+      "type": "string",
+      "description": "This is a simple description"
+    },
+    "b": {
+      "type": "number",
+      "format": "int32",
+      "deprecated": true
+    }
+  },
+  "required": [
+    "a",
+    "b"
+  ]
+}

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

@@ -0,0 +1,23 @@
+{
+  "type": "object",
+  "properties": {
+    "amazingField": {
+      "type": "string"
+    },
+    "org": {
+      "type": "string"
+    },
+    "tables": {
+      "items": {
+        "$ref": "#/components/schemas/NestedComplexItem-table"
+      },
+      "description": "Collection of important items",
+      "type": "array"
+    }
+  },
+  "required": [
+    "amazingField",
+    "org",
+    "tables"
+  ]
+}

locations/build.gradle.kts

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

locations/src/main/kotlin/io/bkbn/kompendium/locations/NotarizedLocations.kt

@@ -51,17 +51,17 @@ object NotarizedLocations {
     val spec = application.attributes[KompendiumAttributes.openApiSpec]
     val serializableReader = application.attributes[KompendiumAttributes.schemaConfigurator]
     pluginConfig.locations.forEach { (k, v) ->
-      val path = Path()
-      path.parameters = v.parameters
-      v.get?.addToSpec(path, spec, v, serializableReader)
-      v.delete?.addToSpec(path, spec, v, serializableReader)
-      v.head?.addToSpec(path, spec, v, serializableReader)
-      v.options?.addToSpec(path, spec, v, serializableReader)
-      v.post?.addToSpec(path, spec, v, serializableReader)
-      v.put?.addToSpec(path, spec, v, serializableReader)
-      v.patch?.addToSpec(path, spec, v, serializableReader)
-
       val location = k.getLocationFromClass()
+      val path = spec.paths[location] ?: Path()
+      path.parameters = path.parameters?.plus(v.parameters) ?: v.parameters
+      v.get?.addToSpec(path, spec, v, serializableReader, location)
+      v.delete?.addToSpec(path, spec, v, serializableReader, location)
+      v.head?.addToSpec(path, spec, v, serializableReader, location)
+      v.options?.addToSpec(path, spec, v, serializableReader, location)
+      v.post?.addToSpec(path, spec, v, serializableReader, location)
+      v.put?.addToSpec(path, spec, v, serializableReader, location)
+      v.patch?.addToSpec(path, spec, v, serializableReader, location)
+
       spec.paths[location] = path
     }
   }

oas/build.gradle.kts

@@ -21,6 +21,7 @@ dependencies {
   val detektVersion: String by project
 
   api(projects.kompendiumJsonSchema)
+  api(projects.kompendiumEnrichment)
   implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1")
 
   // Formatting

playground/build.gradle.kts

@@ -15,6 +15,7 @@ dependencies {
   implementation(projects.kompendiumCore)
   implementation(projects.kompendiumLocations)
   implementation(projects.kompendiumResources)
+  implementation(projects.kompendiumProtobufJavaConverter)
 
   // Ktor
   val ktorVersion: String by project
@@ -34,14 +35,14 @@ dependencies {
 
   // Logging
   implementation("org.apache.logging.log4j:log4j-api-kotlin:1.2.0")
-  implementation("org.apache.logging.log4j:log4j-api:2.19.0")
-  implementation("org.apache.logging.log4j:log4j-core:2.19.0")
-  implementation("org.slf4j:slf4j-api:2.0.3")
-  implementation("org.slf4j:slf4j-simple:2.0.3")
+  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-simple:2.0.6")
 
 
   implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1")
   implementation("org.jetbrains.kotlinx:kotlinx-datetime:0.4.0")
 
-  implementation("joda-time:joda-time:2.12.1")
+  implementation("joda-time:joda-time:2.12.2")
 }

playground/src/main/kotlin/io/bkbn/kompendium/playground/AuthPlayground.kt

@@ -4,6 +4,7 @@ import io.bkbn.kompendium.core.metadata.GetInfo
 import io.bkbn.kompendium.core.plugin.NotarizedApplication
 import io.bkbn.kompendium.core.plugin.NotarizedRoute
 import io.bkbn.kompendium.core.routes.redoc
+import io.bkbn.kompendium.core.routes.swagger
 import io.bkbn.kompendium.json.schema.definition.TypeDefinition
 import io.bkbn.kompendium.oas.component.Components
 import io.bkbn.kompendium.oas.payload.Parameter
@@ -68,6 +69,7 @@ private fun Application.mainModule() {
     )
   }
   routing {
+    swagger(pageTitle = "Simple API Docs")
     redoc(pageTitle = "Simple API Docs")
     authenticate("basic") {
       route("/{id}") {

playground/src/main/kotlin/io/bkbn/kompendium/playground/BasicPlayground.kt

@@ -4,6 +4,7 @@ import io.bkbn.kompendium.core.metadata.GetInfo
 import io.bkbn.kompendium.core.plugin.NotarizedApplication
 import io.bkbn.kompendium.core.plugin.NotarizedRoute
 import io.bkbn.kompendium.core.routes.redoc
+import io.bkbn.kompendium.core.routes.swagger
 import io.bkbn.kompendium.json.schema.KotlinXSchemaConfigurator
 import io.bkbn.kompendium.json.schema.definition.TypeDefinition
 import io.bkbn.kompendium.oas.payload.Parameter
@@ -49,8 +50,8 @@ private fun Application.mainModule() {
     schemaConfigurator = KotlinXSchemaConfigurator()
   }
   routing {
+    swagger(pageTitle = "Simple API Docs")
     redoc(pageTitle = "Simple API Docs")
-
     route("/{id}") {
       idDocumentation()
       get {

playground/src/main/kotlin/io/bkbn/kompendium/playground/CustomTypePlayground.kt

@@ -4,6 +4,7 @@ import io.bkbn.kompendium.core.metadata.GetInfo
 import io.bkbn.kompendium.core.plugin.NotarizedApplication
 import io.bkbn.kompendium.core.plugin.NotarizedRoute
 import io.bkbn.kompendium.core.routes.redoc
+import io.bkbn.kompendium.core.routes.swagger
 import io.bkbn.kompendium.json.schema.definition.TypeDefinition
 import io.bkbn.kompendium.oas.payload.Parameter
 import io.bkbn.kompendium.oas.serialization.KompendiumSerializersModule
@@ -51,6 +52,7 @@ private fun Application.mainModule() {
     )
   }
   routing {
+    swagger(pageTitle = "Simple API Docs")
     redoc(pageTitle = "Simple API Docs")
 
     route("/{id}") {

playground/src/main/kotlin/io/bkbn/kompendium/playground/EnrichmentPlayground.kt

@@ -0,0 +1,158 @@
+package io.bkbn.kompendium.playground
+
+import io.bkbn.kompendium.core.metadata.GetInfo
+import io.bkbn.kompendium.core.metadata.PostInfo
+import io.bkbn.kompendium.core.plugin.NotarizedApplication
+import io.bkbn.kompendium.core.plugin.NotarizedRoute
+import io.bkbn.kompendium.core.routes.redoc
+import io.bkbn.kompendium.core.routes.swagger
+import io.bkbn.kompendium.enrichment.TypeEnrichment
+import io.bkbn.kompendium.json.schema.KotlinXSchemaConfigurator
+import io.bkbn.kompendium.json.schema.definition.TypeDefinition
+import io.bkbn.kompendium.oas.payload.Parameter
+import io.bkbn.kompendium.oas.serialization.KompendiumSerializersModule
+import io.bkbn.kompendium.playground.util.ExampleRequest
+import io.bkbn.kompendium.playground.util.ExampleResponse
+import io.bkbn.kompendium.playground.util.ExceptionResponse
+import io.bkbn.kompendium.playground.util.InnerRequest
+import io.bkbn.kompendium.playground.util.Util.baseSpec
+import io.ktor.http.HttpStatusCode
+import io.ktor.serialization.kotlinx.json.json
+import io.ktor.server.application.Application
+import io.ktor.server.application.call
+import io.ktor.server.application.install
+import io.ktor.server.cio.CIO
+import io.ktor.server.engine.embeddedServer
+import io.ktor.server.plugins.contentnegotiation.ContentNegotiation
+import io.ktor.server.response.respond
+import io.ktor.server.routing.*
+import kotlinx.serialization.json.Json
+
+fun main() {
+  embeddedServer(
+    CIO,
+    port = 8081,
+    module = Application::mainModule
+  ).start(wait = true)
+}
+
+private fun Application.mainModule() {
+  install(ContentNegotiation) {
+    json(Json {
+      serializersModule = KompendiumSerializersModule.module
+      encodeDefaults = true
+      explicitNulls = false
+    })
+  }
+  install(NotarizedApplication()) {
+    spec = baseSpec
+    // Adds support for @Transient and @SerialName
+    // If you are not using them this is not required.
+    schemaConfigurator = KotlinXSchemaConfigurator()
+  }
+  routing {
+    swagger(pageTitle = "Simple API Docs")
+    redoc(pageTitle = "Simple API Docs")
+    enrichedDocumentation()
+    post {
+      call.respond(HttpStatusCode.OK, ExampleResponse(false))
+    }
+  }
+}
+
+private val testEnrichment = TypeEnrichment("testerino") {
+  ExampleRequest::thingA {
+    description = "This is a thing"
+  }
+  ExampleRequest::thingB {
+    description = "This is another thing"
+  }
+  ExampleRequest::thingC {
+    deprecated = true
+    description = "A good but old field"
+    typeEnrichment = TypeEnrichment("big-tings") {
+      InnerRequest::d {
+        exclusiveMaximum = 10.0
+        exclusiveMinimum = 1.1
+        description = "THE BIG D"
+      }
+    }
+  }
+}
+
+private val testResponseEnrichment = TypeEnrichment("testerino") {
+  ExampleResponse::isReal {
+    description = "Is this thing real or not?"
+  }
+}
+
+private fun Route.enrichedDocumentation() {
+  install(NotarizedRoute()) {
+    post = PostInfo.builder {
+      summary("Do a thing")
+      description("This is a thing")
+      request {
+        requestType(enrichment = testEnrichment)
+        description("This is the request")
+      }
+      response {
+        responseCode(HttpStatusCode.OK)
+        responseType(enrichment = testResponseEnrichment)
+        description("This is the response")
+      }
+    }
+  }
+}
+
+private fun Route.idDocumentation() {
+  install(NotarizedRoute()) {
+    parameters = listOf(
+      Parameter(
+        name = "id",
+        `in` = Parameter.Location.path,
+        schema = TypeDefinition.STRING
+      )
+    )
+    get = GetInfo.builder {
+      summary("Get user by id")
+      description("A very neat endpoint!")
+      response {
+        responseCode(HttpStatusCode.OK)
+        responseType<ExampleResponse>()
+        description("Will return whether or not the user is real 😱")
+      }
+
+      canRespond {
+        responseType<ExceptionResponse>()
+        responseCode(HttpStatusCode.NotFound)
+        description("Indicates that a user with this id does not exist")
+      }
+    }
+  }
+}
+
+private fun Route.profileDocumentation() {
+  install(NotarizedRoute()) {
+    parameters = listOf(
+      Parameter(
+        name = "id",
+        `in` = Parameter.Location.path,
+        schema = TypeDefinition.STRING
+      )
+    )
+    get = GetInfo.builder {
+      summary("Get a users profile")
+      description("A cool endpoint!")
+      response {
+        responseCode(HttpStatusCode.OK)
+        responseType<ExampleResponse>()
+        description("Returns user profile information")
+      }
+      canRespond {
+        responseType<ExceptionResponse>()
+        responseCode(HttpStatusCode.NotFound)
+        description("Indicates that a user with this id does not exist")
+      }
+    }
+  }
+}

playground/src/main/kotlin/io/bkbn/kompendium/playground/ExceptionPlayground.kt

@@ -4,6 +4,7 @@ import io.bkbn.kompendium.core.metadata.GetInfo
 import io.bkbn.kompendium.core.plugin.NotarizedApplication
 import io.bkbn.kompendium.core.plugin.NotarizedRoute
 import io.bkbn.kompendium.core.routes.redoc
+import io.bkbn.kompendium.core.routes.swagger
 import io.bkbn.kompendium.json.schema.definition.TypeDefinition
 import io.bkbn.kompendium.oas.payload.Parameter
 import io.bkbn.kompendium.oas.serialization.KompendiumSerializersModule
@@ -50,6 +51,7 @@ private fun Application.mainModule() {
     }
   }
   routing {
+    swagger(pageTitle = "Simple API Docs")
     redoc(pageTitle = "Simple API Docs")
 
     route("/{id}") {

playground/src/main/kotlin/io/bkbn/kompendium/playground/GsonSerializationPlayground.kt

@@ -6,6 +6,7 @@ import io.bkbn.kompendium.core.metadata.GetInfo
 import io.bkbn.kompendium.core.plugin.NotarizedApplication
 import io.bkbn.kompendium.core.plugin.NotarizedRoute
 import io.bkbn.kompendium.core.routes.redoc
+import io.bkbn.kompendium.core.routes.swagger
 import io.bkbn.kompendium.json.schema.SchemaConfigurator
 import io.bkbn.kompendium.json.schema.definition.TypeDefinition
 import io.bkbn.kompendium.oas.payload.Parameter
@@ -48,6 +49,7 @@ private fun Application.mainModule() {
     schemaConfigurator = GsonSchemaConfigurator()
   }
   routing {
+    swagger(pageTitle = "Simple API Docs")
     redoc(pageTitle = "Simple API Docs")
 
     route("/{id}") {

playground/src/main/kotlin/io/bkbn/kompendium/playground/HiddenDocsPlayground.kt

@@ -5,6 +5,7 @@ import io.bkbn.kompendium.core.metadata.GetInfo
 import io.bkbn.kompendium.core.plugin.NotarizedApplication
 import io.bkbn.kompendium.core.plugin.NotarizedRoute
 import io.bkbn.kompendium.core.routes.redoc
+import io.bkbn.kompendium.core.routes.swagger
 import io.bkbn.kompendium.json.schema.definition.TypeDefinition
 import io.bkbn.kompendium.oas.component.Components
 import io.bkbn.kompendium.oas.payload.Parameter
@@ -80,6 +81,7 @@ private fun Application.mainModule() {
   }
   routing {
     authenticate("basic") {
+      swagger(pageTitle = "Simple API Docs")
       redoc(pageTitle = "Simple API Docs")
       route("/{id}") {
         locationDocumentation()

playground/src/main/kotlin/io/bkbn/kompendium/playground/JacksonSerializationPlayground.kt

@@ -8,6 +8,7 @@ import io.bkbn.kompendium.core.metadata.GetInfo
 import io.bkbn.kompendium.core.plugin.NotarizedApplication
 import io.bkbn.kompendium.core.plugin.NotarizedRoute
 import io.bkbn.kompendium.core.routes.redoc
+import io.bkbn.kompendium.core.routes.swagger
 import io.bkbn.kompendium.json.schema.SchemaConfigurator
 import io.bkbn.kompendium.json.schema.definition.TypeDefinition
 import io.bkbn.kompendium.oas.payload.Parameter
@@ -51,6 +52,7 @@ private fun Application.mainModule() {
     schemaConfigurator = JacksonSchemaConfigurator()
   }
   routing {
+    swagger(pageTitle = "Simple API Docs")
     redoc(pageTitle = "Simple API Docs")
 
     route("/{id}") {

playground/src/main/kotlin/io/bkbn/kompendium/playground/LocationPlayground.kt

@@ -3,6 +3,7 @@ package io.bkbn.kompendium.playground
 import io.bkbn.kompendium.core.metadata.GetInfo
 import io.bkbn.kompendium.core.plugin.NotarizedApplication
 import io.bkbn.kompendium.core.routes.redoc
+import io.bkbn.kompendium.core.routes.swagger
 import io.bkbn.kompendium.json.schema.definition.TypeDefinition
 import io.bkbn.kompendium.locations.NotarizedLocations
 import io.bkbn.kompendium.oas.payload.Parameter
@@ -72,6 +73,7 @@ private fun Application.mainModule() {
     )
   }
   routing {
+    swagger(pageTitle = "Simple API Docs")
     redoc(pageTitle = "Simple API Docs")
     get<Listing> { listing ->
       call.respondText("Listing ${listing.name}, page ${listing.page}")

playground/src/main/kotlin/io/bkbn/kompendium/playground/ResourcesPlayground.kt

@@ -3,6 +3,7 @@ package io.bkbn.kompendium.playground
 import io.bkbn.kompendium.core.metadata.GetInfo
 import io.bkbn.kompendium.core.plugin.NotarizedApplication
 import io.bkbn.kompendium.core.routes.redoc
+import io.bkbn.kompendium.core.routes.swagger
 import io.bkbn.kompendium.json.schema.definition.TypeDefinition
 import io.bkbn.kompendium.oas.payload.Parameter
 import io.bkbn.kompendium.oas.serialization.KompendiumSerializersModule
@@ -73,6 +74,7 @@ private fun Application.mainModule() {
     )
   }
   routing {
+    swagger(pageTitle = "Simple API Docs")
     redoc(pageTitle = "Simple API Docs")
     get<ListingResource> { listing ->
       call.respondText("Listing ${listing.name}, page ${listing.page}")

playground/src/main/kotlin/io/bkbn/kompendium/playground/util/Models.kt

@@ -5,6 +5,19 @@ import io.ktor.server.locations.Location
 import kotlinx.datetime.Instant
 import kotlinx.serialization.Serializable
 
+@Serializable
+data class ExampleRequest(
+  val thingA: String,
+  val thingB: Int,
+  val thingC: InnerRequest,
+)
+
+@Serializable
+data class InnerRequest(
+  val d: Float,
+  val e: Boolean,
+)
+
 @Serializable
 data class ExampleResponse(val isReal: Boolean)
 

protobuf-java-converter/build.gradle.kts

@@ -0,0 +1,43 @@
+plugins {
+  kotlin("jvm")
+  kotlin("plugin.serialization")
+  id("io.bkbn.sourdough.library.jvm")
+  id("io.gitlab.arturbosch.detekt")
+  id("com.adarshr.test-logger")
+  id("maven-publish")
+  id("java-library")
+  id("signing")
+  id("org.jetbrains.kotlinx.kover")
+}
+
+sourdoughLibrary {
+  libraryName.set("Kompendium Protobuf java converter")
+  libraryDescription.set("Converts Java protobuf generated classes to custom type maps")
+  compilerArgs.set(listOf("-opt-in=kotlin.RequiresOptIn"))
+}
+
+dependencies {
+  // Versions
+  val detektVersion: String by project
+
+
+  implementation(projects.kompendiumJsonSchema)
+  implementation("com.google.protobuf:protobuf-java:3.22.0")
+  implementation("org.jetbrains.kotlin:kotlin-reflect:1.8.10")
+  implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1")
+
+  // Formatting
+  detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:$detektVersion")
+  testImplementation(testFixtures(projects.kompendiumCore))
+}
+
+
+testing {
+
+  suites {
+    named("test", JvmTestSuite::class) {
+      useJUnitJupiter()
+    }
+  }
+}
+

protobuf-java-converter/src/main/kotlin/io/bkbn/kompendium/protobufjavaconverter/converters/FieldDescriptiorConverters.kt

@@ -0,0 +1,177 @@
+package io.bkbn.kompendium.protobufjavaconverter.converters
+
+import com.google.protobuf.Descriptors
+import com.google.protobuf.GeneratedMessageV3
+import io.bkbn.kompendium.json.schema.definition.ArrayDefinition
+import io.bkbn.kompendium.json.schema.definition.EnumDefinition
+import io.bkbn.kompendium.json.schema.definition.JsonSchema
+import io.bkbn.kompendium.json.schema.definition.MapDefinition
+import io.bkbn.kompendium.json.schema.definition.NullableDefinition
+import io.bkbn.kompendium.json.schema.definition.ReferenceDefinition
+import io.bkbn.kompendium.json.schema.definition.TypeDefinition
+import kotlin.reflect.KType
+import kotlin.reflect.full.createType
+
+/**
+ * Extension function to generate all custom TypeDefinitions for.
+ *
+ * Traverses all fields and subfields of the message it also generates references for nested messages.
+ *
+ * @property GeneratedMessageV3 the protobuf message to generate all the custom definitions for
+ * @param snakeCase whether to convert the names to snake case or not
+ * @return a [Map] of ([KType], [TypeDefinition]) to be used in `customTypes` in [NoterizedApplication]
+ *
+ */
+fun GeneratedMessageV3.createCustomTypesForTypeAndSubTypes(snakeCase: Boolean = false): Map<KType, JsonSchema> {
+  val cache: MutableMap<String, JsonSchema> = mutableMapOf()
+  return mapOf(
+    this::class.createType() to TypeDefinition(
+      type = "object",
+      properties = toJsonSchemaMap(this.descriptorForType, cache, snakeCase)
+    )
+  )
+    // Dont forget to add the definitions for our references
+    .plus(
+      cache.map {
+        // Get the class from the respective key (which should be a fullname of the class
+        val clazz = Class.forName(it.key)
+        clazz.kotlin.createType() to it.value
+      }.toMap()
+    )
+}
+
+/**
+ * Loops over all fields of the provided Descriptor to discover the field types
+ *
+ * @param protoDescriptor the [Descriptors.FieldDescriptor] to convert
+ * @param cache map of cached definitions
+ * @param snakeCase whether to convert the names to snake case or not
+ * @return a [Map] of ([String], [JsonSchema])
+ *
+ */
+fun toJsonSchemaMap(
+  protoDescriptor: Descriptors.Descriptor,
+  cache: MutableMap<String, JsonSchema> = mutableMapOf(),
+  snakeCase: Boolean = false
+): Map<String, JsonSchema> =
+  protoDescriptor.fields.map {
+    val key = if (snakeCase) it.jsonName.toSnakeCase() else it.jsonName
+    key to fromNestedTypeToSchema(it, cache)
+  }.toMap()
+
+/**
+ * Very simple snake case conversion
+ */
+fun String.toSnakeCase() =
+  this.map {
+    if (it.isUpperCase()) "_${it.lowercase()}" else it.toString()
+  }.reduce { acc, s -> acc + s }
+
+/**
+ * Converts a field from a proto message to a JsonSchema
+ *
+ * @param javaProtoField the [Descriptors.FieldDescriptor] to convert
+ * @param cache map of cached definitions
+ * @return the resulting [JsonSchema]
+ *
+ */
+fun fromNestedTypeToSchema(
+  javaProtoField: Descriptors.FieldDescriptor,
+  cache: MutableMap<String, JsonSchema> = mutableMapOf()
+): JsonSchema =
+  when {
+    javaProtoField.isRepeated && !javaProtoField.isMapField -> ArrayDefinition(fromTypeToSchema(javaProtoField, cache))
+    javaProtoField.isMapField -> handleMapField(javaProtoField, cache)
+    else -> fromTypeToSchema(javaProtoField, cache)
+  }
+
+/**
+ * Converts a map field descriptor
+ *
+ * It generates some key examples based on the type provided and gets the TypeDefinition of the value.
+ *
+ * @param javaProtoField the field to convert (which should be a mapField)
+ * @param cache map of cached definitions
+ * @return returns the a [MapDefinition] schema with additional properties to describe the key and value
+ */
+@Suppress("MagicNumber")
+fun handleMapField(
+  javaProtoField: Descriptors.FieldDescriptor,
+  cache: MutableMap<String, JsonSchema> = mutableMapOf()
+): JsonSchema {
+  require(javaProtoField.isMapField) { "Should never be called for a non map type" }
+
+  val keyField = javaProtoField.containingType.nestedTypes.first().findFieldByName("key")
+  val valueField = javaProtoField.containingType.nestedTypes.first().findFieldByName("value")
+  val valueType = fromTypeToSchema(valueField, cache)
+  // Keys can only be string in json but we can still have "0", "0.0" or "true", "ENUM_VALUE" as keys
+  val keys: List<String> = when (keyField.javaType) {
+    Descriptors.FieldDescriptor.JavaType.INT,
+    Descriptors.FieldDescriptor.JavaType.LONG -> (0..1).map { it.toString() }
+    Descriptors.FieldDescriptor.JavaType.FLOAT,
+    Descriptors.FieldDescriptor.JavaType.DOUBLE -> listOf(0.0, 0.1, 0.2).map { it.toString() }
+    Descriptors.FieldDescriptor.JavaType.BOOLEAN -> listOf(true, false).map { it.toString() }
+    Descriptors.FieldDescriptor.JavaType.STRING -> (0..1).map { "myVariable$it" }
+    Descriptors.FieldDescriptor.JavaType.BYTE_STRING -> (0..1).map { "0x$it" }
+    Descriptors.FieldDescriptor.JavaType.ENUM -> (0..1).map { "ENUM_VALUE$it" }
+    null,
+    Descriptors.FieldDescriptor.JavaType.MESSAGE -> throw IllegalArgumentException("Cant use object as key")
+  }
+  return MapDefinition(
+    TypeDefinition(
+      type = "object",
+      properties = keys.map { it to valueType }.toMap()
+    )
+  )
+}
+
+/**
+ * Converts scalar, enum and message type descriptors to TypeDefinitions
+ *
+ * @param javaProtoField the field to convert
+ * @param cache map of cached definitions
+ * @return returns a matching [JsonSchema]
+ */
+fun fromTypeToSchema(
+  javaProtoField: Descriptors.FieldDescriptor,
+  cache: MutableMap<String, JsonSchema> = mutableMapOf()
+): JsonSchema {
+  checkTypeCache(javaProtoField, cache)?.let { return it }
+  return when (javaProtoField.javaType) {
+    Descriptors.FieldDescriptor.JavaType.INT -> TypeDefinition.INT
+    Descriptors.FieldDescriptor.JavaType.LONG -> TypeDefinition.LONG
+    Descriptors.FieldDescriptor.JavaType.FLOAT -> TypeDefinition.FLOAT
+    Descriptors.FieldDescriptor.JavaType.DOUBLE -> TypeDefinition.DOUBLE
+    Descriptors.FieldDescriptor.JavaType.BOOLEAN -> TypeDefinition.BOOLEAN
+    Descriptors.FieldDescriptor.JavaType.STRING -> TypeDefinition.STRING
+    Descriptors.FieldDescriptor.JavaType.BYTE_STRING -> TypeDefinition.STRING
+    Descriptors.FieldDescriptor.JavaType.ENUM -> {
+      cache[javaProtoField.enumType.fullName] = EnumDefinition(
+        type = "string",
+        enum = javaProtoField.enumType.values.map { it.name }.toSet()
+      )
+      ReferenceDefinition(javaProtoField.enumType.name)
+    }
+    Descriptors.FieldDescriptor.JavaType.MESSAGE -> {
+      // Traverse through possible nested messages
+      cache[javaProtoField.messageType.fullName] = TypeDefinition(
+        type = "object",
+        properties = javaProtoField.messageType.fields.map {
+          it.jsonName to fromNestedTypeToSchema(it, cache)
+        }.toMap()
+      )
+      ReferenceDefinition(javaProtoField.messageType.name)
+    }
+    null -> NullableDefinition()
+  }
+}
+
+fun checkTypeCache(
+  javaProtoField: Descriptors.FieldDescriptor,
+  cache: MutableMap<String, JsonSchema>
+): JsonSchema? =
+  when (javaProtoField.javaType) {
+    Descriptors.FieldDescriptor.JavaType.ENUM -> cache[javaProtoField.enumType.name]
+    Descriptors.FieldDescriptor.JavaType.MESSAGE -> cache[javaProtoField.messageType.name]
+    else -> null
+  }

protobuf-java-converter/src/test/java/io/bkbn/kompendium/protobufjavaconverter/Corpus.java

@@ -0,0 +1,167 @@
+// Generated by the protocol buffer compiler.  DO NOT EDIT!
+// source: io/bkbn/kompendium/protobufjavaconverter/converters/test.proto
+
+package io.bkbn.kompendium.protobufjavaconverter;
+
+/**
+ * Protobuf enum {@code io.bkbn.kompendium.protobufjavaconverter.Corpus}
+ */
+public enum Corpus
+    implements com.google.protobuf.ProtocolMessageEnum {
+  /**
+   * <code>CORPUS_UNSPECIFIED = 0;</code>
+   */
+  CORPUS_UNSPECIFIED(0),
+  /**
+   * <code>CORPUS_UNIVERSAL = 1;</code>
+   */
+  CORPUS_UNIVERSAL(1),
+  /**
+   * <code>CORPUS_WEB = 2;</code>
+   */
+  CORPUS_WEB(2),
+  /**
+   * <code>CORPUS_IMAGES = 3;</code>
+   */
+  CORPUS_IMAGES(3),
+  /**
+   * <code>CORPUS_LOCAL = 4;</code>
+   */
+  CORPUS_LOCAL(4),
+  /**
+   * <code>CORPUS_NEWS = 5;</code>
+   */
+  CORPUS_NEWS(5),
+  /**
+   * <code>CORPUS_PRODUCTS = 6;</code>
+   */
+  CORPUS_PRODUCTS(6),
+  /**
+   * <code>CORPUS_VIDEO = 7;</code>
+   */
+  CORPUS_VIDEO(7),
+  UNRECOGNIZED(-1),
+  ;
+
+  /**
+   * <code>CORPUS_UNSPECIFIED = 0;</code>
+   */
+  public static final int CORPUS_UNSPECIFIED_VALUE = 0;
+  /**
+   * <code>CORPUS_UNIVERSAL = 1;</code>
+   */
+  public static final int CORPUS_UNIVERSAL_VALUE = 1;
+  /**
+   * <code>CORPUS_WEB = 2;</code>
+   */
+  public static final int CORPUS_WEB_VALUE = 2;
+  /**
+   * <code>CORPUS_IMAGES = 3;</code>
+   */
+  public static final int CORPUS_IMAGES_VALUE = 3;
+  /**
+   * <code>CORPUS_LOCAL = 4;</code>
+   */
+  public static final int CORPUS_LOCAL_VALUE = 4;
+  /**
+   * <code>CORPUS_NEWS = 5;</code>
+   */
+  public static final int CORPUS_NEWS_VALUE = 5;
+  /**
+   * <code>CORPUS_PRODUCTS = 6;</code>
+   */
+  public static final int CORPUS_PRODUCTS_VALUE = 6;
+  /**
+   * <code>CORPUS_VIDEO = 7;</code>
+   */
+  public static final int CORPUS_VIDEO_VALUE = 7;
+
+
+  public final int getNumber() {
+    if (this == UNRECOGNIZED) {
+      throw new java.lang.IllegalArgumentException(
+          "Can't get the number of an unknown enum value.");
+    }
+    return value;
+  }
+
+  /**
+   * @param value The numeric wire value of the corresponding enum entry.
+   * @return The enum associated with the given numeric wire value.
+   * @deprecated Use {@link #forNumber(int)} instead.
+   */
+  @java.lang.Deprecated
+  public static Corpus valueOf(int value) {
+    return forNumber(value);
+  }
+
+  /**
+   * @param value The numeric wire value of the corresponding enum entry.
+   * @return The enum associated with the given numeric wire value.
+   */
+  public static Corpus forNumber(int value) {
+    switch (value) {
+      case 0: return CORPUS_UNSPECIFIED;
+      case 1: return CORPUS_UNIVERSAL;
+      case 2: return CORPUS_WEB;
+      case 3: return CORPUS_IMAGES;
+      case 4: return CORPUS_LOCAL;
+      case 5: return CORPUS_NEWS;
+      case 6: return CORPUS_PRODUCTS;
+      case 7: return CORPUS_VIDEO;
+      default: return null;
+    }
+  }
+
+  public static com.google.protobuf.Internal.EnumLiteMap<Corpus>
+      internalGetValueMap() {
+    return internalValueMap;
+  }
+  private static final com.google.protobuf.Internal.EnumLiteMap<
+      Corpus> internalValueMap =
+        new com.google.protobuf.Internal.EnumLiteMap<Corpus>() {
+          public Corpus findValueByNumber(int number) {
+            return Corpus.forNumber(number);
+          }
+        };
+
+  public final com.google.protobuf.Descriptors.EnumValueDescriptor
+      getValueDescriptor() {
+    if (this == UNRECOGNIZED) {
+      throw new java.lang.IllegalStateException(
+          "Can't get the descriptor of an unrecognized enum value.");
+    }
+    return getDescriptor().getValues().get(ordinal());
+  }
+  public final com.google.protobuf.Descriptors.EnumDescriptor
+      getDescriptorForType() {
+    return getDescriptor();
+  }
+  public static final com.google.protobuf.Descriptors.EnumDescriptor
+      getDescriptor() {
+    return io.bkbn.kompendium.protobufjavaconverter.Test.getDescriptor().getEnumTypes().get(0);
+  }
+
+  private static final Corpus[] VALUES = values();
+
+  public static Corpus valueOf(
+      com.google.protobuf.Descriptors.EnumValueDescriptor desc) {
+    if (desc.getType() != getDescriptor()) {
+      throw new java.lang.IllegalArgumentException(
+        "EnumValueDescriptor is not for this type.");
+    }
+    if (desc.getIndex() == -1) {
+      return UNRECOGNIZED;
+    }
+    return VALUES[desc.getIndex()];
+  }
+
+  private final int value;
+
+  private Corpus(int value) {
+    this.value = value;
+  }
+
+  // @@protoc_insertion_point(enum_scope:io.bkbn.kompendium.protobufjavaconverter.Corpus)
+}
+